15 反射和自定义特性之自定义特性的创建与使用

在上一篇中，我们探讨了如何使用反射获取类型信息。反射是一种非常强大的功能，允许我们在运行时检查类型、方法、属性等。而在反射的强大之上，自定义特性（Attributes）则为我们提供了一种能够为类型、方法、属性等提供元数据的方式。这一篇将着重于如何创建和使用自定义特性，帮助我们更好地利用反射进行编程。

自定义特性的创建

自定义特性的定义

在 C# 中，我们创建自定义特性非常简单，只需定义一个类，并从 System.Attribute 基类继承。在类定义中，我们可以使用构造函数以及属性以便传递额外的信息。

下面是一个简单的自定义特性的示例，它用于描述一个方法的开发者和创建日期：

using System;

[AttributeUsage(AttributeTargets.Method)]
public class DeveloperInfoAttribute : Attribute
{
    public string Developer { get; }
    public string Date { get; }

    public DeveloperInfoAttribute(string developer, string date)
    {
        Developer = developer;
        Date = date;
    }
}

在上面的代码中，我们使用了 AttributeUsage 特性来指定这个自定义特性只能应用于方法上。DeveloperInfoAttribute 特性有两个只读属性：Developer 和 Date。

应用自定义特性

自定义特性的定义完成后，我们就可以在方法上使用这个特性。下面是一个示例：

public class SampleClass
{
    [DeveloperInfo("Alice", "2023-01-01")]
    public void SampleMethod()
    {
        Console.WriteLine("Sample Method Executed.");
    }
}

在这个示例中，SampleMethod 上应用了我们刚刚创建的 DeveloperInfoAttribute 特性。在特性中，我们指定了开发者的名字和日期。

通过反射获取自定义特性信息

现在我们来看看如何使用反射来获取这些自定义特性的信息。我们可以通过获取类型的MethodInfo和使用 GetCustomAttributes 方法来实现这一点。

以下是示例代码：

using System;
using System.Reflection;

class Program
{
    static void Main(string[] args)
    {
        // 获取SampleClass类型
        Type sampleType = typeof(SampleClass);
        // 获取SampleMethod方法的信息
        MethodInfo methodInfo = sampleType.GetMethod("SampleMethod");

        // 获取自定义特性
        DeveloperInfoAttribute attribute = (DeveloperInfoAttribute)Attribute.GetCustomAttribute(methodInfo, typeof(DeveloperInfoAttribute));
        if (attribute != null)
        {
            Console.WriteLine($"Developer: {attribute.Developer}, Date: {attribute.Date}");
        }
    }
}

运行以上代码，你将看到输出：

Developer: Alice, Date: 2023-01-01

在这个示例中，我们使用 GetMethod 方法获取了 SampleMethod 的 MethodInfo，再用 Attribute.GetCustomAttribute() 来获取特性信息，并最终输出相关信息。

小结

通过这篇文章，我们学习了如何创建和使用自定义特性，并结合反射来获取这些特性的元数据。自定义特性为我们的代码提供了丰富的元数据，从而在后续程序执行中可以利用反射进行动态操作，从而提高了程序的灵活性。在后面的篇幅中，我们将探讨内存管理和垃圾回收的基础知识，为理解 C# 的运行时环境奠定基础。