C#中用于控制自定义特性（Attribute）

news2025/6/10 10:06:33

我们来详细解释一下 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)] 这个 C# 属性。
在 C# 中，Attribute（特性）是一种用于向程序元素（如类、方法、属性等）添加元数据的机制。AttributeUsage 是一个特殊的、用于定义其他自定义特性如何被使用的元特性。
让我们分解 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]：

[AttributeUsage(...)]:
- 这是一个元特性，它被应用到一个自定义特性的定义上。
- 它的作用是告诉编译器和开发人员，这个自定义特性应该如何被使用，以及有哪些限制。
AttributeTargets.Class:
- 这是 AttributeUsage 构造函数的第一个参数，类型是 AttributeTargets。
- AttributeTargets 是一个枚举类型，它定义了一系列的值，代表程序中的不同元素类型，例如类、结构、方法、属性、字段等。
- AttributeTargets.Class 指定了这个自定义特性只能被应用在类上。
- 如果你想让特性可以应用在多个类型上，可以使用按位或运算符 | 来组合，例如 AttributeTargets.Class | AttributeTargets.Struct 表示可以应用在类或结构上。
AllowMultiple = false:
- 这是 AttributeUsage 构造函数的第二个参数（或者通过属性名称指定）。
- 它是一个布尔值，控制是否允许同一个目标元素上应用多个相同类型的自定义特性。
- false 表示不允许。一个类上只能有一个这种类型的特性。
- true 表示允许。一个类上可以有多个这种类型的特性（例如，一个方法可以有多个 [Obsolete] 特性，每个特性可以带有不同的消息）。
Inherited = false:
- 这是 AttributeUsage 构造函数的第三个参数（或者通过属性名称指定）。
- 它是一个布尔值，控制这个自定义特性是否会被继承。
- false 表示不继承。如果这个特性被应用在一个基类上，那么派生类不会自动拥有这个特性。
- true 表示继承。如果这个特性被应用在一个基类上，那么派生类会自动继承这个特性（默认值就是 true）。
  总结表格

举例说明
假设我们定义一个自定义特性 [DeveloperInfo]，用于标记类的开发者信息，并且我们希望：

这个特性只能用在类上。
一个类上只能有一个 [DeveloperInfo] 特性。
这个特性不会被派生类继承。
那么我们可以这样定义它：

// 定义自定义特性 DeveloperInfo
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class DeveloperInfoAttribute : Attribute
{
    public string Name { get; }
    public string Date { get; }
    public DeveloperInfoAttribute(string name, string date)
    {
        Name = name;
        Date = date;
    }
}

现在，我们使用这个特性：

// 应用特性
[DeveloperInfo("张三", "2023-10-27")]
public class MyImportantClass
{
    // 类的实现
    public void DoSomething() { }
}
// 尝试在同一个类上应用第二个 DeveloperInfo 特性 - 编译错误！
// [DeveloperInfo("李四", "2023-10-28")] // 因为 AllowMultiple = false
// public class AnotherClass { } // 这行代码本身没问题，但上面这行会出错
// 尝试在方法上应用 - 编译错误！
// [DeveloperInfo("王五", "2023-10-29")]
// public void SomeMethod() { } // 因为 AttributeTargets 只指定了 Class
// 派生类不会继承基类的 DeveloperInfo 特性
public class DerivedClass : MyImportantClass
{
    // 这个类上没有 DeveloperInfo 特性，即使基类 MyImportantClass 有
    public void DoAnotherThing() { }
}

另一个例子：允许重复且可继承的特性
假设我们定义一个 [Tag] 特性，用于给类打标签，一个类可以有多个标签，并且这些标签会被派生类继承。

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public class TagAttribute : Attribute
{
    public string TagName { get; }
    public TagAttribute(string tagName)
    {
        TagName = tagName;
    }
}
// 应用特性
[Tag("Utility")]
[Tag("Helper")]
[Tag("Core")]
public class UtilityClass
{
    // ...
}
// 派生类会继承基类的 Tag 特性
public class AdvancedUtilityClass : UtilityClass
{
    // 这个类自动拥有了 "Utility", "Helper", "Core" 三个标签
    // 也可以添加自己的标签
    [Tag("Advanced")]
    // ...
}