IdempotentAttribute.cs 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using Newtonsoft.Json;
  7. using System.Security.Claims;
  8. namespace Admin.NET.Core;
  9. /// <summary>
  10. /// 防止重复请求过滤器特性(此特性使用了分布式锁,需确保系统支持分布式锁)
  11. /// </summary>
  12. [SuppressSniffer]
  13. [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = true)]
  14. public class IdempotentAttribute : Attribute, IAsyncActionFilter
  15. {
  16. /// <summary>
  17. /// 请求间隔时间/秒
  18. /// </summary>
  19. public int IntervalTime { get; set; } = 5;
  20. /// <summary>
  21. /// 错误提示内容
  22. /// </summary>
  23. public string Message { get; set; } = "你操作频率过快,请稍后重试!";
  24. /// <summary>
  25. /// 缓存前缀: Key+请求路由+用户Id+请求参数
  26. /// </summary>
  27. public string CacheKey { get; set; } = CacheConst.KeyIdempotent;
  28. /// <summary>
  29. /// 是否直接抛出异常:Ture是,False返回上次请求结果
  30. /// </summary>
  31. public bool ThrowBah { get; set; }
  32. /// <summary>
  33. /// 锁前缀
  34. /// </summary>
  35. public string LockPrefix { get; set; } = "lock_";
  36. public IdempotentAttribute()
  37. {
  38. }
  39. public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
  40. {
  41. var httpContext = context.HttpContext;
  42. var path = httpContext.Request.Path.Value.ToString();
  43. var userId = httpContext.User?.FindFirstValue(ClaimConst.UserId);
  44. var cacheExpireTime = TimeSpan.FromSeconds(IntervalTime);
  45. var parameters = JsonConvert.SerializeObject(context.ActionArguments, Formatting.None, new JsonSerializerSettings
  46. {
  47. NullValueHandling = NullValueHandling.Include,
  48. DefaultValueHandling = DefaultValueHandling.Include
  49. });
  50. var cacheKey = CacheKey + MD5Encryption.Encrypt($"{path}{userId}{parameters}");
  51. var sysCacheService = httpContext.RequestServices.GetService<SysCacheService>();
  52. try
  53. {
  54. // 分布式锁
  55. using var distributedLock = sysCacheService.BeginCacheLock($"{LockPrefix}{cacheKey}") ?? throw Oops.Oh(Message);
  56. var cacheValue = sysCacheService.Get<ResponseData>(cacheKey);
  57. if (cacheValue != null)
  58. {
  59. if (ThrowBah) throw Oops.Oh(Message);
  60. context.Result = new ObjectResult(cacheValue.Value);
  61. return;
  62. }
  63. else
  64. {
  65. var resultContext = await next();
  66. // 缓存请求结果,null值不缓存
  67. if (resultContext.Result is ObjectResult { Value: { } } objectResult)
  68. {
  69. var typeName = objectResult.Value.GetType().Name;
  70. var responseData = new ResponseData
  71. {
  72. Type = typeName,
  73. Value = objectResult.Value
  74. };
  75. sysCacheService.Set(cacheKey, responseData, cacheExpireTime);
  76. }
  77. }
  78. }
  79. catch (Exception ex)
  80. {
  81. throw Oops.Oh($"{Message}-{ex}");
  82. }
  83. }
  84. /// <summary>
  85. /// 请求结果数据
  86. /// </summary>
  87. private class ResponseData
  88. {
  89. /// <summary>
  90. /// 结果类型
  91. /// </summary>
  92. public string Type { get; set; }
  93. /// <summary>
  94. /// 请求结果
  95. /// </summary>
  96. public dynamic Value { get; set; }
  97. }
  98. }