C#自定义特性(Attribute)详解

我来详细讲解一下“C#自定义特性(Attribute)详解”的完整攻略。

什么是C#自定义特性(Attribute)

在C#中，特性(Attribute)是一种可用于向类、方法、属性等程序实体添加元数据的语言功能。它可以使得代码更加灵活、可读性更高。

C#自定义特性(Attribute)是程序员用来自定义特性的机制。例如，我们可以自定义自己的Attribute，来标记一个具体的类、方法、属性、字段，或者接口等，还可以在编译时使用这些自定义Attribute，对程序的行为进行更加细致的控制。

如何定义自定义特性(Attribute)

在C#中，定义一个自定义特性(Attribute)，需要使用特性类的定义，并且它应该派生自System.Attribute类或它的派生类。以下是定义一个自定义特性(Attribute)的代码示例：

using System;
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class MyCustomAttribute : Attribute
{
    public MyCustomAttribute() {}

    public string Name { get; set; }
    public object Value { get; set; }

    public override string ToString()
    {
        return $"Name: {Name}, Value: {Value}";
    }

}

在上述代码中，MyCustomAttribute 定义了两个属性 Name 和 Value。其中，AttributeUsage 是使用 Attribute 的一个特殊标记，表示此特性可以被应用到的代码实体上的属性、方法和类上。此处将它应用到类和方法上，并表示可重复使用，可继承。

如何为类和方法添加自定义特性(Attribute)

我们来看一下如何为类和方法添加自定义特性(Attribute)。示例中有一个Person类和一个MakeThisMethodExciting方法需要添加自定义特性(Attribute):

class Person
{
    [MyCustom(Name = "ID", Value = 123456)]
    public int Id { get; set; }

    [MyCustom(Name = "Name", Value = "张三")]
    public string Name { get; set; }
}

class Demo
{
    [MyCustom(Name = "RightNow", Value = "向左转！")]
    public static void MakeThisMethodExciting()
    {
        Console.WriteLine("Hello world");
    }
}

以上代码展示了如何在 Id 和 Name 属性以及 MakeThisMethodExciting 方法上添加 MyCustomAttribute。这里的 Name 和 Value 属性已经在 Attribute 的源代码中定义了。

当一些程序调用 Person 类和 MakeThisMethodExciting 方法时，MyCustomAttribute 输出的信息就会在控制台上输出：

var person = new Person();
Console.WriteLine(person.Id.GetType().CustomAttributes.First()); // output: Name: ID, Value: 123456
Console.WriteLine(person.Name.GetType().CustomAttributes.First()); // output: Name: Name, Value: 张三

typeof(Demo).GetMethod("MakeThisMethodExciting")
                    .CustomAttributes
                    .ToList().ForEach(c => Console.WriteLine(c)); // output: Name: RightNow, Value: 向左转！

总结

在本文中，我们详细讲解了 C# 的自定义特性(Attribute) 的概念、定义、以及添加自定义特性(Attribute)的实现方式，并且通过两个代码示例、一些代码片段和输出信息来帮助读者更好地理解 C# 中自定义特性(Attribute)的用法和机制。