c# 如何自定义特性 attribute

畫卷琴夢

发布时间：2026-01-07 11:28:02

986人浏览过

来源于php中文网

原创

自定义 Attribute 是继承自 System.Attribute 的 public 非泛型非抽象类，需用 [AttributeUsage] 明确目标、允许多例及继承性，提供 public 构造函数（位置参数）和 public 属性（命名参数），并通过反射如 GetCustomAttribute<T>() 读取。

c# 如何自定义特性 attribute

如何定义一个可被反射读取的自定义 Attribute 类

在 C# 中，自定义 Attribute 本质是一个继承自 System.Attribute 的类。它必须是公共的、非泛型、非抽象的，并且通常用 [AttributeUsage] 明确其适用范围和行为。

常见错误是忘记加 [AttributeUsage]，导致编译通过但运行时无法通过反射获取；或把构造函数设为 private，让使用者无法实例化。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] —— 必须显式声明能修饰哪些目标（如类、方法）、是否允许多次使用、是否继承传递
至少提供一个 public 构造函数（参数会成为“位置参数”，用于 [MyAttr("hello")] 这种写法）
额外 public 属性可作为“命名参数”（如 [MyAttr("hello", Level = 2)]）
不要在构造函数里做耗时或可能抛异常的操作——特性实例化发生在编译期元数据写入阶段，运行时才读取，但构造逻辑仍需安全

using System;
<p>[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
public class LoggableAttribute : Attribute
{
public string Category { get; }
public int Priority { get; set; } = 1;</p><pre class='brush:php;toolbar:false;'>public LoggableAttribute(string category)
{
    Category = category ?? throw new ArgumentNullException(nameof(category));
}

}

如何在代码中应用并读取自定义 Attribute

应用很简单：[Loggable("API")] 直接写在类或方法上。读取则依赖反射——注意：默认不会自动加载程序集中的所有类型，你得明确拿到 Type 或 MethodInfo 对象再查。

容易踩的坑是调用 GetCustomAttribute<T>() 时没处理 null 返回，或误用 GetCustomAttributes(true) 在非继承场景下多传了参数。

Glimmer Ai

基于GPT-3和DALL·E2的PPT制作工具

下载

用 typeof(MyClass).GetCustomAttribute<LoggableAttribute>() 获取单个实例（返回 null 表示没找到）
用 methodInfo.GetCustomAttributes<LoggableAttribute>() 获取所有匹配实例（返回 LoggableAttribute[]）
第 2 个参数 inherit（如 GetCustomAttribute<T>(true)）只在基类/接口上有该特性且当前类型未重写时才生效，多数业务场景保持默认 false 更可控
若特性有 AllowMultiple = true，别用单值获取方法，否则只拿到第一个

var attr = typeof(Program).GetCustomAttribute<LoggableAttribute>();
if (attr != null)
{
    Console.WriteLine($"{attr.Category}, Priority: {attr.Priority}");
}
<p>// 方法上的多个实例
var method = typeof(Program).GetMethod("DoWork");
var attrs = method?.GetCustomAttributes<LoggableAttribute>().ToArray();
foreach (var a in attrs)
{
Console.WriteLine($"Method attr: {a.Category}");
}

为什么 GetCustomAttribute 返回 null？常见排查点

不是代码写错了，而是反射读取失败的几个高频原因：特性类没加 public、目标元素没实际应用该特性、反射查询路径不对（比如查了父类却忘了 Inherited = true），或者用了不匹配的泛型类型参数。

确认特性类本身是 public class XxxAttribute : Attribute，不能是 internal 或嵌套在其他类里（除非宿主类也是 public）
确认你查的是正确对象：类特性查 typeof(X).GetCustomAttribute<>()，方法特性查 typeof(X).GetMethod("Y").GetCustomAttribute<>()
如果特性定义了 Inherited = false，子类即使没重复标注也不会从基类继承过来
确保程序集已加载——动态编译或插件场景下，Assembly.LoadFrom() 后再查，别查当前 Assembly.GetExecutingAssembly() 以外的类型却不加载
泛型参数必须完全一致：比如定义的是 MyAttr<string>，就不能用 GetCustomAttribute<MyAttr>() 去拿