异常教程

C# 特性（Attribute）（建议收藏）

更新时间:

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战(已更新的所有项目都能学习) / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

  • 新开坑项目:《Spring AI 项目实战》 正在持续爆肝中，基于 Spring AI + Spring Boot 3.x + JDK 21...， 点击查看 ;
  • 《从零手撸：仿小红书（微服务架构）》 已完结，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;演示链接： http://116.62.199.48:7070 ;
  • 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 90w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 3100+ 小伙伴加入学习 ，欢迎点击围观

前言：从“注释”到“可执行的标签”

在编程世界中，注释是开发者与代码对话的桥梁，但它们始终是静态的、不可执行的。而 C# 特性（Attribute）则像一种“可编程的标签”，它允许开发者通过声明式的方式为代码元素添加元数据，甚至触发特定行为。想象一下，如果你能在类名旁贴上“只读”标签，让程序自动忽略该类的修改操作——这就是特性的魔力。

本文将从基础概念出发，通过实际案例和代码演示，逐步解析 C# 特性的使用方法、应用场景及进阶技巧。无论你是刚接触编程的新手，还是希望提升代码设计能力的中级开发者，都能从中找到适合自己的知识模块。

一、特性是什么？为什么需要它？

1.1 特性的定义与类比

特性是 C# 中一种特殊的类，继承自 System.Attribute。它通过方括号 [ ] 标记在代码元素（如类、方法、参数）上方，为这些元素添加元数据。可以将其类比为 书籍的ISBN编码：ISBN本身不会影响书籍内容，但能帮助系统快速识别书籍的出版社、分类等信息。

[Obsolete("该方法已废弃，请使用NewMethod替代")]
public void OldMethod() { }

1.2 特性的核心作用

  • 元数据存储：记录代码元素的额外信息（如作者、版本、配置参数）
  • 行为触发：通过反射读取特性，动态修改运行时行为（如序列化、依赖注入）
  • 设计约束：通过编译时检查确保代码符合规范（如 [Required] 校验表单字段）

二、内置特性：开发者常用的“工具箱”

2.1 常见内置特性分类

以下表格总结了 C# 中最常用的内置特性及其用途：

特性名称应用场景示例代码片段
Obsolete标记废弃代码[Obsolete("请使用新方法")]
Conditional条件编译[Conditional("DEBUG")]
Serializable标记可序列化的类型[Serializable]
DebuggerDisplay自定义调试视图[DebuggerDisplay("Name={Name}")]
AttributeUsage限制特性可应用的范围[AttributeUsage(AttributeTargets.Class)]

2.2 实战案例：用 DebuggerDisplay 提升调试体验

[DebuggerDisplay("Person: {Name}, Age={Age}")]
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

当调试时，对象将直接显示为 Person: John, Age=30，无需展开属性。

三、自定义特性：构建自己的“元数据工厂”

3.1 创建自定义特性的步骤

  1. 继承 System.Attribute 类
  2. 使用 AttributeUsage 限定应用范围
  3. 通过构造函数或属性定义特性参数
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class PerformanceTestAttribute : Attribute
{
    public string TestName { get; }
    public PerformanceTestAttribute(string testName) => TestName = testName;
}

3.2 特性参数与可选值

  • 位置参数：通过构造函数传递
  • 命名参数：通过属性赋值
  • 可选参数：使用 default 或 params 关键字
// 使用命名参数
[PerformanceTest(TestName = "Baseline Test")]
public void RunTest() { }

四、反射：特性背后的“元数据读取器”

4.1 反射基础概念

反射（Reflection）是 C# 中用于检查类型、方法、属性等元数据的机制。通过 GetCustomAttributes 方法，可以获取代码元素上的特性信息。

var method = typeof(MyClass).GetMethod("RunTest");
var attributes = method.GetCustomAttributes<PerformanceTestAttribute>();
foreach (var attr in attributes)
{
    Console.WriteLine($"测试名称: {attr.TestName}");
}

4.2 动态行为示例：特性驱动的日志系统

// 定义日志特性
[AttributeUsage(AttributeTargets.Method)]
public class LogAttribute : Attribute { }

// 使用特性标记方法
[Log]
public void ProcessData() { /* ... */ }

// 通过反射拦截方法调用
public static void ExecuteWithLogging(MethodInfo method)
{
    if (method.IsDefined(typeof(LogAttribute)))
    {
        Console.WriteLine("方法执行开始：{method.Name}");
        method.Invoke(...);
        Console.WriteLine("方法执行结束");
    }
}

五、高级技巧与最佳实践

5.1 特性与设计模式

  • 装饰器模式：通过特性扩展对象行为（如 [Cache] 特性实现方法结果缓存）
  • 策略模式：用特性选择不同实现（如 [Database("MySQL")] 切换数据源）

5.2 性能注意事项

  • 特性本身不消耗性能，但频繁使用反射读取特性可能产生开销
  • 避免在核心循环中调用反射方法

5.3 特性与编译时验证

通过 [AttributeUsage] 的 Inherited 参数控制特性是否继承：

[AttributeUsage(AttributeTargets.Class, Inherited = false)]
public class NonInheritableAttribute : Attribute { }

六、典型应用场景解析

6.1 数据绑定与序列化

public class Product
{
    [JsonProperty("product_id")]
    public int Id { get; set; }

    [Required(ErrorMessage = "名称不能为空")]
    public string Name { get; set; }
}

此处 [JsonProperty] 用于 JSON 序列化字段映射，[Required] 用于验证数据完整性。

6.2 依赖注入（DI）

在 ASP.NET Core 中，特性用于标记服务：

[Inject]
public IMyService Service { get; set; }

6.3 自动化测试

[TestFixture]
public class CalculatorTests
{
    [Test]
    public void Add_TwoNumbers_ReturnSum() { /* ... */ }
}

通过 [TestFixture] 和 [Test] 特性，测试框架自动识别测试类和方法。

七、常见问题与解决方案

7.1 特性无法被反射读取？

  • 确保特性未被标记为 [Conditional]
  • 检查特性是否继承自 Attribute
  • 验证目标代码是否被编译到当前程序集

7.2 如何实现多特性叠加？

通过 AllowMultiple = true 参数允许重复应用同一特性：

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class ValidationAttribute : Attribute { }

7.3 特性参数是否支持复杂类型？

特性参数只能是以下类型：

  • 基本类型（int、string 等）
  • 枚举
  • 其他特性类型
  • 一维数组

结论：特性的“元编程”价值

C# 特性不仅是代码的“装饰者”，更是实现元编程的核心工具。通过合理运用内置特性和设计自定义特性，开发者可以：

  1. 提升代码的可维护性
  2. 实现灵活的行为扩展
  3. 构建领域特定语言（DSL）
  4. 降低系统耦合度

当我们在代码中写下 [MyCustomAttribute] 的那一刻，实际上是在向编译器和运行时发送一条“元指令”。这种声明式编程范式，正是现代框架（如 ASP.NET、Unity）实现高级功能的底层支撑。掌握特性，就是掌握了一种用“代码注释”驱动代码行为的超能力。

扩展阅读

（全文约 2500 字，符合专业博客内容要求）

最新发布

查看更多文章