欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

.NetCore?Web?Api?利用ActionFilterAttribute統(tǒng)一接口返回值格式及問(wèn)題解析

 更新時(shí)間:2022年03月10日 14:12:47   作者:Я!ńɡ  
在實(shí)際項(xiàng)目開(kāi)發(fā)過(guò)程中,統(tǒng)一API返回值格式對(duì)前端或第三方調(diào)用將是非常必要的,在.NetCore中我們可以通過(guò)ActionFilterAttribute來(lái)進(jìn)行統(tǒng)一返回值的封裝,對(duì).NetCore?Web?Api?統(tǒng)一接口返回值格式相關(guān)知識(shí)感興趣的朋友一起看看吧

.Net Core 同 Asp.Net MVC一樣有幾種過(guò)濾器,這里不再贅述每個(gè)過(guò)濾器的執(zhí)行順序與作用。

在實(shí)際項(xiàng)目開(kāi)發(fā)過(guò)程中,統(tǒng)一API返回值格式對(duì)前端或第三方調(diào)用將是非常必要的,在.NetCore中我們可以通過(guò)ActionFilterAttribute來(lái)進(jìn)行統(tǒng)一返回值的封裝。

在封裝之前我們需要考慮下面幾個(gè)問(wèn)題:

1,需要對(duì)哪些結(jié)果進(jìn)行封裝

我目前的做法是,只對(duì)ObjectResult進(jìn)行封裝,其他的類型:FileResult,ContentResult,EmptyResult,RedirectResult不予處理

2,對(duì)異常錯(cuò)誤的封裝

既然是統(tǒng)一返回值,當(dāng)然也要考慮接口異常的問(wèn)題了

但是不是所有的異常我們都需要返回給前端的,我們可能需要自定義一個(gè)業(yè)務(wù)異常,業(yè)務(wù)異??梢栽谇岸诉M(jìn)行友好提示,系統(tǒng)異常完全沒(méi)必要拋出給前端或第三方,且需要對(duì)系統(tǒng)異常進(jìn)行日志記錄

項(xiàng)目結(jié)構(gòu):

Exceptions:自定義業(yè)務(wù)異常

Filters:自定義過(guò)濾器(統(tǒng)一結(jié)果封裝,全局異常)

Models:統(tǒng)一結(jié)果實(shí)體

部分代碼:

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)碼,前端通過(guò)捕獲500狀態(tài)碼進(jìn)行友好提示
            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 =>
            {
                //添加過(guò)濾器
                ops.Filters.Add(new Filters.CommonResultFilterAttribute());
                //GlobalExceptionFilterAttribute構(gòu)造中注入其他服務(wù),需要通過(guò)ServiceFilter添加
                ops.Filters.Add(new Microsoft.AspNetCore.Mvc.ServiceFilterAttribute(typeof(Filters.GlobalExceptionFilterAttribute)));
            });
            //注冊(cè)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();
    }
}

最后新建一個(gè)Controller然后寫(xiě)上幾個(gè)不同返回值的的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錯(cuò)誤
        [HttpGet("exception")]
        public ActionResult GetException() => throw new InvalidOperationException("invalid");
        /// 自定義異常,返回200
        [HttpGet("bizException")]
        public ActionResult GetBizException() => throw new Exceptions.BizException("bizException");
    }
}

下面是返回結(jié)果截圖:

上圖:訪問(wèn)/api/home和/api/home/redirect的結(jié)果

上圖:Action返回?cái)?shù)字的結(jié)果

上圖:返回string集合的結(jié)果

上圖:輸出文本文件的結(jié)果

上圖:返回ContentResult的結(jié)果

上圖:系統(tǒng)異常的結(jié)果,輸出狀態(tài)碼為500

上圖:拋出業(yè)務(wù)異常的結(jié)果,輸出狀態(tài)碼200

不知道如何上傳ZIP包,實(shí)例代碼項(xiàng)目已經(jīng)放到Gitee上了,后面有時(shí)間也會(huì)寫(xiě)點(diǎn)簡(jiǎn)單的例子
地址: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)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

最新評(píng)論