深入理解C#特性（Attribute）

什么是C#特性（Attribute）？

C#特性是一种声明式标签，用于向程序元素（如类、方法、字段、参数等）添加元数据。这些元数据不会直接影响程序逻辑，但可以在运行时被读取，从而实现如验证、日志记录、序列化控制等功能。

例如，你可能已经见过这样的代码：

[Serializable]public class Person{    public string Name { get; set; }}

这里的 [Serializable] 就是一个内置的C#特性，它告诉 .NET 运行时该类可以被序列化。

如何自定义Attribute？

要创建一个自定义特性，你需要定义一个继承自 System.Attribute 的类。下面是一个简单的例子：为方法添加“作者信息”特性的需求。

using System;// 自定义特性：AuthorInfo[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]public class AuthorInfoAttribute : Attribute{    public string AuthorName { get; }    public string Version { get; }    public AuthorInfoAttribute(string authorName)    {        AuthorName = authorName;        Version = "1.0"; // 默认版本    }    public AuthorInfoAttribute(string authorName, string version)    {        AuthorName = authorName;        Version = version;    }}

关键点说明：

• [AttributeUsage] 是一个元特性，用于指定你的自定义特性可以应用在哪些程序元素上（如方法、类、属性等）。
• AllowMultiple = false 表示同一个元素上不能重复使用该特性。
• 特性类必须继承自 System.Attribute。
• 构造函数用于传入必要参数，属性用于存储数据。

使用自定义Attribute

定义好特性后，就可以像使用内置特性一样将其应用到代码中：

public class Calculator{    [AuthorInfo("张三")]    public int Add(int a, int b)    {        return a + b;    }    [AuthorInfo("李四", "2.1")]    public double Divide(double a, double b)    {        return a / b;    }}

如何解析（读取）自定义Attribute？

要读取附加在代码元素上的特性，我们需要使用C#反射。以下是如何在运行时获取方法上的 AuthorInfoAttribute 信息：

using System;using System.Reflection;public class Program{    public static void Main()    {        Type type = typeof(Calculator);        MethodInfo[] methods = type.GetMethods();        foreach (var method in methods)        {            // 获取方法上的 AuthorInfo 特性            var authorAttr = method.GetCustomAttribute<AuthorInfoAttribute>();            if (authorAttr != null)            {                Console.WriteLine($"方法: {method.Name}");                Console.WriteLine($"作者: {authorAttr.AuthorName}");                Console.WriteLine($"版本: {authorAttr.Version}\n");            }        }    }}

运行结果将输出：

方法: Add作者: 张三版本: 1.0方法: Divide作者: 李四版本: 2.1

实际应用场景

自定义特性在实际开发中有广泛用途，例如：

• 数据验证：如 ASP.NET Core 中的 [Required]、[StringLength] 等。
• API文档生成：Swagger 使用特性描述接口参数和返回值。
• 权限控制：通过特性标记需要特定角色才能访问的方法。
• 日志记录：自动记录带有特定特性的方法调用。

总结

通过本教程，你已经掌握了如何在C#中自定义Attribute以及如何使用反射来解析这些元数据。这种元数据编程方式让代码更加灵活、可维护，并能实现声明式的编程风格。无论你是初学者还是有经验的开发者，理解和运用C#特性都将大大提升你的编程能力。

关键词回顾：C#特性、自定义Attribute、C#反射、元数据编程。