1.使用方式
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
//注册MemoryCache缓存中间件
services.AddMemoryCache();
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
//注册Mvc
services.AddControllers(options =>
{
//注册全局过滤器服务
options.Filters.Add(typeof(AppExceptionFilter));
//options.Filters.Add(typeof(AuthorizeFilter));
options.Filters.Add(typeof(AppResultFilter));
options.RespectBrowserAcceptHeader = true;
}).AddControllersAsServices()
//使用NewtonsoftJson序列化数据
.AddNewtonsoftJson(options =>
{
//取消骆驼命名法
//options.SerializerSettings.ContractResolver = new DefaultContractResolver();
//设置返回datetime时间格式
options.SerializerSettings.DateFormatString = "yyyy'-'MM'-'dd' 'HH':'mm':'ss";
}
);
}
[HttpGet]
[ProducesResponseType(typeof(ApiResult<List<WeatherForecast>>), 200)]
public IEnumerable<WeatherForecast> Get()
{
var a = dishesCategoryRepository.CountAll();
var rng = new Random();
return Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateTime.Now.AddDays(index),
TemperatureC = rng.Next(-20, 55),
Summary = Summaries[rng.Next(Summaries.Length)]
})
.ToArray();
}
/// 返回数据格式 { "httpStatus" :200, "data" :{}, "message" :"执行成功",
"timeOut":2021 }
2.具体实现
/// <summary>
/// 返回结果过滤器,统一返回数据格式
/// </summary>
public class AppResultFilter : Attribute, IActionFilter
{
/// <summary>
/// 请求时长计时开始
/// </summary>
private readonly Stopwatch watch = new Stopwatch();
/// <summary>
/// 返回结果执行之前
/// </summary>
/// <param name="context"></param>
public void OnActionExecuting(ActionExecutingContext context)
{
watch.Start();//开始
}
/// <summary>
/// 返回结果执行之后
/// </summary>
/// <param name="context"></param>
public void OnActionExecuted(ActionExecutedContext context)
{
watch.Stop();
//根据实际需求进行具体实现
if (context.Result is ObjectResult)
{
var objectResult = context.Result as ObjectResult;
if (objectResult.Value == null)
{
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.NotFound, Message = "未找到资源", TimeOut = watch.ElapsedMilliseconds });
}
else
{
if (objectResult.Value is ApiResult)
{
var result = (ApiResult)objectResult.Value;
result.TimeOut = watch.ElapsedMilliseconds;
context.Result = new ObjectResult(result);
return;
}
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.OK, Message = "请求成功", Data = objectResult.Value, TimeOut = watch.ElapsedMilliseconds });
//判读是否返回的是元组
//返回数据并且返回总行数 public async Task<(List<object>,int)> Paging(PagingBaseRequest parameter) { retuen ( new List<object>{ },1000) }
if (objectResult.DeclaredType != null && objectResult.DeclaredType.Name == "ValueTuple`2")
{
dynamic value = objectResult.Value;
if (value.Item1 != null)
{
if (value.Item1 is int)
{
//返回元组格式(int,List<object>)
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.OK, Message = "请求成功", TimeOut = watch.ElapsedMilliseconds, Data = new { Count = value.Item1, Data = value.Item2 } });
}
else
//返回元组格式(List<object>,int)
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.OK, Message = "请求成功", TimeOut = watch.ElapsedMilliseconds, Data = new { Count = value.Item2, Data = value.Item1 } });
}
}
}
}
else if (context.Result is EmptyResult)
{
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.OK, Message = "请求成功" });
}
else if (context.Result is ContentResult)
{
context.Result = new ObjectResult(new ApiResult { HttpStatus = HttpStatusCode.OK, Message = "", TimeOut = watch.ElapsedMilliseconds, Data = (context.Result as ContentResult).Content });
}
else if (context.Result is StatusCodeResult)
{
context.Result = new ObjectResult(new { HttpStatus = (context.Result as StatusCodeResult).StatusCode, TimeOut = watch.ElapsedMilliseconds, Message = "" });
}
else if (context.Result is Exception)
{
var result = context.Result as Exception;
context.Result = new ObjectResult(new { HttpStatus = HttpStatusCode.BadRequest, TimeOut = watch.ElapsedMilliseconds, Message = result.Message });
}
}
}
/// <summary>
/// 数据返回模型基类
/// </summary>
public class ApiResult
{
/// <summary>
/// 返回状态码
/// </summary>
public virtual HttpStatusCode HttpStatus { get; set; } = HttpStatusCode.OK;
/// <summary>
/// 返回数据
/// </summary>
public virtual object Data { get; set; }
/// <summary>
/// 获取 消息内容
/// </summary>
public virtual string Message { get; set; }
/// <summary>
/// 执行时长
/// </summary>
public virtual long TimeOut { get; set; }