AdminResultProvider.cs 4.6 KB

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