ASP.NET Core WebApi返回结果统一包装实践记录_实用技巧_

public class ResponseResult { /// 
 /// 状态结果 /// 
 public ResultStatus Status { get; set; } = ResultStatus.Success; private string? _msg; /// 
 /// 消息描述 /// 
 public string? Message { get { // 如果没有自定义的结果描述，则可以获取当前状态的描述 return !string.IsNullOrEmpty(_msg) ? _msg : EnumHelper.GetDescription(Status); } set { _msg = value; } } /// 
 /// 返回结果 /// 
 public T Data { get; set; } } 

public enum ResultStatus { [Description("请求成功")] Success = 1, [Description("请求失败")] Fail = 0, [Description("请求异常")] Error = -1 } 

[HttpGet("GetWeatherForecast")] public ResponseResult> GetAll() { var datas = Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] }); return new ResponseResult> { Data = datas }; } 

public class ResponseResult { /// 
 /// 状态结果 /// 
 public ResultStatus Status { get; set; } = ResultStatus.Success; private string? _msg; /// 
 /// 消息描述 /// 
 public string? Message { get { return !string.IsNullOrEmpty(_msg) ? _msg : EnumHelper.GetDescription(Status); } set { _msg = value; } } /// 
 /// 返回结果 /// 
 public T Data { get; set; } /// 
 /// 成功状态返回结果 /// 
 /// 返回的数据 ///  public static ResponseResult SuccessResult(T data) { return new ResponseResult { Status = ResultStatus.Success, Data = data }; } /// 
 /// 失败状态返回结果 /// 
 /// 状态码 /// 失败信息 ///  public static ResponseResult FailResult(string? msg = null) { return new ResponseResult { Status = ResultStatus.Fail, Message = msg }; } /// 
 /// 异常状态返回结果 /// 
 /// 状态码 /// 异常信息 ///  public static ResponseResult ErrorResult(string? msg = null) { return new ResponseResult { Status = ResultStatus.Error, Message = msg }; } /// 
 /// 自定义状态返回结果 /// 
 ///  ///  ///  public static ResponseResult Result(ResultStatus status, T data, string? msg = null) { return new ResponseResult { Status = status, Data = data, Message = msg }; } } 

[HttpGet("GetWeatherForecast")] public ResponseResult> GetAll() { var datas = Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] }); return ResponseResult>.SuccessResult(datas); } 

[ApiController] [Route("api/[controller]")] public class ApiControllerBase : ControllerBase { /// 
 /// 成功状态返回结果 /// 
 /// 返回的数据 ///  protected ResponseResult SuccessResult(T result) { return ResponseResult.SuccessResult(result); } /// 
 /// 失败状态返回结果 /// 
 /// 状态码 /// 失败信息 ///  protected ResponseResult FailResult(string? msg = null) { return ResponseResult.FailResult(msg); } /// 
 /// 异常状态返回结果 /// 
 /// 状态码 /// 异常信息 ///  protected ResponseResult ErrorResult(string? msg = null) { return ResponseResult.ErrorResult(msg); } /// 
 /// 自定义状态返回结果 /// 
 ///  ///  ///  protected ResponseResult Result(ResultStatus status, T result, string? msg = null) { return ResponseResult.Result(status, result, msg); } } 

public class WeatherForecastController : ApiControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; [HttpGet("GetWeatherForecast")] public ResponseResult> GetAll() { var datas = Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] }); return SuccessResult(datas); } } 

public static implicit operator ActionResult(TValue value) { return new ActionResult(value); } 

/// 
 /// 隐式将T转化为ResponseResult /// 
 ///  public static implicit operator ResponseResult(T value) { return new ResponseResult { Data = value }; } 

[HttpGet("GetWeatherForecast")] public ResponseResult> GetAll() { var datas = Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] }); return datas.ToList(); } 

public class ResultWrapperFilter : ActionFilterAttribute { public override void OnResultExecuting(ResultExecutingContext context) { var controllerActionDescriptor = context.ActionDescriptor as ControllerActionDescriptor; var actionWrapper = controllerActionDescriptor?.MethodInfo.GetCustomAttributes(typeof(NoWrapperAttribute), false).FirstOrDefault(); var controllerWrapper = controllerActionDescriptor?.ControllerTypeInfo.GetCustomAttributes(typeof(NoWrapperAttribute), false).FirstOrDefault(); //如果包含NoWrapperAttribute则说明不需要对返回结果进行包装，直接返回原始值 if (actionWrapper != null || controllerWrapper != null) 
                
提示：
                    本文由神整理自网络，如有侵权请联系本站删除！
                    

                    本站声明： 

                    1、本站所有资源均来源于互联网，不保证100%完整、不提供任何技术支持； 

                    2、本站所发布的文章以及附件仅限用于学习和研究目的;不得将用于商业或者非法用途；否则由此产生的法律后果，本站概不负责！
                
                

                

                                            
上一篇：asp.net core + jenkins 实现自动化发布功能_实用技巧_
                                                                
下一篇：Entity Framework Core种子数据Data-Seeding_实用技巧_