ASP.NET Core - 實作自定義WebApi模型驗證

ASP.NET Core - 實作自定義WebApi模型驗證

　　Framework時代　　

　　在Framework時代，我們一般進行參數驗證的時候，以下代碼是非常常見的

複制代碼

[HttpPost]
    public async Task<JsonResult> SaveNewCustomerAsnyc(AddCustomerInput input)
    {
        if (!ModelState.IsValid)
        {
            return Json(Result.FromCode(ResultCode.InvalidParams));
        }

       .....
    }           

　　或者進階一點是實作IActionFilter進行攔截，如下：　　

　　public class ApiValidationFilter : IActionFilter

{
    public bool AllowMultiple => false;

    public async Task<HttpResponseMessage> ExecuteActionFilterAsync(HttpActionContext actionContext, CancellationToken cancellationToken, Func<Task<HttpResponseMessage>> continuation)
    {
        var method = actionContext.ActionDescriptor.GetMethodInfoOrNull();
        if (method == null)
        {
            return await continuation();
        }           

        if (!actionContext.ModelState.IsValid)
        {
            var error = actionContext.ModelState.GetValidationSummary();
            var result = Result.FromError($"參數驗證不通過：{error}", ResultCode.InvalidParams);
            return actionContext.Request.CreateResponse(result);
        }

        return await continuation();
    }           

}

　public static class ModelStateExtensions

{
    /// <summary>
    /// 擷取驗證消息提示并格式化提示
    /// </summary>
    public static string GetValidationSummary(this ModelStateDictionary modelState, string separator = "\r\n")
    {
        if (modelState.IsValid) return null;

        var error = new StringBuilder();

        foreach (var item in modelState)
        {
            var state = item.Value;
            var message = state.Errors.FirstOrDefault(p => !string.IsNullOrWhiteSpace(p.ErrorMessage))?.ErrorMessage;
            if (string.IsNullOrWhiteSpace(message))
            {
                message = state.Errors.FirstOrDefault(o => o.Exception != null)?.Exception.Message;
            }
            if (string.IsNullOrWhiteSpace(message)) continue;

            if (error.Length > 0)
            {
                error.Append(separator);
            }

            error.Append(message);
        }

        return error.ToString();
    }
}　           

　　然後在啟動項把這個攔截注冊進來使用即可　

　　.Net Core時代　　

　　自動模型狀态驗證

　　在.Net Core的時代中，架構會幫你自動驗證model的state，也就是ModelState。架構會為你自動注冊ModelStateInvalidFilter，這個會運作在OnActionExecuting事件裡面。

　　基于現有架構的代碼編寫的話，是以我們不再需要在業務中耦合這樣的模型判斷代碼，系統内部會檢查ModelState是否為Valid，如果為InValid會直接傳回400 BadRequest，這樣就沒有必要執行後面的代碼，提高效率。是以，操作方法中不再需要以下代碼：　

if (!ModelState.IsValid)

{

return BadRequest(ModelState);           

　　問題引入　　

　　在我們的真實開發中，當我們碰到參數驗證沒通過400錯誤時，我們希望的是背景傳回一個可了解的Json結果傳回，而不是直接在頁面傳回400錯誤。是以我們需要替換掉預設的BadRequest響應結果，把結果換成我們想要的Json結果傳回。

　　自定義 BadRequest 響應

　　我們如何改變 ASP.NET Core WEB API 模型驗證的預設行為呢？具體的做法是在通過Startup的ConfigureServices方法配置ApiBehaviorOptions來實作，先來看一下這個類。　

　　public class ApiBehaviorOptions

{
    public Func<ActionContext, IActionResult> InvalidModelStateResponseFactory { get; set; }

    public bool SuppressModelStateInvalidFilter { get; set; }

    public bool SuppressInferBindingSourcesForParameters { get; set; }

    public bool SuppressConsumesConstraintForFormFileParameters { get; set; }
}           

　　所有bool類型的屬性預設都是false。

　　方案一

　　當 SuppressModelStateInvalidFilter 屬性設定為 true 時，會禁用預設行為　　

　　public void ConfigureServices(IServiceCollection services)

{           
        services
              .AddMvc()
            .AddXmlSerializerFormatters() //設定支援XML格式輸入輸出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

        //禁用預設行為
        services.Configure<ApiBehaviorOptions>(options =>
        {
            options.SuppressModelStateInvalidFilter = true;
        });
    }           

　　當我們禁用完之後，需要我們自定義的傳回結果了，我們使用上面的定義的ApiValidationFilter進行攔截和傳回。需要在ConfigureServices方法裡面把這個攔截器注冊進來

public void ConfigureServices(IServiceCollection services)
    {
        .....
        services
              .AddMvc(options =>
              {
                  options.Filters.Add<ApiValidationFilter>();
              })
            .AddXmlSerializerFormatters() //設定支援XML格式輸入輸出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    }           

　　方案二　　

　　這也是官網的推薦的做法是，若要自定義驗證錯誤引發的響應，請使用InvalidModelStateResponseFactory。這個InvalidModelStateResponseFactory是一個參數為ActionContext，傳回值為IActionResult的委托，具體實作如下：　　

public void ConfigureServices(IServiceCollection services)
    {           
        services
              .AddMvc()
            .AddXmlSerializerFormatters() //設定支援XML格式輸入輸出
            .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

        //參數驗證
        services.Configure<ApiBehaviorOptions>(options =>
        {
            options.InvalidModelStateResponseFactory = (context) =>
            {
                var error = context.ModelState.GetValidationSummary();
                
                return new JsonResult(Result.FromError($"參數驗證不通過：{error.ToString()}", ResultCode.InvalidParams));
            };
        });
    }           

　　上面的代碼是覆寫ModelState管理的預設行為（ApiBehaviorOptions），當資料模型驗證失敗時，程式會執行這段代碼。沒通過驗證的ModelState，把它抛出的錯誤資訊通過格式化利用JsonResult傳回給用戶端。

　　總結

　　我們在實際應用過程中，針對WebApi的開發基本上對于所有的請求都是要傳回自定義結果的，是以我們需要覆寫預設的覆寫預設的模型認證行為，上面給出了兩種方案：

　　第一種方案：符合Framework時代的風格，需要額外在指定覆寫原有的模型驗證（SuppressModelStateInvalidFilter = true）

　　第二種方案：官方建議做法，符合Core時代的風格，隻需複寫InvalidModelStateResponseFactory委托即可，個人也推薦第二種方案。

　　如果你有更好的想法，歡迎給我留言交流。

原文位址

https://www.cnblogs.com/lex-wu/p/11265458.html