Asp.Net Core (.Net Framework)設置統一處理WebAPI返回值、異常

/// <summary>
    /// Api action統一處理過濾器  
    /// 處理正常返回值
    /// </summary>
    public class ApiResultFilterAttribute : Attribute, IActionFilter
    {
        /// <summary>
        /// 執行方法體之后
        /// 返回結果為JsonResult的請求進行Result包裝
        /// </summary>
        /// <param name="context"></param>
        public void OnActionExecuted(ActionExecutedContext context)
        {
            //特殊處理：對有ApiIgnoreAttribute標簽的，不進行返回結果包裝，原樣輸出
            var controllerActionDescriptor = context.ActionDescriptor as ControllerActionDescriptor;
            if (controllerActionDescriptor != null)
            {
                var isDefined = controllerActionDescriptor.EndpointMetadata.Any(a => a.GetType().Equals(typeof(ApiIgnoreAttribute)));
                if (isDefined)
                {
                    return;
                }

            }
            // 返回結果為JsonResult的請求進行Result包裝
            if (context.Result != null)
            {
                if (context.Result is ObjectResult)
                {
                    var result = context.Result as ObjectResult;
                    context.Result = new JsonResult(new {code=200,msg= "success",data= result.Value });

                } 
                else if (context.Result is EmptyResult)
                {
                    context.Result = new JsonResult(new { code = 200, msg = "success", data = new { } });
                }
                else if (context.Result is ContentResult)
                {
                    var result = context.Result as ContentResult;
                    context.Result = new JsonResult(new { code = result.StatusCode, msg = result.Content });
                }
                else
                {
                    throw new Exception($"未經處理的Result類型：{ context.Result.GetType().Name}");
                }

            }
            
         }

        /// <summary>
        /// 執行方法體之前
        /// </summary>
        /// <param name="context"></param>
        public void OnActionExecuting(ActionExecutingContext context)
        {
            //不做修改
        }
              
    }

/// <summary>
    /// api異常統一處理過濾器
    /// 系統級別異常 500 應用級別異常501
    /// </summary>
    public class ApiExceptionFilterAttribute : ExceptionFilterAttribute
    {
        public override void OnException(ExceptionContext context)
        {
            context.Result = BuildExceptionResult(context.Exception);
            base.OnException(context);
        }

        /// <summary>
        /// 包裝處理異常格式
        /// </summary>
        /// <param name="ex"></param>
        /// <returns></returns>
        private JsonResult BuildExceptionResult(Exception ex)
        {
            int code = 0;
            string message = "";
            string innerMessage = "";
            //應用程序業務級異常
            if (ex is ApplicationException)
            {
                code = 501;
                message = ex.Message;
            }
            else
            {
                // exception 系統級別異常，不直接明文顯示的
                code = 500;
                message = "發生系統級別異常";
                innerMessage = ex.Message;
            }

            if (ex.InnerException != null && ex.Message != ex.InnerException.Message)
                innerMessage += "," + ex.InnerException.Message;

            return new JsonResult(new { code, message, innerMessage });
        }
    }

/// <summary>
    /// 使用該標簽，對結果原樣輸出，不做包裝
    /// </summary>
    public class ApiIgnoreAttribute : Attribute
    {
    }

/// <summary>
/// 測試 返回過濾器
/// </summary>
/// <returns></returns>
[ApiExceptionFilter]
[ApiResultFilter]
[HttpGet]
public IActionResult TestReuslt()
{
    throw new Exception("AA");
    var obj = new
    {
        A = "321"
    };
    return Json(obj);
}

//也可以使用全局配置的方法
//注冊過濾器
services.AddSingleton<ApiResultFilter>();
services.AddSingleton<ErrorFilter>();
services.AddMvc(
    config => {
        config.Filters.AddService(typeof(ApiResultFilter));
        config.Filters.AddService(typeof(ErrorFilter));
    })
.SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
//注意：
//打上的標簽無法獲取IOC容器
//不要使用全局配置與標簽一起使用 會造成多次調用

備注：

ExceptionFilterAttribute（這個繼承了標簽接口Attribute和異常控制器接口IExceptionFilter）

ActionFilterAttribute（這個繼承了標簽接口Attribute 和 返回結果處理控制器接口IActionFilter）

后端寫webapi的時候必然需要和前端約定請求值和返回值的格式，如果有異常返回應該如何識別和區分；

通過actionfilter即可實現切入處理，而不需要在每個方法中處理。

 

---

 

.Net Framework 

　　.Net Framework添加時標簽編碼和 .Net Core 一樣。標簽使用方式也是一樣。

　　但是在切入處理時，.Net Core 是在Startup.ConfigureServices中，而.Net Framework是在WebApiConfig.Register中。

　　直接添加如下代碼：

 　　　　config.Filters.AddService(typeof(ApiResultFilter)); config.Filters.AddService(typeof(ErrorFilter));