DictAttribute.cs 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Core;
  7. /// <summary>
  8. /// 字典值合规性校验特性
  9. /// </summary>
  10. [SuppressSniffer]
  11. [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = true, Inherited = true)]
  12. public class DictAttribute : ValidationAttribute, ITransient
  13. {
  14. /// <summary>
  15. /// 字典编码
  16. /// </summary>
  17. public string DictTypeCode { get; }
  18. /// <summary>
  19. /// 是否允许空字符串
  20. /// </summary>
  21. public bool AllowEmptyStrings { get; set; } = false;
  22. /// <summary>
  23. /// 允许空值,有值才验证,默认 false
  24. /// </summary>
  25. public bool AllowNullValue { get; set; } = false;
  26. /// <summary>
  27. /// 字典值合规性校验特性
  28. /// </summary>
  29. /// <param name="dictTypeCode"></param>
  30. /// <param name="errorMessage"></param>
  31. public DictAttribute(string dictTypeCode = "", string errorMessage = "字典值不合法!")
  32. {
  33. DictTypeCode = dictTypeCode;
  34. ErrorMessage = errorMessage;
  35. }
  36. /// <summary>
  37. /// 字典值合规性校验
  38. /// </summary>
  39. /// <param name="value"></param>
  40. /// <param name="validationContext"></param>
  41. /// <returns></returns>
  42. protected override ValidationResult IsValid(object? value, ValidationContext validationContext)
  43. {
  44. // 判断是否允许空值
  45. if (AllowNullValue && value == null) return ValidationResult.Success;
  46. // 获取属性的类型
  47. var property = validationContext.ObjectType.GetProperty(validationContext.MemberName!);
  48. if (property == null) return new ValidationResult($"未知属性: {validationContext.MemberName}");
  49. var propertyType = Nullable.GetUnderlyingType(property.PropertyType) ?? property.PropertyType;
  50. // 先尝试从 ValidationContext 的依赖注入容器中拿服务,拿不到或类型不匹配时,再从全局的 App 容器中获取
  51. if (validationContext.GetService(typeof(SysDictDataService)) is not SysDictDataService sysDictDataService)
  52. sysDictDataService = App.GetRequiredService<SysDictDataService>();
  53. // 获取字典值列表
  54. var dictDataList = sysDictDataService.GetDataList(DictTypeCode).GetAwaiter().GetResult();
  55. // 使用 HashSet 来提高查找效率
  56. var dictHash = new HashSet<string>(dictDataList.Select(u => u.Value));
  57. // 判断是否为集合类型
  58. if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(List<>))
  59. {
  60. // 如果是空集合并且允许空值,则直接返回成功
  61. if (value == null && AllowNullValue) return ValidationResult.Success;
  62. // 处理集合为空的情况
  63. var collection = value as IEnumerable;
  64. if (collection == null) return ValidationResult.Success;
  65. // 获取集合的元素类型
  66. var elementType = propertyType.GetGenericArguments()[0];
  67. var underlyingElementType = Nullable.GetUnderlyingType(elementType) ?? elementType;
  68. // 如果元素类型是枚举,则逐个验证
  69. if (underlyingElementType.IsEnum)
  70. {
  71. foreach (var item in collection)
  72. {
  73. if (item == null && AllowNullValue) continue;
  74. if (!Enum.IsDefined(underlyingElementType, item!))
  75. return new ValidationResult($"提示:{ErrorMessage}|枚举值【{item}】不是有效的【{underlyingElementType.Name}】枚举类型值!");
  76. }
  77. return ValidationResult.Success;
  78. }
  79. foreach (var item in collection)
  80. {
  81. if (item == null && AllowNullValue) continue;
  82. var itemString = item?.ToString();
  83. if (!dictHash.Contains(itemString))
  84. return new ValidationResult($"提示:{ErrorMessage}|字典【{DictTypeCode}】不包含【{itemString}】!");
  85. }
  86. return ValidationResult.Success;
  87. }
  88. var valueAsString = value?.ToString();
  89. // 是否忽略空字符串
  90. if (AllowEmptyStrings && string.IsNullOrEmpty(valueAsString)) return ValidationResult.Success;
  91. // 枚举类型验证
  92. if (propertyType.IsEnum)
  93. {
  94. if (!Enum.IsDefined(propertyType, value!)) return new ValidationResult($"提示:{ErrorMessage}|枚举值【{value}】不是有效的【{propertyType.Name}】枚举类型值!");
  95. return ValidationResult.Success;
  96. }
  97. if (!dictHash.Contains(valueAsString)) return new ValidationResult($"提示:{ErrorMessage}|字典【{DictTypeCode}】不包含【{valueAsString}】!");
  98. return ValidationResult.Success;
  99. }
  100. }