ASP.NET Core AutoWrapper 自定义响应输出实现

前言 AutoWrapper是一个简单可自定义全局异常处理程序和ASP.NET Core API响应的包装。他使用ASP.NET Core middleware拦截传入的HTTP请求，并将最后的结果使用统一的格式来自动包装起来.目的主要是让我们更多的关注业务特定的代码要求，并让包装器自动处理HTTP响应。这可以在构建API时加快开发时间，同时为HTTP响应试试我们统一的标准。 安装 AutoWrapper.Core从NuGet或通过CLI下载并安装 PM> Install-Package AutoWrapper.Core 在Startup.cs Configure方法中注册以下内容，但 ASP.NET Core AutoWrapper 是一个非常实用的工具，它允许开发者快速构建API，专注于核心业务逻辑，而无需过多地处理HTTP响应的格式化。这个库通过中间件（middleware）机制捕获HTTP请求，对响应结果进行统一包装，提供了一种标准化的响应格式。这样可以提高开发效率，保持API的一致性，并简化异常处理。 要使用AutoWrapper，首先需要通过NuGet包管理器或命令行界面（CLI）安装`AutoWrapper.Core`。在项目中执行`PM> Install-Package AutoWrapper.Core`即可完成安装。接下来，在`Startup.cs`的`Configure`方法中注册中间件。重要的是，这个注册应该放在`UseRouting`之前，因为中间件的顺序决定了它们处理请求的顺序。 ```csharp public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // ... app.UseApiResponseAndExceptionWrapper(); app.UseRouting(); // ... } ``` AutoWrapper默认的响应格式如下： ```json { "message": "Request successful.", "isError": false, "result": [ { "id": 7002, "firstName": "Vianne", "lastName": "Durano", "dateOfBirth": "2018-11-01T00:00:00" } ] } ``` 如果你想要自定义响应属性的名称，可以创建一个类并使用`AutoWrapperPropertyMap`特性进行映射。例如，将`result`属性改名为`data`： ```csharp public class MapResponseObject { [AutoWrapperPropertyMap(Prop.Result)] public object Data { get; set; } } ``` 然后将这个类传递给`AutoWrapper`中间件： ```csharp app.UseApiResponseAndExceptionWrapper<MapResponseObject>(); ``` 修改后的响应格式会如你所愿： ```json { "message": "Request successful.", "isError": false, "data": { "id": 7002, "firstName": "Vianne", "lastName": "Durano", "dateOfBirth": "2018-11-01T00:00:00" } } ``` 当发生异常时，AutoWrapper会返回一个包含错误信息的结构。默认格式如下： ```json { "isError": true, "responseException": { "exceptionMessage": "Unhandled Exception occurred. Unable to process the request." } } ``` 如果启用了调试模式（IsDebug），则会包含堆栈跟踪信息。如果想自定义APIError属性的名称，可以创建一个映射类，如`MapResponseObject`： ```csharp public class MapResponseObject { [AutoWrapperPropertyMap(Prop.ResponseException)] public object Error { get; set; } [AutoWrapperPropertyMap(Prop.ResponseException_ExceptionMessage)] public string Message { get; set; } [AutoWrapperPropertyMap(Prop.ResponseException_Details)] public string StackTrace { get; set; } } ``` 这样，当发生异常时，响应将按照自定义的属性名显示： ```json { "isError": true, "error": { "message": "Input string was not in a correct format.", "details": "at System.Number.ThrowOverflowOrFormatException(ParsingStatus status, TypeCode type)\r\n at System.Number.ParseInt32(ReadOnlySpan`1 value, NumberStyles styles, NumberFormatInfo info)\r\n ..." } } ``` ASP.NET Core AutoWrapper 提供了一种强大的方式来规范化API的响应，同时简化了异常处理。通过自定义属性映射，开发者可以根据自己的需求调整响应格式，确保API的灵活性和一致性。这对于构建高质量、易于维护的ASP.NET Core Web API项目至关重要。