C#枚举类型扩展：提升开发效率的实用技巧

阿蒙Armon

已于 2025-07-07 14:52:41 修改

阅读量1k

点赞数 24

CC 4.0 BY-SA版权

分类专栏： C#工作中的应用文章标签： c#

于 2024-07-24 18:08:41 首次发布

本文链接：https://blog.youkuaiyun.com/huyu107/article/details/140669885

C#工作中的应用专栏收录该内容

28 篇文章

订阅专栏

C#枚举类型扩展：提升开发效率的实用技巧

在 C# 开发中，枚举类型（Enum）是一种极为常用的数据类型，它由基础整型数值类型的一组命名常量定义，属于值类型。不过，C# 对枚举类型的原生支持存在一定局限性，在实际开发中，我们常常需要对其进行扩展以满足多样化的需求。本文将为你详细介绍如何对 C# 枚举类型进行扩展，以及相关实用方法的实现。

枚举类型（Enum）简介

枚举类型为我们提供了一种简洁且直观的方式来表示一组相关的常量。例如，在处理日期相关的逻辑时，我们可以使用枚举来表示一周的七天：

using System.ComponentModel;

public enum Week
{
    [Description("星期日")]
    Sunday,
    [Description("星期一")]
    Monday,
    [Description("星期二")]
    Tuesday,
    [Description("星期三")]
    Wednesday,
    [Description("星期四")]
    Thursday,
    [Description("星期五")]
    Friday,
    [Description("星期六")]
    Saturday,
}

在上述代码中，我们使用了 Description 特性为每个枚举值添加了中文描述。这样做的好处是，在需要向用户展示枚举值时，我们可以使用更友好的中文描述，而不是直接显示枚举的名称。

常用功能扩展

获取枚举描述

在很多应用场景中，我们需要获取枚举值的描述信息，尤其是在构建中文界面时，使用描述代替枚举值进行显示会让界面更加友好。下面是实现该功能的代码：

using System;
using System.ComponentModel;
using System.Linq;

public static class EnumExtensions
{
    /// <summary>
    /// 获取 Enum 描述
    /// </summary>
    /// <param name="e">Enum 实例</param>
    /// <returns>Enum 描述</returns>
    public static string GetDescription(this Enum e)
    {
        var field = e.GetType().GetField(e.ToString());
        if (field == null)
        {
            return e.ToString();
        }
        var attributes = field.GetCustomAttributes(typeof(DescriptionAttribute), false);
        return attributes.OfType<DescriptionAttribute>().FirstOrDefault()?.Description ?? e.ToString();
    }
}

在这段代码中，我们定义了一个扩展方法 GetDescription，它接收一个 Enum 类型的实例作为参数。首先，我们通过 GetType().GetField(e.ToString()) 获取枚举值对应的字段信息。然后，使用 GetCustomAttributes 方法获取该字段上的 DescriptionAttribute 特性。如果找到了该特性，则返回其 Description 属性值；否则，返回枚举值的名称。

获取值和描述列表

有时候，我们需要获取枚举类型中所有值及其对应的描述信息，这可以通过以下方法实现：

/// <summary>
/// 获取 Enum 值和描述列表
/// </summary>
public static Dictionary<int, string> GetValuesAndDescriptions(Type type)
{
    if (!type.IsEnum)
    {
        throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
    }
    return type.GetFields().Where(f => f.IsStatic).ToDictionary(
        f => (int)Enum.Parse(type, f.Name),
        f => (f.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute)?.Description ?? f.Name
    );
}

在这个方法中，我们首先检查传入的类型是否为枚举类型，如果不是，则抛出异常。然后，使用 GetFields 方法获取枚举类型的所有字段，并筛选出静态字段。接着，使用 ToDictionary 方法将每个字段的整数值和对应的描述信息存储在一个字典中返回。

获取名称和描述列表

除了获取值和描述列表，我们还可能需要获取枚举名称和描述的对应关系，以下是实现该功能的代码：

/// <summary>
/// 获取 Enum 名称和描述列表
/// </summary>
public static Dictionary<string, string> GetNamesAndDescriptions(Type type)
{
    if (!type.IsEnum)
    {
        throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
    }
    return type.GetFields().Where(f => f.IsStatic).ToDictionary(
        f => f.Name,
        f => (f.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute)?.Description ?? f.Name
    );
}

该方法的实现思路与 GetValuesAndDescriptions 类似，只是将字典的键从枚举的整数值改为了枚举的名称。

获取名称和值列表

在某些情况下，我们可能需要获取枚举名称和对应整数值的列表，以下是实现该功能的代码：

/// <summary>
/// 获取 Enum 名称和值列表
/// </summary>
public static Dictionary<string, int> GetNamesAndValues(Type type)
{
    if (!type.IsEnum)
    {
        throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
    }
    return type.GetFields().Where(f => f.IsStatic).ToDictionary(
        f => f.Name,
        f => (int)Enum.Parse(type, f.Name)
    );
}

