.NetCore?Web?Api?利用ActionFilterAttribute統(tǒng)一接口返回值格式及問題解析
.Net Core 同 Asp.Net MVC一樣有幾種過濾器,這里不再贅述每個過濾器的執(zhí)行順序與作用。
在實際項目開發(fā)過程中,統(tǒng)一API返回值格式對前端或第三方調(diào)用將是非常必要的,在.NetCore中我們可以通過ActionFilterAttribute來進行統(tǒng)一返回值的封裝。
在封裝之前我們需要考慮下面幾個問題:
1,需要對哪些結(jié)果進行封裝
我目前的做法是,只對ObjectResult進行封裝,其他的類型:FileResult,ContentResult,EmptyResult,RedirectResult不予處理
2,對異常錯誤的封裝
既然是統(tǒng)一返回值,當(dāng)然也要考慮接口異常的問題了
但是不是所有的異常我們都需要返回給前端的,我們可能需要自定義一個業(yè)務(wù)異常,業(yè)務(wù)異常可以在前端進行友好提示,系統(tǒng)異常完全沒必要拋出給前端或第三方,且需要對系統(tǒng)異常進行日志記錄
項目結(jié)構(gòu):
Exceptions:自定義業(yè)務(wù)異常
Filters:自定義過濾器(統(tǒng)一結(jié)果封裝,全局異常)
Models:統(tǒng)一結(jié)果實體
部分代碼:
using System; namespace NetCoreCommonResult.Exceptions { /// <summary> /// 自定義業(yè)務(wù)異常,可以由前端拋出友好的提示 /// </summary> public class BizException:Exception { public BizException() { } public BizException(string message):base(message) public BizException(string message, Exception ex) : base(message, ex) } }
using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.Filters; namespace NetCoreCommonResult.Filters { public class CommonResultFilterAttribute : ActionFilterAttribute { public override void OnResultExecuting(ResultExecutingContext context) { if (context.Result is ObjectResult objRst) { if (objRst.Value is Models.ApiResult) return; context.Result = new ObjectResult(new Models.ApiResult { Success = true, Message = string.Empty, Data = objRst.Value }); } } } }
using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.Extensions.Logging; namespace NetCoreCommonResult.Filters { public class GlobalExceptionFilterAttribute : ExceptionFilterAttribute { private readonly ILogger<GlobalExceptionFilterAttribute> _logger; public GlobalExceptionFilterAttribute(ILogger<GlobalExceptionFilterAttribute> logger) { _logger = logger; } public override void OnException(ExceptionContext context) { context.ExceptionHandled = true; var isBizExp = context.Exception is Exceptions.BizException; context.Result = new ObjectResult(new Models.ApiResult { Success = false, Message = context.Exception.Message }); //非業(yè)務(wù)異常記錄errorLog,返回500狀態(tài)碼,前端通過捕獲500狀態(tài)碼進行友好提示 if (isBizExp == false) { _logger.LogError(context.Exception, context.Exception.Message); context.HttpContext.Response.StatusCode = 500; } base.OnException(context); } } }
Startup.cs
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; namespace NetCoreCommonResult { public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) services.AddLogging(); services.AddControllers(ops => { //添加過濾器 ops.Filters.Add(new Filters.CommonResultFilterAttribute()); //GlobalExceptionFilterAttribute構(gòu)造中注入其他服務(wù),需要通過ServiceFilter添加 ops.Filters.Add(new Microsoft.AspNetCore.Mvc.ServiceFilterAttribute(typeof(Filters.GlobalExceptionFilterAttribute))); }); //注冊GlobalExceptionFilterAttribute services.AddScoped<Filters.GlobalExceptionFilterAttribute>(); // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) if (env.IsDevelopment()) app.UseDeveloperExceptionPage(); } else app.UseExceptionHandler("/Error"); app.UseStaticFiles(); app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => endpoints.MapControllers(); } }
最后新建一個Controller然后寫上幾個不同返回值的的Action
using Microsoft.AspNetCore.Mvc; using System; using System.Collections.Generic; using System.Text; using System.Threading.Tasks; namespace NetCoreCommonResult.Controllers { [Route("api/[controller]")] [ApiController] public class HomeController : ControllerBase { /// <summary> /// string /// </summary> /// <returns></returns> [HttpGet] public string Index() => "Welecome to .NetCore"; /// 跳轉(zhuǎn),不處理 [HttpGet("redirect")] public ActionResult Redirect() => RedirectToAction("Index"); /// [HttpGet("num")] public int Num() => 10; /// 異步 [HttpGet("async")] public Task<IEnumerable<string>> TaskString() =>Task.FromResult<IEnumerable<string>>(new[] { "A","B","C"}); /// 文件輸出,不處理 [HttpGet("file")] public ActionResult GetFile() => File(Encoding.UTF8.GetBytes("File String"), "text/plain"); /// 空返回值,不處理 [HttpGet("empty")] public ActionResult Empty() => Empty(); /// contentResult 不處理 [HttpGet("content")] public ActionResult Content() => Content("this is content"); /// 異常,返回500錯誤 [HttpGet("exception")] public ActionResult GetException() => throw new InvalidOperationException("invalid"); /// 自定義異常,返回200 [HttpGet("bizException")] public ActionResult GetBizException() => throw new Exceptions.BizException("bizException"); } }
下面是返回結(jié)果截圖:
上圖:訪問/api/home和/api/home/redirect的結(jié)果
上圖:Action返回數(shù)字的結(jié)果
上圖:返回string集合的結(jié)果
上圖:輸出文本文件的結(jié)果
上圖:返回ContentResult的結(jié)果
上圖:系統(tǒng)異常的結(jié)果,輸出狀態(tài)碼為500
上圖:拋出業(yè)務(wù)異常的結(jié)果,輸出狀態(tài)碼200
不知道如何上傳ZIP包,實例代碼項目已經(jīng)放到Gitee上了,后面有時間也會寫點簡單的例子
地址:https://gitee.com/tang3402/net-core-samples.git
到此這篇關(guān)于.NetCore Web Api 利用ActionFilterAttribute統(tǒng)一接口返回值格式的文章就介紹到這了,更多相關(guān).NetCore Web Api 統(tǒng)一接口返回值格式內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
VB.NET設(shè)置屏幕分辨率、顏色位數(shù)、刷新率 實例代碼
這篇文章介紹了VB.NET設(shè)置屏幕分辨率、顏色位數(shù)、刷新率 實例代碼,有需要的朋友可以參考一下2013-07-07Asp.Net Core實現(xiàn)Excel導(dǎo)出功能的實現(xiàn)方法
這篇文章主要給大家介紹了關(guān)于Asp.Net Core實現(xiàn)Excel導(dǎo)出功能的實現(xiàn)方法,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12.Net Web Api中利用FluentValidate進行參數(shù)驗證的方法
最近在做Web API,用到了流式驗證,就簡單的說說這個流式驗證,下面這篇文章主要給大家介紹了關(guān)于.Net Web Api中利用FluentValidate進行參數(shù)驗證的相關(guān)資料,,需要的朋友可以參考借鑒,下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-07-07ASP.NET下將Excel表格中的數(shù)據(jù)規(guī)則的導(dǎo)入數(shù)據(jù)庫思路分析及實現(xiàn)
今天接到新的需求,要求將Excel表格中的數(shù)據(jù)顯示在頁面上個人想法:首先是規(guī)則的Excel數(shù)據(jù)導(dǎo)入,再有就是不規(guī)則的Excel數(shù)據(jù)導(dǎo)入,還有就是根據(jù)數(shù)據(jù)生成Excel2013-01-01精彩回顧!Visual Studio 2017正式版發(fā)布全紀錄
兩個小時的Visual Studio 2017正式版發(fā)布紀錄內(nèi)容還是很豐富的,這篇文章就為大家回顧了Visual Studio 2017正式版發(fā)布全過程,感興趣的小伙伴們可以參考一下2017-03-03使用ASP.NET 2.0 CSS 控件適配器生成CSS友好的HTML輸出
使用ASP.NET 2.0 CSS 控件適配器生成CSS友好的HTML輸出...2007-03-03ASP.NET Core MVC學(xué)習(xí)教程之路由(Routing)
這篇文章主要給大家介紹了關(guān)于ASP.NET Core MVC學(xué)習(xí)教程之路由(Routing)的相關(guān)資料,文中通過示例代碼介紹的非常詳細,對大家學(xué)習(xí)或者使用ASP.NET Core MVC具有一定的參考學(xué)習(xí)價值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07