asp.net core 中优雅的进行响应包装的实现方法_实用技巧_

 public interface IResponseWrapper { IResponseWrapper Ok(); IResponseWrapper ClientError(string message); } public interface IResponseWrapper : IResponseWrapper { IResponseWrapper Ok(TResponse response); }

/// 
 /// Default wrapper for  or error occured /// 
 public class ResponseWrapper : IResponseWrapper { public int Code { get; } public string? Message { get; } ... public IResponseWrapper Ok() { return new ResponseWrapper(ResponseWrapperDefaults.OkCode, null); } public IResponseWrapper BusinessError(string message) { return new ResponseWrapper(ResponseWrapperDefaults.BusinessErrorCode, message); } public IResponseWrapper ClientError(string message) { return new ResponseWrapper(ResponseWrapperDefaults.ClientErrorCode, message); } }

/// 
 /// Default wrapper for  /// 
 ///  public class ResponseWrapper : ResponseWrapper, IResponseWrapper { public TResponse? Data { get; } public ResponseWrapper() { } private ResponseWrapper(int code, string? message, TResponse? data) : base(code, message) { Data = data; } public IResponseWrapper Ok(TResponse response) { return new ResponseWrapper(ResponseWrapperDefaults.OkCode, null, response); } }

public class ResultWrapperFilter : IResultWrapperFilter { private readonly IResponseWrapper _responseWrapper; private readonly IResponseWrapper _responseWithDataWrapper; ... public void OnActionExecuted(ActionExecutedContext context) { switch (context.Result) { case EmptyResult: context.Result = new OkObjectResult(_responseWrapper.Ok()); return; case ObjectResult objectResult: context.Result = new OkObjectResult(_responseWithDataWrapper.Ok(objectResult.Value)); return; } } }

public class ModelInvalidWrapperFilter : IActionFilter { private readonly IResponseWrapper _responseWrapper; private readonly ILogger _logger; ... public void OnActionExecuting(ActionExecutingContext context) { if (context.Result == null && !context.ModelState.IsValid) { ModelStateInvalidFilterExecuting(_logger, null); context.Result = new ObjectResult(_responseWrapper.ClientError(string.Join(",", context.ModelState.Values.SelectMany(v => v.Errors).Select(e => e.ErrorMessage)))) { StatusCode = StatusCodes.Status400BadRequest }; } } ... }

public interface IDisableWrapperMetadata { } [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] public class DisableWrapperAttribute : Attribute, IDisableWrapperMetadata { }

public class ResponseWrapperApplicationModelProvider : IApplicationModelProvider { ... public void OnProvidersExecuting(ApplicationModelProviderContext context) { if (context is null) { throw new ArgumentNullException(nameof(context)); } foreach (var controllerModel in context.Result.Controllers) { if (_onlyAvailableInApiController && IsApiController(controllerModel)) { continue; } if (controllerModel.Attributes.OfType().Any()) { if (!_suppressModelInvalidWrapper) { foreach (var actionModel in controllerModel.Actions) { actionModel.Filters.Add(new ModelInvalidWrapperFilter(_responseWrapper, _loggerFactory)); } } continue; } foreach (var actionModel in controllerModel.Actions) { if (!_suppressModelInvalidWrapper) { actionModel.Filters.Add(new ModelInvalidWrapperFilter(_responseWrapper, _loggerFactory)); } if (actionModel.Attributes.OfType().Any()) continue; actionModel.Filters.Add(new ResultWrapperFilter(_responseWrapper, _genericResponseWrapper)); // support swagger AddResponseWrapperFilter(actionModel); } } } ... }

if (!options.SuppressModelStateInvalidFilter) { ActionModelConventions.Add(new InvalidModelStateFilterConvention()); }

public static IMvcBuilder AddResponseWrapper(this IMvcBuilder mvcBuilder, Action action) { mvcBuilder.Services.Configure(action); mvcBuilder.ConfigureApiBehaviorOptions(options => { options.SuppressModelStateInvalidFilter = true; }); mvcBuilder.Services.TryAddEnumerable(ServiceDescriptor.Transient()); return mvcBuilder; }

dotnet add package AspNetCore.ResponseWrapper --version 1.0.1

// .Net5 services.AddApiControllers().AddResponseWrapper(); // .Net6 builder.Services.AddControllers().AddResponseWrapper();

public class CustomResponseWrapper : IResponseWrapper { public bool Success => Code == 0; public int Code { get; set; } public string? Message { get; set; } public CustomResponseWrapper() { } public CustomResponseWrapper(int code, string? message) { Code = code; Message = message; } public IResponseWrapper Ok() { return new CustomResponseWrapper(0, null); } public IResponseWrapper BusinessError(string message) { return new CustomResponseWrapper(1, message); } public IResponseWrapper ClientError(string message) { return new CustomResponseWrapper(400, message); } } public class CustomResponseWrapper : CustomResponseWrapper, IResponseWrapper { public TResponse? Result { get; set; } public CustomResponseWrapper() { } public CustomResponseWrapper(int code, string? message, TResponse? result) : base(code, message) { Result = result; } public IResponseWrapper Ok(TResponse response) { return new CustomResponseWrapper(0, null, response); } }

// .Net6 builder.Services.AddControllers().AddResponseWrapper(options => { options.ResponseWrapper = new CustomResponseWrapper.ResponseWrapper.CustomResponseWrapper(); options.GenericResponseWrapper = new CustomResponseWrapper(); });