造轮子之统一业务异常处理

合集 - Asp.Net Core造轮之旅：逐步构建自己的开发框架(38)

1.Asp.Net Core造轮之旅：逐步构建自己的开发框架-目录2023-07-242.asp.net core之Startup2023-07-243.asp.net core之依赖注入2023-07-254.asp.net core之中间件2023-07-265.asp.net core之Host2023-07-276.asp.net core之Kestrel2023-07-277.asp.net core之配置2023-07-278.asp.net core之Options2023-07-319.asp.net core之日志2023-08-0110.asp.net core之路由2023-08-0211.asp.net core之异常处理2023-08-0312.asp.net core之HttpClient2023-08-0413.asp.net core之实时应用2023-08-0414.asp.net core之EfCore2023-08-0715.造轮子之自动依赖注入2023-10-0816.造轮子之日志2023-10-08

17.造轮子之统一业务异常处理2023-10-08

18.造轮子之统一请求响应格式2023-10-0819.造轮子之缓存2023-10-0820.造轮子之ORM集成2023-10-0821.造轮子之asp.net core identity2023-10-0922.造轮子之自定义授权策略2023-10-0923.造轮子之权限管理2023-10-1024.造轮子之多语言管理2023-10-1125.造轮子之角色管理2023-10-1226.造轮子之用户管理2023-10-1227.造轮子之菜单管理2023-10-1228.造轮子之属性注入配合懒加载构建服务抽象基类2023-10-1229.造轮子之EventBus2023-10-1230.造轮子之消息实时推送2023-10-1331.造轮子之种子数据2023-10-1632.造轮子之集成GraphQL2023-10-1633.造轮子之设置管理2023-10-1934.造轮子之文件管理2023-10-2335.造轮子之单层应用总结篇2023-10-2636.单层应用升级到多层应用12024-01-2237.单层应用升级到多层应用22024-01-2238.单层应用升级到多层应用32024-01-23

收起

异常处理也是我们必不可少的一环，借助Asp.netCore的UseExceptionHandler中间件，我们可以很轻易的配置我们的业务异常处理逻辑。

自定义业务异常类#

首先我们定义一个业务异常类，继承Exception，添加一个Code状态码属性，和MessageData数组，这个数组用于Format异常信息。在实际业务场景中可以灵活扩展此类。

namespace Wheel.Core.Exceptions
{
    public class BusinessException : Exception
    {
        public string Code { get; set; }

        public string[]? MessageData { get; set; }

        public BusinessException(string code, string? message = "") : base(message)
        {
            Code = code;
        }

        public BusinessException WithMessageDataData(params string[] messageData)
        {
            MessageData = messageData;
            return this;
        }
    }
}

约定错误码#

在业务开发中，我们经常需要根据错误码去判断具体的业务错误类型。所以我们需要约定一个错误码格式。
创建一个ErrorCode类。

/// <summary>
/// 错误码
/// 约定5位数字字符串
/// 4XXXX：客户端错误信息
/// 5XXXX: 服务端错误信息
/// </summary>
public class ErrorCode
{
    #region 5XXXX
    public const string InternalError = "50000";
    #endregion
    #region 4XXXX
    #endregion
}

这里我们约定一下5位数错误码，5开头则服务端的错误类型，4开头则客户端错误类型。当然，往后可以按照实际业务需求做出更多的约定或者改动。

UseExceptionHandler#

接下来使用UseExceptionHandler配置我们的异常处理逻辑。
在Program中添加代码。

app.UseExceptionHandler(exceptionHandlerApp =>
{
    exceptionHandlerApp.Run(async context =>
    {
        context.Response.StatusCode = StatusCodes.Status500InternalServerError;

        // using static System.Net.Mime.MediaTypeNames;
        context.Response.ContentType = Application.Json;
        var exceptionHandlerPathFeature =
            context.Features.Get<IExceptionHandlerPathFeature>();

        if (exceptionHandlerPathFeature?.Error is BusinessException businessException)
        {
            var L = context.RequestServices.GetRequiredService<IStringLocalizerFactory>().Create(null);
            if (businessException.MessageData != null)
                await context.Response.WriteAsJsonAsync(new R { Code = businessException.Code, Message = L[businessException.Message, businessException.MessageData] });
            else
                await context.Response.WriteAsJsonAsync(new R { Code = businessException.Code, Message = L[businessException.Message] });
        }
        else
        {
            await context.Response.WriteAsJsonAsync(new R { Code = ErrorCode.InternalError, Message = exceptionHandlerPathFeature?.Error.Message });
        }
    });
});

这里判断如果是我们的BusinessException类型异常，则返回统一的Json结构，并且使用多语言处理我们的异常信息。

到这我们就轻松的完成了我们的统一业务异常处理。

轮子仓库地址https://github.com/Wheel-Framework/Wheel
欢迎进群催更。