运维开发网

ActionFilterAttribute统一接口返回值格式及问题分析

运维开发网 https://www.qedev.com 2022-07-21 22:08 出处:网络
在实际项目开发过程中,统一API返回值格式对前端或第三方调用将是非常必要的,在.NetCore中我们可以通过ActionFilterAttribute来进行统一返回值的封装,对.NetCore?Web

在实际项目开发过程中,统一API返回值格式对前端或第三方调用将是非常必要的,在.NetCore中我们可以通过ActionFilterAttribute来进行统一返回值的封装,对.NetCore?Web

就像Asp中的MVC一样。网,。Net Core有几个过滤器,这里就不描述每个过滤器的执行顺序和作用了。

在实际的项目开发过程中,将需要统一前端或第三方调用的API返回值格式。英寸NetCore,我们可以通过ActionFilterAttribute封装统一的返回值。

在打包之前,我们需要考虑以下问题:

1,需要对哪些结果进行封装

目前我的做法是只封装ObjectResult,其他类型:fileresult、contentresult、emptyresult、redirectresult都不会处理。

2,对异常错误的封装

既然是统一返回值,当然也要考虑接口异常的问题。

但是并不是所有的异常都需要返回到前端。我们可能需要定制一个业务异常,可以在前端提示。完全没有必要把系统异常丢给前端或者第三方,并记录系统异常。

项目结构:


例外:自定义业务例外

过滤器:自定义过滤器(统一结果封装,全局异常)

模型:统一结果实体

代码的一部分:

using System; namespace NetCoreCommonResult.Exceptions{ /// lt;summarygt; /// 自定义业务异常,可以由前端抛出友好的提示 /// lt;/summarygt; 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 ILoggerlt;GlobalExceptionFilterAttributegt; _logger; public GlobalExceptionFilterAttribute(ILoggerlt;GlobalExceptionFilterAttributegt; 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 }); //非业务异常记录errorLog,返回500状态码,前端通过捕获500状态码进行友好提示 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 =gt; { //添加过滤器 ops.Filters.Add(new Filters.CommonResultFilterAttribute()); //GlobalExceptionFilterAttribute构造中注入其他服务,需要通过ServiceFilter添加 ops.Filters.Add(new Microsoft.AspNetCore.Mvc.ServiceFilterAttribute(typeof(Filters.GlobalExceptionFilterAttribute))); }); //注册GlobalExceptionFilterAttribute services.AddScopedlt;Filters.GlobalExceptionFilterAttributegt;(); // 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 =gt; endpoints.MapControllers(); }}

最后,创建一个新控制器,并用不同的返回值编写几个动作。

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 { /// lt;summarygt; /// string /// lt;/summarygt; /// lt;returnsgt;lt;/returnsgt; [HttpGet] public string Index() =gt; "Welecome to .NetCore"; /// 跳转,不处理 [HttpGet("redirect")] public ActionResult Redirect() =gt; RedirectToAction("Index"); /// [HttpGet("num")] public int Num() =gt; 10; /// 异步 [HttpGet("async")] public Tasklt;IEnumerablelt;stringgt;gt; TaskString() =gt;Task.FromResultlt;IEnumerablelt;stringgt;gt;(new[] { "A","B","C"}); /// 文件输出,不处理 [HttpGet("file")] public ActionResult GetFile() =gt; File(Encoding.UTF8.GetBytes("File String"), "text/plain"); /// 空返回值,不处理 [HttpGet("empty")] public ActionResult Empty() =gt; Empty(); /// contentResult 不处理 [HttpGet("content")] public ActionResult Content() =gt; Content("this is content"); /// 异常,返回500错误 [HttpGet("exception")] public ActionResult GetException() =gt; throw new InvalidOperationException("invalid"); /// 自定义异常,返回200 [HttpGet("bizException")] public ActionResult GetBizException() =gt; throw new Exceptions.BizException("bizException"); }}

以下是返回结果的截图:


上图:访问/api/home和/api/home/redirect的结果


上图:动作返回数字的结果。


上图:返回字符串收集的结果。


上图:输出一个文本文件的结果。


上图:返回ContentResult的结果。


上图:系统异常的结果,输出状态码为500。


上图:抛出业务异常结果,输出状态码200。

不知道怎么上传ZIP包。示例代码项目已放在Gitee上。以后有时间我会写一些简单的例子
地址:https://gitee.com/tang3402/net-core-samples.git

这就是这篇文章的内容。netcorewebpi对ActionFilterAttribute统一接口返回值格式的使用。有关的更多信息。netcorewebpi统一接口返回值格式

0

精彩评论

暂无评论...
验证码 换一张
取 消