使用.NET 6开发TodoList应用(8)——实现全局异常处理

系列导航

• 使用.NET 6开发TodoList应用文章索引

需求

因为在项目中，会有各种各样的领域异常或系统异常被抛出来，那么在Controller里就需要进行完整的try-catch捕获，并根据是否有异常抛出重新包装返回值。这是一项机械且繁琐的工作。有没有办法让框架自己去做这件事呢？

有的，解决方案的名称叫做全局异常处理，或者叫做如何让接口优雅地失败。

目标

我们希望将异常处理和消息返回放到框架中进行统一处理，摆脱Controller层的try-catch块。

原理和思路

一般而言用来实现全局异常处理的思路有两种，但是出发点都是通过.NET Web API的管道中间件Middleware Pipeline实现的。第一种方式是通过.NET内建的中间件来实现；第二种是完全自定义中间件实现。

我们会简单地介绍一下如何通过内建中间件实现，然后实际使用第二种方式来实现我们的代码，大家可以比较一下异同。

在Api项目中创建Models文件夹并创建ErrorResponse类。

• ErrorResponse.cs

using System.Net;using System.Text.Json;namespace TodoList.Api.Models;public class ErrorResponse{public HttpStatusCode StatusCode { get; set; } = HttpStatusCode.IntealServerError;public string Message { get; set; } = "An unexpected error occurred.";public string ToJsonString() => JsonSerializer.Serialize(this);}

创建Extensions文件夹并新建一个静态类ExceptionMiddlewareExtensions实现一个静态扩展方法:

• ExceptionMiddlewareExtensions.cs

using System.Net;using Microsoft.AspNetCore.Diagnostics;using TodoList.Api.Models;namespace TodoList.Api.Extensions;public static class ExceptionMiddlewareExtensions{public static void UseGlobalExceptionHandler(this WebApplication app){app.UseExceptionHandler(appError =>{appError.Run(async context =>{context.Response.ContentType = "application/json";var errorFeature = context.Features.Get<IExceptionHandlerFeature>();if (errorFeature != null){await context.Response.WriteAsync(new ErrorResponse{StatusCode = (HttpStatusCode)context.Response.StatusCode,Message = errorFeature.Error.Message}.ToJsonString());}});});}}

在中间件配置的最开始配置好，注意中间件管道是有顺序的，把全局异常处理放到第一步（同时也是请求返回的最后一步）能确保它能拦截到所有可能发生的异常。即这个位置：

var app = builder.Build();app.UseGlobalExceptionHandler();

就可以实现全局异常处理了。接下来我们看如何完全自定义一个全局异常处理的中间件，其实原理是完全一样的，只不过我更偏向自定义中间件的代码组织方式，更加简洁和一目了然。

与此同时，我们希望对返回值进行格式上的统一包装，于是定义了这样的返回类型：

• ApiResponse.cs

using System.Text.Json;namespace TodoList.Api.Models;public class ApiResponse<T>{public T Data { get; set; }public bool Succeeded { get; set; }public string Message { get; set; }public static ApiResponse<T> Fail(string errorMessage) => new() { Succeeded = false, Message = errorMessage };public static ApiResponse<T> Success(T data) => new() { Succeeded = true, Data = data };public string ToJsonString() => JsonSerializer.Serialize(this);}

实现

在Api项目中新建Middlewares文件夹并新建中间件GlobalExceptionMiddleware

• GlobalExceptionMiddleware.cs

using System.Net;using TodoList.Api.Models;namespace TodoList.Api.Middlewares;public class GlobalExceptionMiddleware{private readonly RequestDelegate _next;public GlobalExceptionMiddleware(RequestDelegate next){_next = next;}public async Task InvokeAsync(HttpContext context){try{await _next(context);}catch (Exception exception){// 你可以在这里进行相关的日志记录await HandleExceptionAsync(context, exception);}}private async Task HandleExceptionAsync(HttpContext context, Exception exception){context.Response.ContentType = "application/json";context.Response.StatusCode = exception switch{ApplicationException => (int)HttpStatusCode.BadRequest,KeyNotFoundException => (int)HttpStatusCode.NotFound,_ => (int)HttpStatusCode.IntealServerError};var responseModel = ApiResponse<string>.Fail(exception.Message);await context.Response.WriteAsync(responseModel.ToJsonString());}}

这样我们的ExceptionMiddlewareExtensions就可以写成下面这样了：

• ExceptionMiddlewareExtensions.cs

using TodoList.Api.Middlewares;namespace TodoList.Api.Extensions;public static class ExceptionMiddlewareExtensions{public static WebApplication UseGlobalExceptionHandler(this WebApplication app){app.UseMiddleware<GlobalExceptionMiddleware>();retu app;}}

验证

首先我们需要在Controller中包装我们的返回值，举一个CreateTodoList的例子，其他的类似修改：

• TodoListController.cs

[HttpPost]public async Task<ApiResponse<Domain.Entities.TodoList>> Create([FromBody] CreateTodoListCommand command){retu ApiResponse<Domain.Entities.TodoList>.Success(await _mediator.Send(command));}

还记得我们在TodoList的领域实体上有一个Colour的属性吗，它是一个值对象，并且在赋值的过程中我们让它有机会抛出一个UnsupportedColourException，我们就用这个领域异常来验证全局异常处理。

为了验证需要，我们可以对CreateTodoListCommand做一些修改，让它接受一个Colour的字符串，相应修改如下：

• CreateTodoListCommand.cs

public class CreateTodoListCommand : IRequest<Domain.Entities.TodoList>{public string? Title { get; set; }public string? Colour { get; set; }}// 以下代码位于对应的Handler中，省略其他...var entity = new Domain.Entities.TodoList{Title = request.Title,Colour = Colour.From(request.Colour ?? string.Empty)};

启动Api项目，我们试图以一个不支持的颜色来创建TodoList：

• 请求
  

• 响应
  

顺便去看下正常返回的格式是否按我们预期的返回，下面是请求所有TodoList集合的接口返回：

可以看到正常和异常的返回类型已经统一了。

总结

其实实现全局异常处理还有一种方法是通过Filter来做，具体方法可以参考这篇文章：Filters in ASP.NET Core，我们之所以不选择Filter而使用Middleware主要是基于简单、易懂，并且作为中间件管道的第一个个中间件加入，有效地覆盖包括中间件在内的所有组件处理过程。Filter的位置是在路由中间件作用之后才被调用到。实际使用中，两种方式都有应用。

下一篇我们来实现PUT请求。

参考资料

1. Write custom ASP.NET Core middleware
2. Filters in ASP.NET Core