2020/02/01, ASP.NET Core 3.1, VS2019
摘要：基于ASP.NET Core 3.1 WebApi搭建后端多层网站架构【11-WebApi统一处理返回值、异常】
使用IExceptionFilter过滤器实现异常统一处理，使用IResultFilter过滤器实现统一处理返回值
文章目录
此分支项目代码
本章节介绍了使用IExceptionFilter实现异常统一处理，使用IResultFilter实现统一处理返回值
添加异常过滤器
在MS.WebApi应用程序中新建Filters文件夹，在该文件夹下新建ApiExceptionFilter.cs类：
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.Extensions.Logging;
using MS.Component.Aop;
namespace MS.WebApi.Filters
{
/// <summary>
/// api异常过滤器
/// </summary>
public class ApiExceptionFilter : IExceptionFilter
{
private readonly ILogger<ApiExceptionFilter> _logger;
public ApiExceptionFilter(ILogger<ApiExceptionFilter> logger)
{
_logger = logger;
}
public void OnException(ExceptionContext context)
{
string methodInfo = $"{context.RouteData.Values["controller"] as string}Controller.{context.RouteData.Values["action"] as string}:{context.HttpContext.Request.Method}";
//如果不是AopHandledException异常，则可能没有记录过日志，进行日志记录
if (!(context.Exception is AopHandledException))
{
_logger.LogError(context.Exception, "执行{0}时发生错误！", methodInfo);
}
context.Result = new JsonResult(new
{
status = 501,
data = "服务器出错"
});
}
}
}
如果controller在执行过程中遇到错误，则会被过滤器捕获到，如果错误已经被LogAop（之前写的业务层的）处理过，那在ApiExceptionFilter中判断下就不处理了，最后统一返回501，提示服务器出错
添加结果过滤器
在Filters文件夹下新建ApiResultFilter.cs类：
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System;
namespace MS.WebApi.Filters
{
/// <summary>
/// 给api返回结果包一层状态码
/// </summary>
public class ApiResultFilter : IResultFilter
{
public void OnResultExecuting(ResultExecutingContext context)
{
if (context.Result != null)
{
if (context.Result is ObjectResult objectResult)
{
if (objectResult.DeclaredType is null) //返回的是IActionResult类型
{
context.Result = new JsonResult(new
{
status = objectResult.StatusCode,
data = objectResult.Value
});
}
else//返回的是string、List这种其他类型，此时没有statusCode，应尽量使用IActionResult类型
{
context.Result = new JsonResult(new
{
status = 200,
data = objectResult.Value
});
}
}
else if (context.Result is EmptyResult)
{
context.Result = new JsonResult(new
{
status = 200,
data = ""
});
}
else
{
throw new Exception($"未经处理的Result类型：{ context.Result.GetType().Name}");
}
}
}
public void OnResultExecuted(ResultExecutedContext context)
{
}
}
}
就是对返回值又包了一层，status是状态码，data是数据
应用过滤器
Startup.cs类中，给AddControllers方法添加参数：
services.AddControllers(options =>
{
options.Filters.Add<ApiResultFilter>();
options.Filters.Add<ApiExceptionFilter>();
});
将services.AddControllers();改成以上内容：
这样做是全局应用，所有的controller都会应用上面两个过滤器
如果只想部分应用，可以考虑使用Attribute类型的过滤器，请查阅官方文档-筛选器章节
至此，过滤器已应用成功，启动项目，打开Postman调用接口：
可以看到返回值已经包了一层
项目完成后，如下图所示
