C# 如何自定义特性(Attribute) – 元数据编程的强大功能

13次阅读

自定义特性是 C# 中继承 Attribute 类、用 AttributeUsage 声明使用范围的元数据机制,通过构造函数参数(位置参数)和属性(命名参数)传递配置,需反射读取并谨慎用于解耦配置与行为。

C# 如何自定义特性(Attribute) - 元数据编程的强大功能

自定义特性(Attribute)是 C# 中实现元数据编程的核心机制,它让你能在代码中声明式地附加额外信息,并在运行时通过反射读取和使用这些信息。关键不在于“加标签”,而在于“让标签可被识别、可被提取、可被逻辑驱动”。

定义一个自定义特性类

自定义特性本质是一个继承自 Attribute 的类。它支持构造函数参数和命名参数(属性),但必须显式标记 [AttributeUsage] 来说明它能用在哪些程序元素上(如类、方法、属性等)。

  • [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] 控制使用范围、是否允许多次使用、是否继承
  • 构造函数参数对应“位置参数”,用于必填信息;public set 访问器的属性对应“命名参数”,用于可选配置
  • 避免在特性中放复杂逻辑或副作用——它只是数据容器,不是执行单元

在代码中应用自定义特性

语法和内置特性一样,写在目标元素上方,括号内传入参数即可。支持位置参数(按构造函数顺序)、命名参数(PropertyName = value),也可混合使用。

  • 例如:[ApiVersion(2, Description = “v2 接口 ”, IsDeprecated = true)] public class UserController {…}
  • 多个同类型特性需开启 AllowMultiple = true,否则编译报错
  • 特性不会影响编译结果或运行行为——除非你主动用反射去读它

在运行时读取并使用特性信息

靠反射(Reflection)获取:调用 GetCustomAttribute()GetCustomAttributes() 方法,从类型、方法、属性等成员对象上提取实例。

  • 推荐优先用泛型版本,类型安全且性能更好;非泛型版返回 object[],需手动转换
  • 常用于框架扩展场景:比如 Web API 根据 [Route] 生成 路由,或 ORM 框架根据 [Column] 映射数据库字段
  • 注意:反射有性能开销,建议缓存读取结果(如用 ConcurrentDictionary 存储解析后的元数据)

进阶技巧:结合特性与接口 / 工厂提升可维护性

单纯读特性容易让逻辑散落在各处。更清晰的做法是让特性关联行为——比如定义一个接口 IActionFilter,再让特性实现它,或通过工厂根据特性类型创建 处理器

  • 例如:定义 [LogExecution] 特性,再配合 AOP 框架(如 AspectCore)自动注入日志逻辑
  • 或在中间件中扫描所有标记了 [RequiresPermission(“Admin”)] 的控制器方法,统一做权限拦截
  • 特性本身不执行,但它是触发执行的“开关”和“配置源”

基本上就这些。自定义特性不是炫技 工具,而是把“配置”和“行为”解耦的关键一环——写得清楚,读得准确,用得克制,它就能成为你架构里安静又可靠的元数据引擎。

星耀云
版权声明:本站原创文章,由 星耀云 2025-12-23发表,共计1299字。
转载说明:转载本网站任何内容,请按照转载方式正确书写本站原文地址。本站提供的一切软件、教程和内容信息仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。
text=ZqhQzanResources