Sử dụng action filter để validate model trong asp.net core

Thông thường trong asp.net core/mvc ta hay sử dụng các attribute để check điều kiện validate cho model, ví dụ như

public class User
{ 
    [Required]
    [StringLength(250)]
    public string DisplayName { get; set; }
    
    [Required]
    public string Email { get; set; }
    
    public string Phone { get; set; } 
    
    public string Password { get; set; }
}

public class User

{

[Required]

[StringLength(250)]

public string DisplayName { get; set; }

[Required]

public string Email { get; set; }

public string Phone { get; set; }

public string Password { get; set; }

}

Trong action method kiểm tra model hợp lệ hay không bằng cách sử dụng ModelState

[HttpPut]
[Route("update")]
public async Task<IActionResult> Update([FromBody]User model)
{
    if (!ModelState.IsValid)
    {
        throw new Exception("Dữ liệu đầu vào không hợp lệ");
    }

    // your code here...
}

[HttpPut]

[Route("update")]

public async Task<IActionResult> Update([FromBody]User model)

{

if (!ModelState.IsValid)

{

throw new Exception("Dữ liệu đầu vào không hợp lệ");

}

// your code here...

}

Cách này hoạt động tốt tuy nhiên hơi nông dân vì phải check điều kiện ở nhiều Action method, nhiều controller khác nhau. Dẫn đến code bị lặp lại nhiều lần, trông không đẹp & khó bảo trì. Để khắc phục tình trạng này thì bây giờ chúng ta sẽ sử dụng Action filter để validate như sau

Bước 1 : Tạo 1 class cho action filter, dùng để validate

 public class ValidationActionFilter : IActionFilter
{
    /// <inheritdoc />
    public void OnActionExecuting(ActionExecutingContext filterContext)
    {
        if (!filterContext.ModelState.IsValid)
        {
            // trả về một json
            filterContext.Result = new JsonResult(new
            {
                success = false,
                message = "Dữ liệu đầu vào không hợp lệ"
            });

            // Bạn có thể trả về json như trên hoặc trả về 1 mã lỗi cụ thể, ví dụ BadRequest
            // filterContext.Result = new BadRequestObjectResult(filterContext.ModelState);
        }
    }

    /// <inheritdoc />
    public void OnActionExecuted(ActionExecutedContext filterContext)
    {

    }
}

public class ValidationActionFilter : IActionFilter

{

/// <inheritdoc />

public void OnActionExecuting(ActionExecutingContext filterContext)

{

if (!filterContext.ModelState.IsValid)

{

// trả về một json

filterContext.Result = new JsonResult(new

{

success = false,

message = "Dữ liệu đầu vào không hợp lệ"

});

// Bạn có thể trả về json như trên hoặc trả về 1 mã lỗi cụ thể, ví dụ BadRequest

// filterContext.Result = new BadRequestObjectResult(filterContext.ModelState);

}

/// <inheritdoc />

public void OnActionExecuted(ActionExecutedContext filterContext)

{

}

Trong ActionFilter, nếu bạn muốn lấy các setting trong file config thì có thể sử dụng câu lệnh sau để lấy ra biến Configuration (tương tự biến Configuration trong startup.cs)

var Configuration = filterContext.HttpContext.RequestServices.GetRequiredService<IConfiguration>();

1	var Configuration = filterContext.HttpContext.RequestServices.GetRequiredService<IConfiguration>();

Bước 2: Cách sử dụng

Nếu muốn áp dụng filter này cho tất cả các controller, bạn hãy khai báo trong file startup.cs như sau

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(opt =>
    {
        opt.Filters.Add(typeof(ValidationActionFilter));
    });
}

public void ConfigureServices(IServiceCollection services)

{

services.AddMvc(opt =>

{

opt.Filters.Add(typeof(ValidationActionFilter));

});

}

Nếu muốn áp dụng cho một số controller cụ thể thì tại bước 1, bạn hãy kế thừa thêm từ class Attribute sau đó khai báo attribute cho controller mà bạn muốn áp dụng. ví dụ như

[ValidationActionFilter]
public class HomeController : Controller
{
//
}

[ValidationActionFilter]

public class HomeController : Controller

{

}

Tham khảo https://www.carlrippon.com/fluentvalidation-in-an-asp-net-core-web-api/

Random post