GoViewResultProvider.cs 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. namespace Admin.NET.Plugin.GoView.Util;
  2. /// <summary>
  3. /// GoView 规范化结果
  4. /// </summary>
  5. [UnifyModel(typeof(GoViewResult<>))]
  6. public class GoViewResultProvider : IUnifyResultProvider
  7. {
  8. /// <summary>
  9. /// 异常返回值
  10. /// </summary>
  11. /// <param name="context"></param>
  12. /// <param name="metadata"></param>
  13. /// <returns></returns>
  14. public IActionResult OnException(ExceptionContext context, ExceptionMetadata metadata)
  15. {
  16. return new JsonResult(RESTfulResult(metadata.StatusCode, data: metadata.Data, errors: metadata.Errors));
  17. }
  18. /// <summary>
  19. /// 成功返回值
  20. /// </summary>
  21. /// <param name="context"></param>
  22. /// <param name="data"></param>
  23. /// <returns></returns>
  24. public IActionResult OnSucceeded(ActionExecutedContext context, object data)
  25. {
  26. return new JsonResult(RESTfulResult(StatusCodes.Status200OK, true, data));
  27. }
  28. /// <summary>
  29. /// 验证失败返回值
  30. /// </summary>
  31. /// <param name="context"></param>
  32. /// <param name="metadata"></param>
  33. /// <returns></returns>
  34. public IActionResult OnValidateFailed(ActionExecutingContext context, ValidationMetadata metadata)
  35. {
  36. return new JsonResult(RESTfulResult(metadata.StatusCode ?? StatusCodes.Status400BadRequest, data: metadata.Data, errors: metadata.ValidationResult));
  37. }
  38. /// <summary>
  39. /// 特定状态码返回值
  40. /// </summary>
  41. /// <param name="context"></param>
  42. /// <param name="statusCode"></param>
  43. /// <param name="unifyResultSettings"></param>
  44. /// <returns></returns>
  45. public async Task OnResponseStatusCodes(HttpContext context, int statusCode, UnifyResultSettingsOptions unifyResultSettings)
  46. {
  47. // 设置响应状态码
  48. UnifyContext.SetResponseStatusCodes(context, statusCode, unifyResultSettings);
  49. switch (statusCode)
  50. {
  51. // 处理 401 状态码
  52. case StatusCodes.Status401Unauthorized:
  53. await context.Response.WriteAsJsonAsync(RESTfulResult(886, errors: "401 登录已过期,请重新登录"),
  54. App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
  55. break;
  56. // 处理 403 状态码
  57. case StatusCodes.Status403Forbidden:
  58. await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, errors: "403 禁止访问,没有权限"),
  59. App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
  60. break;
  61. default: break;
  62. }
  63. }
  64. /// <summary>
  65. /// 返回 RESTful 风格结果集
  66. /// </summary>
  67. /// <param name="statusCode"></param>
  68. /// <param name="succeeded"></param>
  69. /// <param name="data"></param>
  70. /// <param name="errors"></param>
  71. /// <returns></returns>
  72. private static GoViewResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default, object errors = default)
  73. {
  74. return new GoViewResult<object>
  75. {
  76. Code = statusCode,
  77. Msg = errors is null or string ? (errors + "") : JSON.Serialize(errors),
  78. Data = data,
  79. Count = data != null && data.GetType().IsGenericType && data.GetType().GetGenericTypeDefinition() == typeof(List<>) ? ((IList)data).Count : null
  80. };
  81. }
  82. }
  83. /// <summary>
  84. /// GoView 返回结果
  85. /// </summary>
  86. /// <typeparam name="T"></typeparam>
  87. public class GoViewResult<T>
  88. {
  89. /// <summary>
  90. /// 状态码
  91. /// </summary>
  92. public int Code { get; set; }
  93. /// <summary>
  94. /// 信息
  95. /// </summary>
  96. public string Msg { get; set; }
  97. /// <summary>
  98. /// 数据
  99. /// </summary>
  100. public T Data { get; set; }
  101. /// <summary>
  102. /// 总数
  103. /// </summary>
  104. public int? Count { get; set; }
  105. }