C# 特性（Attribute）詳解及示例，你學會了嗎？

作者：lyl 2024-05-17 08:42:52

我們將MyCustomAttribute?特性應用于MyClass?類和MyMethod方法，并為每個特性實例提供了一個描述。

在C#中，特性（Attribute）是一種添加到C#代碼的特殊注解，它可以為程序的元素（如類、方法、屬性等）附加某種元數據。這些元數據可以在運行時被讀取，從而影響程序的行為或提供額外的信息。特性在.NET框架中廣泛應用于多個領域，如序列化、Web服務、測試等。

特性的基本概念

特性本質上是一個類，它繼承自System.Attribute。通過創建自定義的特性類，我們可以為代碼元素添加任意的元數據。在C#中，你可以使用方括號[]將特性應用于代碼元素上。

創建自定義特性

下面是一個簡單的自定義特性示例：

using System;

// 自定義一個名為MyCustomAttribute的特性
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false)]
public class MyCustomAttribute : Attribute
{
    public string Description { get; set; }

    public MyCustomAttribute(string description)
    {
        Description = description;
    }
}

在這個例子中，我們定義了一個名為MyCustomAttribute的特性，它有一個Description屬性。AttributeUsage特性用于指定我們的自定義特性可以應用于哪些代碼元素（在這個例子中是類和方法），以及是否允許多個該特性的實例（在這個例子中不允許）。

使用自定義特性

定義了自定義特性之后，我們就可以在代碼中使用它了：

[MyCustomAttribute("這是一個帶有自定義特性的類")]
public class MyClass
{
    [MyCustomAttribute("這是一個帶有自定義特性的方法")]
    public void MyMethod()
    {
        // 方法體...
    }
}

在這個例子中，我們將MyCustomAttribute特性應用于MyClass類和MyMethod方法，并為每個特性實例提供了一個描述。

讀取特性信息

特性的真正價值在于能夠在運行時讀取和使用它們。下面是一個如何讀取上述自定義特性的示例：

using System;
using System.Reflection;

public class Program
{
    public static void Main()
    {
        Type type = typeof(MyClass); // 獲取MyClass的類型信息
        object[] attributes = type.GetCustomAttributes(typeof(MyCustomAttribute), false); // 獲取MyCustomAttribute特性的實例數組
        if (attributes.Length > 0)
        {
            MyCustomAttribute myAttribute = (MyCustomAttribute)attributes[0]; // 轉換到具體的特性類型以訪問其屬性
            Console.WriteLine("類的描述: " + myAttribute.Description); // 輸出類的描述信息
        }
        
        MethodInfo methodInfo = type.GetMethod("MyMethod"); // 獲取MyMethod的方法信息
        attributes = methodInfo.GetCustomAttributes(typeof(MyCustomAttribute), false); // 獲取MyMethod上的MyCustomAttribute特性實例數組
        if (attributes.Length > 0)
        {
            MyCustomAttribute myAttribute = (MyCustomAttribute)attributes[0]; // 轉換到具體的特性類型以訪問其屬性
            Console.WriteLine("方法的描述: " + myAttribute.Description); // 輸出方法的描述信息
        }
    }
}

這個示例程序使用反射來獲取MyClass類和MyMethod方法上的MyCustomAttribute特性，并輸出它們的描述信息。通過這種方式，你可以根據特性的元數據在運行時動態地改變程序的行為。

責任編輯：武曉燕來源：程序員編程日記