C#的Attribute类是用来做什么的？如何自定义特性？

煙雲

发布时间：2025-09-11 09:45:01

901人浏览过

来源于php中文网

原创

Attribute是C#中用于为代码添加元数据的机制，可应用于类型或成员以提供额外信息而不改变逻辑。2. 其主要使用场景包括序列化控制、ORM映射、数据验证、代码生成、文档生成及AOP等。3. 自定义Attribute需继承System.Attribute类，并通过AttributeUsage指定可应用的目标。4. 可通过构造函数传递参数，定义属性提供附加信息。5. 应用自定义Attribute后，使用反射（如Attribute.GetCustomAttribute）读取其值。6. 由于反射性能开销较大，频繁使用时应考虑缓存或编译时代码生成优化。7. Attribute与接口不同：接口定义行为契约并影响类型继承体系，Attribute仅描述特征且不影响类型。8. 适合在需动态配置、扩展元数据或实现切面编程时使用Attribute，但应权衡性能影响。

c#的attribute类是用来做什么的？如何自定义特性？

C#的Attribute类主要用于为程序中的类型（类、结构体、枚举、接口、委托等）、成员（字段、属性、方法、事件等）添加元数据。你可以把它想象成贴在代码上的标签，这些标签本身不执行任何操作，但可以被编译器、运行时环境或其他工具读取，从而影响程序的行为或提供额外的信息。自定义特性允许你扩展C#的元数据能力，根据自己的需求添加特定类型的标签。

Attribute用于添加元数据，自定义特性则用于扩展元数据能力。

为什么要使用Attribute？

Attribute的使用场景非常广泛，例如：

序列化/反序列化: 控制哪些字段应该被序列化，以及如何序列化。
ORM框架: 将类映射到数据库表，字段映射到列。
验证: 定义数据验证规则，例如字符串长度、范围等。
代码生成: 指导代码生成器生成特定的代码。
文档生成: 提供用于生成文档的额外信息。
AOP (面向切面编程): 在方法执行前后插入额外的逻辑，例如日志记录、性能监控等。

简单来说，Attribute让你可以在不修改代码逻辑的情况下，改变代码的行为或提供额外的信息。这种方式可以提高代码的可维护性、可扩展性和灵活性。

如何自定义Attribute？

自定义Attribute其实很简单，只需要创建一个继承自

System.Attribute

的类，并使用

AttributeUsage

特性来指定该Attribute可以应用的目标类型。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public class MyCustomAttribute : Attribute
{
    private string _description;

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

    public string Description
    {
        get { return _description; }
    }

    public string AdditionalInfo { get; set; } // 可选属性
}

```
AttributeUsage
```
：这个特性控制了自定义特性如何被使用。
- ```
AttributeTargets.Class | AttributeTargets.Method
```
  ：指定该特性可以应用到类和方法上。
- ```
AllowMultiple = false
```
  ：指定该特性在一个目标上只能应用一次。
- ```
Inherited = true
```
  ：指定该特性可以被子类继承。
```
MyCustomAttribute
```
：自定义特性的类名，通常以"Attribute"结尾，但使用时可以省略。
构造函数：用于传递Attribute的参数。
```
Description
```
：一个只读属性，用于获取Attribute的描述信息。
```
AdditionalInfo
```
：一个可选属性，可以在应用Attribute时设置。

如何应用和读取自定义Attribute？

定义好Attribute后，就可以将其应用到代码中。

[MyCustom("This is a class description.", AdditionalInfo = "Some extra info")]
public class MyClass
{
    [MyCustom("This is a method description.")]
    public void MyMethod()
    {
        // ...
    }
}

读取Attribute需要使用反射。

磁力开创

快手推出的一站式AI视频生产平台

下载

Type type = typeof(MyClass);
MyCustomAttribute classAttribute = (MyCustomAttribute)Attribute.GetCustomAttribute(type, typeof(MyCustomAttribute));

if (classAttribute != null)
{
    Console.WriteLine($"Class Description: {classAttribute.Description}");
    Console.WriteLine($"Class Additional Info: {classAttribute.AdditionalInfo}");
}

MethodInfo methodInfo = type.GetMethod("MyMethod");
MyCustomAttribute methodAttribute = (MyCustomAttribute)Attribute.GetCustomAttribute(methodInfo, typeof(MyCustomAttribute));

if (methodAttribute != null)
{
    Console.WriteLine($"Method Description: {methodAttribute.Description}");
}

这段代码首先获取

MyClass

的类型信息，然后使用

Attribute.GetCustomAttribute

方法获取应用到类上的

MyCustomAttribute

实例。如果Attribute存在，就可以读取其属性值。同样的方法也可以用于读取应用到方法上的Attribute。

Attribute的性能考量

虽然Attribute非常有用，但在大量使用时需要注意性能问题。因为读取Attribute通常需要使用反射，而反射的性能相对较低。因此，应该避免在性能敏感的代码中频繁读取Attribute。可以考虑将Attribute的信息缓存起来，或者在编译时使用代码生成技术来避免运行时反射。

Attribute与接口的区别

Attribute和接口虽然都可以用于扩展类型的信息，但它们的作用和使用方式有很大的区别。

接口: 定义了一组必须实现的方法和属性。类必须实现接口才能被认为是该接口的类型。接口主要用于实现多态和代码复用。
Attribute: 提供元数据，用于描述类型的特征或行为。类不需要实现Attribute。Attribute主要用于提供额外的信息，可以被编译器、运行时环境或其他工具读取。

简单来说，接口定义了类的行为，而Attribute描述了类的特征。接口影响类的类型，而Attribute不影响。