该方法同样会先检查传入的类型是否为枚举类型，然后将枚举的名称和对应的整数值存储在一个字典中返回。

获取描述列表

最后，我们还可以实现一个方法来获取枚举类型中所有描述信息的列表：

/// <summary>
/// 获取 Enum 描述列表
/// </summary>
public static List<string> GetDescriptions(Type type)
{
    if (!type.IsEnum)
    {
        throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
    }
    return type.GetFields()
        .Select(p => p.GetCustomAttribute(typeof(DescriptionAttribute)))
        .Select(p => p as DescriptionAttribute)
        .Where(p => p != null)
        .Select(p => p.Description)
        .ToList();
}

在这个方法中，我们首先筛选出具有 DescriptionAttribute 特性的字段，然后提取出每个特性的 Description 属性值，并将其存储在一个列表中返回。

完整代码

以下是包含上述所有扩展方法的完整代码：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;

public static class EnumExtensions
{
    /// <summary>
    /// 获取 Enum 描述
    /// </summary>
    /// <param name="e">Enum 实例</param>
    /// <returns>Enum 描述</returns>
    public static string GetDescription(this Enum e)
    {
        var field = e.GetType().GetField(e.ToString());
        if (field == null)
        {
            return e.ToString();
        }
        var attributes = field.GetCustomAttributes(typeof(DescriptionAttribute), false);
        return attributes.OfType<DescriptionAttribute>().FirstOrDefault()?.Description ?? e.ToString();
    }

    /// <summary>
    /// 获取 Enum 值和描述列表
    /// </summary>
    public static Dictionary<int, string> GetValuesAndDescriptions(Type type)
    {
        if (!type.IsEnum)
        {
            throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
        }
        return type.GetFields().Where(f => f.IsStatic).ToDictionary(
            f => (int)Enum.Parse(type, f.Name),
            f => (f.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute)?.Description ?? f.Name
        );
    }

    /// <summary>
    /// 获取 Enum 名称和描述列表
    /// </summary>
    public static Dictionary<string, string> GetNamesAndDescriptions(Type type)
    {
        if (!type.IsEnum)
        {
            throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
        }
        return type.GetFields().Where(f => f.IsStatic).ToDictionary(
            f => f.Name,
            f => (f.GetCustomAttribute(typeof(DescriptionAttribute)) as DescriptionAttribute)?.Description ?? f.Name
        );
    }

    /// <summary>
    /// 获取 Enum 名称和值列表
    /// </summary>
    public static Dictionary<string, int> GetNamesAndValues(Type type)
    {
        if (!type.IsEnum)
        {
            throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
        }
        return type.GetFields().Where(f => f.IsStatic).ToDictionary(
            f => f.Name,
            f => (int)Enum.Parse(type, f.Name)
        );
    }

    /// <summary>
    /// 获取 Enum 描述列表
    /// </summary>
    public static List<string> GetDescriptions(Type type)
    {
        if (!type.IsEnum)
        {
            throw new ArgumentException("传入的类型必须是枚举类型", nameof(type));
        }
        return type.GetFields()
            .Select(p => p.GetCustomAttribute(typeof(DescriptionAttribute)))
            .Select(p => p as DescriptionAttribute)
            .Where(p => p != null)
            .Select(p => p.Description)
            .ToList();
    }
}

使用示例

以下是如何使用这些扩展方法的示例：

class Program
{
    static void Main()
    {
        // 获取单个枚举值的描述
        Week day = Week.Monday;
        string description = day.GetDescription();
        Console.WriteLine($"枚举值 {day} 的描述是: {description}");

        // 获取枚举值和描述列表
        var valuesAndDescriptions = EnumExtensions.GetValuesAndDescriptions(typeof(Week));
        foreach (var pair in valuesAndDescriptions)
        {
            Console.WriteLine($"值: {pair.Key}, 描述: {pair.Value}");
        }

        // 获取枚举名称和描述列表
        var namesAndDescriptions = EnumExtensions.GetNamesAndDescriptions(typeof(Week));
        foreach (var pair in namesAndDescriptions)
        {
            Console.WriteLine($"名称: {pair.Key}, 描述: {pair.Value}");
        }

        // 获取枚举名称和值列表
        var namesAndValues = EnumExtensions.GetNamesAndValues(typeof(Week));
        foreach (var pair in namesAndValues)
        {
            Console.WriteLine($"名称: {pair.Key}, 值: {pair.Value}");
        }

        // 获取枚举描述列表
        var descriptions = EnumExtensions.GetDescriptions(typeof(Week));
        foreach (var desc in descriptions)
        {
            Console.WriteLine($"描述: {desc}");
        }
    }
}