SysEnumService.cs 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  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. return enumTypeList.Select(GetEnumDescription).ToList();
  31. }
  32. /// <summary>
  33. /// 获取字典描述
  34. /// </summary>
  35. /// <param name="type"></param>
  36. /// <returns></returns>
  37. private static EnumTypeOutput GetEnumDescription(Type type)
  38. {
  39. string description = type.Name;
  40. var attrs = type.GetCustomAttributes(typeof(DescriptionAttribute), false);
  41. if (attrs.Length != 0)
  42. {
  43. var att = ((DescriptionAttribute[])attrs)[0];
  44. description = att.Description;
  45. }
  46. var enumType = App.EffectiveTypes.FirstOrDefault(t => t.IsEnum && t.Name == type.Name);
  47. return new EnumTypeOutput
  48. {
  49. TypeDescribe = description,
  50. TypeName = type.Name,
  51. TypeRemark = description,
  52. EnumEntities = (enumType ?? type).EnumToList()
  53. };
  54. }
  55. /// <summary>
  56. /// 通过枚举类型获取枚举值集合 🔖
  57. /// </summary>
  58. /// <param name="input"></param>
  59. /// <returns></returns>
  60. [DisplayName("通过枚举类型获取枚举值集合")]
  61. public List<EnumEntity> GetEnumDataList([FromQuery] EnumInput input)
  62. {
  63. var enumType = App.EffectiveTypes.FirstOrDefault(u => u.IsEnum && u.Name == input.EnumName);
  64. if (enumType is not { IsEnum: true }) throw Oops.Oh(ErrorCodeEnum.D1503);
  65. return enumType.EnumToList();
  66. }
  67. /// <summary>
  68. /// 通过实体的字段名获取相关枚举值集合(目前仅支持枚举类型) 🔖
  69. /// </summary>
  70. /// <param name="input"></param>
  71. /// <returns></returns>
  72. [DisplayName("通过实体的字段名获取相关枚举值集合")]
  73. public static List<EnumEntity> GetEnumDataListByField([FromQuery] QueryEnumDataInput input)
  74. {
  75. // 获取实体类型属性
  76. Type entityType = App.EffectiveTypes.FirstOrDefault(u => u.Name == input.EntityName) ?? throw Oops.Oh(ErrorCodeEnum.D1504);
  77. // 获取字段类型
  78. var fieldType = entityType.GetProperties().FirstOrDefault(u => u.Name == input.FieldName)?.PropertyType;
  79. if (fieldType is not { IsEnum: true }) throw Oops.Oh(ErrorCodeEnum.D1503);
  80. return fieldType.EnumToList();
  81. }
  82. }