AdminResultProvider.cs 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. using Furion;
  2. using Furion.DataValidation;
  3. using Furion.DependencyInjection;
  4. using Furion.UnifyResult;
  5. using Furion.UnifyResult.Internal;
  6. using Microsoft.AspNetCore.Http;
  7. using Microsoft.AspNetCore.Mvc;
  8. using Microsoft.AspNetCore.Mvc.Filters;
  9. using System;
  10. using System.Threading.Tasks;
  11. namespace Admin.NET.Core
  12. {
  13. /// <summary>
  14. /// 全局规范化结果
  15. /// </summary>
  16. [SuppressSniffer, UnifyModel(typeof(AdminResult<>))]
  17. public class AdminResultProvider : IUnifyResultProvider
  18. {
  19. /// <summary>
  20. /// 异常返回值
  21. /// </summary>
  22. /// <param name="context"></param>
  23. /// <param name="metadata"></param>
  24. /// <returns></returns>
  25. public IActionResult OnException(ExceptionContext context, ExceptionMetadata metadata)
  26. {
  27. return new JsonResult(RESTfulResult(metadata.StatusCode, errors: metadata.Errors));
  28. }
  29. /// <summary>
  30. /// 成功返回值
  31. /// </summary>
  32. /// <param name="context"></param>
  33. /// <param name="data"></param>
  34. /// <returns></returns>
  35. public IActionResult OnSucceeded(ActionExecutedContext context, object data)
  36. {
  37. return new JsonResult(RESTfulResult(StatusCodes.Status200OK, true, data));
  38. }
  39. /// <summary>
  40. /// 验证失败返回值
  41. /// </summary>
  42. /// <param name="context"></param>
  43. /// <param name="metadata"></param>
  44. /// <returns></returns>
  45. public IActionResult OnValidateFailed(ActionExecutingContext context, ValidationMetadata metadata)
  46. {
  47. return new JsonResult(RESTfulResult(StatusCodes.Status400BadRequest, errors: metadata.ValidationResult));
  48. }
  49. /// <summary>
  50. /// 特定状态码返回值
  51. /// </summary>
  52. /// <param name="context"></param>
  53. /// <param name="statusCode"></param>
  54. /// <param name="unifyResultSettings"></param>
  55. /// <returns></returns>
  56. public async Task OnResponseStatusCodes(HttpContext context, int statusCode, UnifyResultSettingsOptions unifyResultSettings)
  57. {
  58. // 设置响应状态码
  59. UnifyContext.SetResponseStatusCodes(context, statusCode, unifyResultSettings);
  60. switch (statusCode)
  61. {
  62. // 处理 401 状态码
  63. case StatusCodes.Status401Unauthorized:
  64. await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, errors: "401 登录已过期,请重新登录"),
  65. App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
  66. break;
  67. // 处理 403 状态码
  68. case StatusCodes.Status403Forbidden:
  69. await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, errors: "403 禁止访问,没有权限"),
  70. App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
  71. break;
  72. default: break;
  73. }
  74. }
  75. /// <summary>
  76. /// 返回 RESTful 风格结果集
  77. /// </summary>
  78. /// <param name="statusCode"></param>
  79. /// <param name="succeeded"></param>
  80. /// <param name="data"></param>
  81. /// <param name="errors"></param>
  82. /// <returns></returns>
  83. private static AdminResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default, object errors = default)
  84. {
  85. return new AdminResult<object>
  86. {
  87. Code = statusCode,
  88. Message = errors,
  89. Result = data,
  90. Type = succeeded ? "success" : "error",
  91. Extras = UnifyContext.Take(),
  92. Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()
  93. };
  94. }
  95. }
  96. /// <summary>
  97. /// 全局返回结果
  98. /// </summary>
  99. /// <typeparam name="T"></typeparam>
  100. public class AdminResult<T>
  101. {
  102. /// <summary>
  103. /// 状态码
  104. /// </summary>
  105. public int Code { get; set; }
  106. /// <summary>
  107. /// 类型success、warning、error
  108. /// </summary>
  109. public string Type { get; set; }
  110. /// <summary>
  111. /// 错误信息
  112. /// </summary>
  113. public object Message { get; set; }
  114. /// <summary>
  115. /// 数据
  116. /// </summary>
  117. public T Result { get; set; }
  118. /// <summary>
  119. /// 附加数据
  120. /// </summary>
  121. public object Extras { get; set; }
  122. /// <summary>
  123. /// 时间戳
  124. /// </summary>
  125. public long Timestamp { get; set; }
  126. }
  127. }