C# 基础知识 -- 枚举（Enum）

枚举是一组命名整型常量。枚举类型是使用 enum 关键字声明的。

C# 枚举是值类型。换句话说，枚举包含自己的值，且不能继承或传递继承。

一、枚举的定义

枚举列表中的每个符号代表一个整数值, 一个比它前面的符号大的整数值。默认情况下，第一个枚举符号的值是 0。

public enum Days 
{
   Monday = 0,
   Tuesday,
   Wednesday,
   Thursday = 10,
   Friday,
   Saturday,
   Sunday
}
 
static void Main(string[] args)
{
    Console.WriteLine((int)Days.Tuesday);
    Console.WriteLine((int)Days.Friday);
    Console.ReadLine();
}

枚举中每个元素的基础类型都是int，可以使用冒号指明另一种整数类型。已批准的枚举类型有：byte、sbyte、short、ushort、int、uint、long、ulong

public enum Days : byte
{
    Monday,
    Tuesday,
    Wednesday,
    Thursday,
    Friday,
    Saturday,
    Sunday
}

二、enum、int、string三种类型之间的互转

public enum Gender
{
    男,
    女
}

static void Main(string[] args)
{
    Console.WriteLine("enum ---> int : " + (int)Gender.男);

    Console.WriteLine("enum ---> string : " + Convert.ToString(Gender.男));
    Console.WriteLine("enum ---> string : " + Gender.女.ToString());

    Console.WriteLine("int ---> enum : " + (Gender)0);

    Console.WriteLine("int ---> string : " + Enum.GetName(typeof(Gender), 0));

    Console.WriteLine("string ---> enum :" + Enum.Parse(typeof(Gender), "男"));

    Console.ReadLine();
}

三、循环enum

static void Main(string[] args)
{
    foreach (var gender in Enum.GetValues(typeof(Gender)))
    {
        Console.WriteLine(gender.ToString() + "=" + (int)gender);
    }
    Console.ReadLine();
}

四、获取enum的描述信息

public enum GenderDesc
{
    [Description("male")]
    男,
    [Description("female")]
    女
}

static void Main(string[] args)
{
    Console.WriteLine("女 描述信息 : " + (Description(Gender.女) ?? "null"));
    Console.WriteLine("女 描述信息 : " + (Description(GenderDesc.女) ?? "null"));
    
    Console.ReadLine();
}

/// <summary>
/// 获取枚举值的描述文本
/// </summary>
/// <param name="e">枚举值</param>
/// <returns></returns>
public static string Description(this Enum e)
{
    Type enumType = e.GetType();
    var fieldInfo = enumType.GetFields().FirstOrDefault(a => a.Name == Enum.GetName(enumType, e));
    object[] obj = fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false);
    if (obj == null || obj.Length == 0) return null;

    DescriptionAttribute des = (DescriptionAttribute)obj[0];
    return des.Description;
}

 

五、枚举转换成字典集合的方法

public enum Gender
{
    男,
    女
}

static void Main(string[] args)
{
    Console.WriteLine("int ---> string : " + EnumHelper.GetEnumName<Gender>(1));

    var dic1 = EnumHelper.getEnumDic<Gender>();
    Console.WriteLine("enum ---> dictionary : ");
    foreach (var item in dic1)
    {
        Console.WriteLine(item.Key + "==" + item.Value);
    }

    Console.WriteLine("enum ---> dictionary : ");
    var dic = EnumHelper.GetDic<Gender>();
    foreach (var item in dic)
    {
        Console.WriteLine(item.Key + "==" + item.Value);
    }

    Console.ReadLine();
}

public static class EnumHelper
{
    /// <summary>
    /// 根据枚举的值获取枚举名称
    /// </summary>
    /// <typeparam name="T">枚举类型</typeparam>
    /// <param name="status">枚举的值</param>
    /// <returns></returns>
    public static string GetEnumName<T>(this int status)
    {
        return Enum.GetName(typeof(T), status);
    }
    /// <summary>
    /// 获取枚举名称集合
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <returns></returns>
    public static string[] GetNamesArr<T>()
    {
        return Enum.GetNames(typeof(T));
    }
    /// <summary>
    /// 将枚举转换成字典集合
    /// </summary>
    /// <typeparam name="T">枚举类型</typeparam>
    /// <returns></returns>
    public static Dictionary<string, int> getEnumDic<T>()
    {

        Dictionary<string, int> resultList = new Dictionary<string, int>();
        Type type = typeof(T);
        var strList = GetNamesArr<T>().ToList();
        foreach (string key in strList)
        {
            string val = Enum.Format(type, Enum.Parse(type, key), "d");
            resultList.Add(key, int.Parse(val));
        }
        return resultList;
    }
    /// <summary>
    /// 将枚举转换成字典
    /// </summary>
    /// <typeparam name="TEnum"></typeparam>
    /// <returns></returns>
    public static Dictionary<string, int> GetDic<TEnum>()
    {
        Dictionary<string, int> dic = new Dictionary<string, int>();
        Type t = typeof(TEnum);
        var arr = Enum.GetValues(t);
        foreach (var item in arr)
        {
            dic.Add(item.ToString(), (int)item);
        }

        return dic;
    }
}

五、枚举总结

枚举变量的使用能避免编码时的HardCode, 有效的提升代码的可读性和可扩展性，当然后期的维护也可以方便很多。

六、参考文章

https://www.cnblogs.com/BluceLee/p/8989479.html