C# 添加枚举中文资源

在业务开发过程中，添加枚举，在固定枚举值的同时，也需要中文的文案。

如果不想添加语言资源项、添加枚举转语资源项，可以使用特性标记。

属性描述 DescriptionAttribute

先看案例：

    public enum WheelchairDataType
    {
        [Description("前进加速")]
        ForwardAdd,
        [Description("前进减速")]
        ForwardReduce,
        [Description("后退加速")]
        BackwardAdd,
        [Description("后退减速")]
        BackwardReduce,
        [Description("转弯加速")]
        TurningAdd,
        [Description("转弯减速")]
        TurningReduce
    }

    static void Main(string[] args)
    {
        var enumDescriptionDict = GetEnumDescriptionDict(WheelchairDataType.BackwardAdd.GetType());
        var enumDescription = enumDescriptionDict[WheelchairDataType.BackwardAdd.ToString()];
        Console.WriteLine($"{ WheelchairDataType.BackwardAdd.ToString()}:{enumDescription}");
        Console.ReadLine();
    }

以上，能够直接获取到枚举的描述值。所以我们可以用Description标记，取代我们经常要对枚举添加的中文注释，既是注释也是一种简便的语言项资源。

 

DescriptionAttribute继承自Attribute，所以枚举的中文标记值，可以通过反射获取：

        /// <summary>
        /// 获取枚举/中文字典
        /// </summary>
        /// <param name="enumType"></param>
        /// <returns></returns>
        public static Dictionary<string, string> GetEnumDescriptionDict(Type enumType)
        {
            Dictionary<string, string> dict = new Dictionary<string, string>();
            FieldInfo[] fields = enumType.GetFields();
            foreach (FieldInfo field in fields)
            {
                if (field.FieldType.IsEnum)
                {
                    var customAttributes = field.GetCustomAttributes(typeof(DescriptionAttribute), false).ToList();
                    dict.Add(field.Name, ((DescriptionAttribute)customAttributes[0]).Description);
                }
            }

            return dict;
        }

 

自定义枚举的描述标记EnumDetailAttribute

如果不想用DescriptionAttribute，或者需要额外的描述信息，可以自定义一个标记。比如：

    public class EnumDetailAttribute : Attribute
    {
        public string Name { get; set; }

        public int SpecialOrder { get; set; }
    }

    public enum WheelchairDataType
    {
        [EnumDetail(Name = "前进加速")]
        ForwardAdd,
        [EnumDetail(Name = "前进减速")]
        ForwardReduce,
        [EnumDetail(Name = "后退加速")]
        BackwardAdd,
        [EnumDetail(Name = "后退减速")]
        BackwardReduce,
        [EnumDetail(Name = "转弯加速")]
        TurningAdd,
        [EnumDetail(Name = "转弯减速")]
        TurningReduce
    }

    static void Main(string[] args)
    {
        Console.WriteLine($"{ WheelchairDataType.BackwardAdd.ToString()}:{ WheelchairDataType.BackwardAdd.GetName()}");
        Console.ReadLine();
    }

枚举的描述值获取：

    public static class EnumExtensions
    {
        /// <summary>
        /// 获取枚举/中文字典
        /// </summary>
        /// <param name="enumValue"></param>
        /// <returns></returns>
        public static Dictionary<string, string> GetEnumDict<TEnum>(this TEnum enumValue) where TEnum : struct
        {
            Type type = enumValue.GetType();

            Dictionary<string, string> dict = new Dictionary<string, string>();
            FieldInfo[] fields = type.GetFields();
            foreach (FieldInfo field in fields)
            {
                if (field.FieldType.IsEnum)
                {
                    var customAttributes = field.GetCustomAttributes(typeof(EnumDetailAttribute), false).ToList();
                    dict.Add(field.Name, ((EnumDetailAttribute)customAttributes[0]).Name);
                }
            }

            return dict;
        }
        /// <summary>
        /// 获取枚举描述特性值
        /// </summary>
        /// <typeparam name="TEnum"></typeparam>
        /// <param name="enumValue">枚举值</param>
        /// <returns>枚举值的描述</returns>
        public static string GetName<TEnum>(this TEnum enumValue) where TEnum : struct
        {
            Type type = enumValue.GetType();
            //枚举的成员信息
            foreach (var memberInfo in type.GetMembers())
            {
                if (memberInfo.Name != enumValue.ToString()) continue;
                //获取自定义标记
                foreach (Attribute attr in memberInfo.GetCustomAttributes(typeof(EnumDetailAttribute), false))
                {
                    var attribute = attr as EnumDetailAttribute;
                    if (attribute == null) continue;
                    return attribute.Name;
                }
            }
            return string.Empty;
        }
    }