SysEnumService.cs 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Core.Service;
  7. /// <summary>
  8. /// 系统枚举服务 🧩
  9. /// </summary>
  10. [ApiDescriptionSettings(Order = 275)]
  11. public class SysEnumService : IDynamicApiController, ITransient
  12. {
  13. private readonly EnumOptions _enumOptions;
  14. public SysEnumService(IOptions<EnumOptions> enumOptions)
  15. {
  16. _enumOptions = enumOptions.Value;
  17. }
  18. /// <summary>
  19. /// 获取所有枚举类型 🔖
  20. /// </summary>
  21. /// <returns></returns>
  22. [DisplayName("获取所有枚举类型")]
  23. public List<EnumTypeOutput> GetEnumTypeList()
  24. {
  25. var enumTypeList = App.EffectiveTypes.Where(t => t.IsEnum)
  26. .Where(t => _enumOptions.EntityAssemblyNames.Contains(t.Assembly.GetName().Name) || _enumOptions.EntityAssemblyNames.Any(name => t.Assembly.GetName().Name!.Contains(name)))
  27. .Where(t => t.GetCustomAttributes(typeof(ErrorCodeTypeAttribute), false).Length == 0) // 排除错误代码类型
  28. .OrderBy(u => u.Name).ThenBy(u => u.FullName)
  29. .ToList();
  30. // 如果存在同名枚举类,则依次增加 "_序号" 后缀
  31. var list = enumTypeList.Select(GetEnumDescription).ToList();
  32. foreach (var enumType in list.GroupBy(u => u.TypeName).Where(g => g.Count() > 1))
  33. {
  34. int i = 1;
  35. foreach (var item in list.Where(u => u.TypeName == enumType.Key).Skip(1)) item.TypeName = $"{item.TypeName}_{i++}";
  36. }
  37. return list;
  38. }
  39. /// <summary>
  40. /// 获取字典描述
  41. /// </summary>
  42. /// <param name="type"></param>
  43. /// <returns></returns>
  44. private static EnumTypeOutput GetEnumDescription(Type type)
  45. {
  46. string description = type.Name;
  47. var attrs = type.GetCustomAttributes(typeof(DescriptionAttribute), false);
  48. if (attrs.Length != 0)
  49. {
  50. var att = ((DescriptionAttribute[])attrs)[0];
  51. description = att.Description;
  52. }
  53. var enumType = App.EffectiveTypes.FirstOrDefault(t => t.IsEnum && t.Name == type.Name);
  54. return new EnumTypeOutput
  55. {
  56. TypeDescribe = description,
  57. TypeName = type.Name,
  58. TypeRemark = description,
  59. TypeFullName = type.FullName,
  60. EnumEntities = (enumType ?? type).EnumToList()
  61. };
  62. }
  63. /// <summary>
  64. /// 通过枚举类型获取枚举值集合 🔖
  65. /// </summary>
  66. /// <param name="input"></param>
  67. /// <returns></returns>
  68. [DisplayName("通过枚举类型获取枚举值集合")]
  69. public List<EnumEntity> GetEnumDataList([FromQuery] EnumInput input)
  70. {
  71. var enumType = App.EffectiveTypes.FirstOrDefault(u => u.IsEnum && u.Name == input.EnumName);
  72. if (enumType is not { IsEnum: true }) throw Oops.Oh(ErrorCodeEnum.D1503);
  73. return enumType.EnumToList();
  74. }
  75. /// <summary>
  76. /// 通过实体的字段名获取相关枚举值集合(目前仅支持枚举类型) 🔖
  77. /// </summary>
  78. /// <param name="input"></param>
  79. /// <returns></returns>
  80. [DisplayName("通过实体的字段名获取相关枚举值集合")]
  81. public static List<EnumEntity> GetEnumDataListByField([FromQuery] QueryEnumDataInput input)
  82. {
  83. // 获取实体类型属性
  84. Type entityType = App.EffectiveTypes.FirstOrDefault(u => u.Name == input.EntityName) ?? throw Oops.Oh(ErrorCodeEnum.D1504);
  85. // 获取字段类型
  86. var fieldType = entityType.GetProperties().FirstOrDefault(u => u.Name == input.FieldName)?.PropertyType;
  87. if (fieldType is not { IsEnum: true }) throw Oops.Oh(ErrorCodeEnum.D1503);
  88. return fieldType.EnumToList();
  89. }
  90. }