c# 特性

1.c# 特性在 C# 中特性 (Attributes)是一种强大的机制允许你将元数据Metadata声明性地附加到代码元素上如类、方法、属性、参数、程序集等。这些元数据可以在运行时通过反射 (Reflection)读取或者在编译时由编译器或其他工具处理。以下是关于 C# 特性的核心概念、用法和常见示例1. 核心概念定义特性是一个继承自System.Attribute的类。用途用于提供额外信息例如控制序列化行为如 JSON 命名。定义数据库映射如 ORM 中的表名、主键。进行验证如[Required],[MaxLength]。配置依赖注入或 API 路由。标记测试方法如[TestMethod],[Fact]。语法糖在应用特性时如果特性类名以Attribute结尾可以省略该后缀。例如[ObsoleteAttribute]可以写成[Obsolete]。2. 如何定义自定义特性要创建自己的特性需要创建一个继承自System.Attribute的类。通常建议使用AttributeUsage来限制该特性可以应用的位置。using System; // 1. 定义特性的使用范围 (目标) 和是否允许多次使用 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple false)] public class MyCustomAttribute : Attribute { // 构造函数参数 (位置参数) public string Description { get; } // 可命名参数 (属性) public bool IsDeprecated { get; set; } public int Version { get; set; } public MyCustomAttribute(string description) { Description description; Version 1; // 默认值 } }3. 如何使用特性将特性放在方括号[]中置于目标代码元素的上方。[MyCustom(这是一个测试类, IsDeprecated true, Version 2)] public class UserService { [MyCustom(获取用户信息)] public void GetUser(int id) { // ... } // 也可以应用在返回值上 [return: MyCustom(返回用户对象)] public object GetUserData() { return null; } }4. 如何在运行时读取特性 (反射)特性本身在编译后只是元数据需要通过 .NET 的反射机制在运行时读取。using System; using System.Reflection; public class Program { public static void Main() { Type type typeof(UserService); // 获取类上的特性 var classAttr (MyCustomAttribute)Attribute.GetCustomAttribute(type, typeof(MyCustomAttribute)); if (classAttr ! null) { Console.WriteLine($类描述: {classAttr.Description}); Console.WriteLine($是否弃用: {classAttr.IsDeprecated}); Console.WriteLine($版本: {classAttr.Version}); } // 获取方法上的特性 MethodInfo method type.GetMethod(GetUser); var methodAttr (MyCustomAttribute)Attribute.GetCustomAttribute(method, typeof(MyCustomAttribute)); if (methodAttr ! null) { Console.WriteLine($方法描述: {methodAttr.Description}); } } }5. 常见的内置特性C# 和 .NET 框架提供了许多内置特性[Obsolete]: 标记代码为过时编译器会发出警告或错误。[Obsolete(请使用 NewMethod 代替, true)] // true 表示视为错误而非警告 public void OldMethod() { }[Conditional]: 条件编译。只有在定义了特定符号时该方法调用才会被包含。常用于调试日志。[Conditional(DEBUG)] public void LogDebug(string message) { ... }[DllImport]: 用于调用非托管 DLL 中的函数 (P/Invoke)。[Serializable]: 标记类可被序列化 (虽然在现代 .NET 中较少直接使用更多是用在特定序列化库中)。ASP.NET Core / MVC 常用:[HttpGet],[HttpPost]: 定义 HTTP 动词。[Route]: 定义路由模板。[Authorize]: 要求用户认证。Entity Framework Core:[Key]: 主键。[Table(Users)]: 指定表名。[NotMapped]: 不映射到数据库列。6. 注意事项构造函数限制特性的构造函数参数必须是编译时常量、typeof表达式或一维常量数组。不能传递复杂的对象实例。性能反射读取特性有一定的性能开销。如果在高频调用的路径中大量使用反射读取特性建议缓存读取结果。源生成器 (Source Generators)在现代 C# (.NET 5) 开发中很多原本需要在运行时通过反射读取特性的场景如序列化、依赖注入现在倾向于使用源生成器在编译时直接生成代码从而消除运行时反射的性能开销。2.元数据的具体意思元数据 (Metadata)的字面意思是“关于数据的数据” (Data about Data)。在计算机科学和编程特别是 C#的语境下元数据是指描述程序结构、行为或属性的信息而不是程序实际处理的业务数据。为了让你更直观地理解我们可以从以下几个维度来拆解1. 通俗类比想象你有一本书这就是数据/代码数据 (Data)书里的故事情节、文字内容。这是读者真正阅读的部分。元数据 (Metadata)书的封面信息、目录、页码、ISBN 号、作者介绍、出版年份、分类标签如“科幻”、“悬疑”。这些信息不直接构成故事但它们描述了这本书的特征帮助图书馆分类、帮助读者快速查找、帮助书店管理库存。在 C# 中代码 (Code)if (user.IsActive) { SendEmail(); }这种逻辑语句。元数据 (Metadata)告诉编译器或运行时“SendEmail方法是一个公共方法”、“User类继承自BaseEntity”、“IsActive属性被标记为[Required]必填”。2. 在 C# / .NET 中的具体体现在 .NET 中当你编译代码生成.dll或.exe文件时编译器不仅会将你的 C# 代码转换成中间语言 (IL)还会在文件中嵌入大量的元数据表。这些元数据包括类型信息类名、接口名、结构体名。成员信息方法名、参数类型、返回值类型、属性名、字段名。访问修饰符是public、private还是protected继承关系哪个类继承了哪个父类实现了哪些接口程序集引用这个程序依赖了哪些其他的 DLL自定义特性 (Attributes)这就是你上一个问题提到的内容。当你写[Obsolete]或[MyCustom]时编译器会将这些标记作为元数据存储在文件中。代码示例对比// 【业务数据/逻辑】这是程序运行时实际执行的指令 public int CalculateSum(int a, int b) { return a b; } // 【元数据】由编译器自动生成并嵌入到 DLL 中你看不到源码但存在于二进制文件中 // 1. 有一个名为 CalculateSum 的方法。 // 2. 该方法属于 MyNamespace.MyClass 类。 // 3. 该方法是 public 的。 // 4. 它接受两个 int32 类型的参数。 // 5. 它返回一个 int32 类型的值。 // 6. (如果有特性) 该方法被标记了 [HttpPost] 特性。3. 元数据有什么用元数据是 .NET 框架许多强大功能的基石反射 (Reflection)这是元数据最直接的应用。程序可以在运行时“照镜子”读取自身的元数据。场景Visual Studio 的“智能感知” (IntelliSense) 就是读取元数据来提示你有哪些方法和属性JSON 序列化库如 System.Text.Json通过读取元数据知道哪些属性需要转换。特性 (Attributes) 的存储如前所述特性本质上就是存储在元数据中的自定义标记。没有元数据机制特性就无法在运行时被读取。延迟绑定 (Late Binding)允许你在编译时不知道具体类型的情况下在运行时动态创建对象或调用方法例如插件系统。调试与分析调试器利用元数据将机器码映射回源代码行号让你能断点调试。性能分析工具利用元数据显示方法名和调用栈。互操作性COM 互操作或 P/Invoke 依赖元数据来了解非托管代码的结构。4. 总结数据 vs 元数据特征数据 (Data)元数据 (Metadata)定义程序处理的核心内容描述数据结构、类型和行为的信息例子 (C#)用户输入的姓名 张三计算结果 100类名User属性类型string[Required]标记存在形式变量、对象实例、数据库记录编译后的 DLL/EXE 文件内部的表格、头部信息主要使用者业务逻辑代码编译器、运行时 (CLR)、反射工具、调试器变化频率运行时频繁变化通常在编译后固定不变 (除非动态发射)一句话总结如果把 C# 程序比作一座大楼代码是砖块和水泥构建实体的材料数据是楼里的人和家具实际内容而元数据就是大楼的蓝图、房间号牌和物业管理手册描述大楼结构和规则的信息让其他人编译器、工具、其他代码知道如何进入、如何使用以及这座楼有什么特点。3.特性 (Attributes)可以属于一个对象吗这是一个非常关键的概念区分问题。简短回答不可以。特性 (Attributes)不属于运行时的“对象实例”Object Instance它们属于类型定义类、方法、属性等代码结构本身。一旦程序编译完成特性就作为元数据存储在程序集.dll 或 .exe中而不是存储在你通过new创建的具体对象内存里。详细解释为什么特性不属于“对象”1. 附着点不同蓝图 vs. 房子特性 (Attributes)是附着在类定义蓝图上的。例如[Serializable] public class User { ... }这个标记是告诉编译器/运行时“所有由User类创建出来的东西都遵循这个规则。”对象 (Objects)是运行时在内存中创建的实例房子。例如var user1 new User();user1这个对象在内存中只包含字段 (Fields)和属性 (Properties)的值如Name Alice。它不包含特性数据。2. 共享性如果你创建了 10,000 个User对象特性只在内存中的元数据表里存在一份描述User类。对象数据会有 10,000 份独立的数据每个用户的名字不同。如果特性属于对象那么每个对象都要存一份特性副本这将极大地浪费内存且没有意义因为同一个类的所有实例行为规则通常是一样的。3. 生命周期特性存在于编译后的文件中只要程序集加载它们就在通过反射读取。即使没有任何User对象被创建特性依然存在。对象只有当你执行new时才存在垃圾回收器 (GC) 会在不再使用时销毁它们。代码演示验证特性不在对象上让我们看一个例子证明你无法从对象实例直接获取特性必须通过typeof(类型) 来获取。using System; using System.Reflection; [MyTag(这是类的标记)] public class Person { public string Name { get; set; } public Person(string name) { Name name; } } public class Program { public static void Main() { // 1. 创建两个不同的对象实例 var p1 new Person(张三); var p2 new Person(李四); // ❌ 错误示范对象实例本身没有方法来获取特性 // p1.GetCustomAttribute(...); -- 编译报错object 没有这个方法 // ✅ 正确做法必须通过“类型”(Type) 来获取特性 // 无论是 p1 还是 p2它们对应的类型都是 typeof(Person) Type type typeof(Person); // 或者动态获取Type type p1.GetType(); var attr (MyTagAttribute)Attribute.GetCustomAttribute(type, typeof(MyTagAttribute)); Console.WriteLine($特性内容: {attr.Description}); // 输出: 特性内容: 这是类的标记 // 结论p1 和 p2 共享同一份特性元数据特性不属于 p1 或 p2 任何一个具体对象。 } } public class MyTagAttribute : Attribute { public string Description { get; } public MyTagAttribute(string desc) Description desc; }特殊情况如果你想让“每个对象”都有不同的标记怎么办既然特性不能动态绑定到对象实例如果你需要每个对象有不同的“标记”或“配置”你应该使用普通的属性 (Properties)或字段 (Fields)而不是特性。场景对比使用特性 (Attribute)适用所有Product对象都需要记录日志。写法[Loggable] public class Product { ... }结果静态的编译时确定所有实例共享。使用属性 (Property)适用这个Product对象需要记录日志但那个不需要或者每个对象的日志级别不同。写法public class Product { public bool EnableLogging { get; set; } // 这是一个普通的布尔值 public string LogLevel { get; set; } // 这是一个普通的字符串 // 每个对象可以设置不同的值 } var p1 new Product { EnableLogging true, LogLevel Debug }; var p2 new Product { EnableLogging false, LogLevel Error };结果动态的运行时确定每个实例独立。总结特性 (Attributes)普通属性/字段 (Properties/Fields)归属属于类/类型定义(元数据)归属属于对象实例(内存数据)数量每个类只有一份数量每个对象实例都有一份修改编译后不可变 (除非重新编译)修改运行时可随时修改读取方式通过typeof(Class) 反射读取方式直接通过object.Property用途描述代码结构、配置框架行为用途存储业务数据、状态所以特性是关于类的描述信息而不是对象的一部分。4.c# 特性应用举例为了让你更直观地理解 C# 特性的实际用途我将通过4 个不同场景的完整代码示例来展示。这些例子涵盖了从“手动读取元数据”到“框架自动处理”的常见用法。场景一自定义日志记录器 (手动反射读取)目的演示如何定义一个特性并在运行时通过反射读取它从而动态改变程序行为例如只标记了[Log]的方法才打印日志。1. 定义特性using System; // 限制该特性只能用在方法上 [AttributeUsage(AttributeTargets.Method)] public class LogExecutionAttribute : Attribute { public string Category { get; set; } General; public LogExecutionAttribute(string category) { Category category; } }2. 应用特性public class OrderService { // 这个方法被标记了需要记录日志 [LogExecution(订单模块)] public void CreateOrder(int orderId) { Console.WriteLine($正在创建订单 #{orderId}...); // 模拟业务逻辑 } // 这个方法没有标记不需要记录日志 public void GetOrderStatus(int orderId) { Console.WriteLine($查询订单 #{orderId} 状态); } }3. 读取并执行逻辑 (核心部分)这里我们模拟一个“拦截器”在执行方法前检查是否有特性。public class Program { public static void Main() { var service new OrderService(); // 模拟调用 CreateOrder InvokeWithLogging(service, CreateOrder, 1001); // 模拟调用 GetOrderStatus (不会打印日志头) InvokeWithLogging(service, GetOrderStatus, 1001); } // 通用调用方法利用反射检查特性 public static void InvokeWithLogging(object target, string methodName, params object[] args) { var type target.GetType(); var method type.GetMethod(methodName); if (method null) return; // 【关键步骤】检查该方法是否有 LogExecutionAttribute var logAttr (LogExecutionAttribute)Attribute.GetCustomAttribute(method, typeof(LogExecutionAttribute)); if (logAttr ! null) { // 如果有特性先打印日志 Console.WriteLine($[LOG] [{logAttr.Category}] 开始执行方法: {methodName}); } // 执行实际方法 method.Invoke(target, args); if (logAttr ! null) { Console.WriteLine($[LOG] [{logAttr.Category}] 方法执行完毕: {methodName}\n); } } }输出结果[LOG] [订单模块] 开始执行方法: CreateOrder 正在创建订单 #1001... [LOG] [订单模块] 方法执行完毕: CreateOrder 查询订单 #1001 状态解析GetOrderStatus因为没有特性所以跳过了日志打印逻辑。这就是特性控制程序流程的典型用法。场景二简易 ORM 映射 (数据驱动)目的演示如何用特性描述数据库结构模拟 Entity Framework 或 Dapper 的工作原理。1. 定义特性[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)] public class ColumnAttribute : Attribute { public string Name { get; } public bool IsPrimaryKey { get; set; } public ColumnAttribute(string name) { Name name; } } [AttributeUsage(AttributeTargets.Class)] public class TableAttribute : Attribute { public string TableName { get; } public TableAttribute(string name) TableName name; }2. 定义模型类[Table(Users)] // 映射到数据库表 Users public class User { [Column(Id, IsPrimaryKey true)] // 主键 public int UserId { get; set; } [Column(user_name)] // 映射到列 user_name public string Name { get; set; } // 没有标记特性的属性通常不映射到数据库 public string TempToken { get; set; } }3. 生成 SQL 语句 (模拟框架行为)public static string GenerateSelectSqlT() { Type type typeof(T); // 1. 获取表名 var tableAttr (TableAttribute)Attribute.GetCustomAttribute(type, typeof(TableAttribute)); if (tableAttr null) throw new Exception(类未标记 Table 特性); string tableName tableAttr.TableName; // 2. 获取所有属性并筛选有 Column 特性的 var columns new Liststring(); foreach (var prop in type.GetProperties()) { var colAttr (ColumnAttribute)Attribute.GetCustomAttribute(prop, typeof(ColumnAttribute)); if (colAttr ! null) { columns.Add(colAttr.Name); } } return $SELECT {string.Join(, , columns)} FROM {tableName}; } // 测试 // Console.WriteLine(GenerateSelectSqlUser()); // 输出: SELECT Id, user_name FROM Users // 注意TempToken 被自动忽略了因为它没有 [Column] 特性。场景三API 参数验证 (类似 ASP.NET Core)目的演示如何利用特性声明验证规则并在运行时统一处理验证逻辑。1. 定义验证特性public class RequiredAttribute : Attribute { } public class MaxLengthAttribute : Attribute { public int Length { get; } public MaxLengthAttribute(int length) Length length; }2. 定义 DTO (数据传输对象)public class RegisterRequest { [Required] [MaxLength(50)] public string Username { get; set; } [Required] public string Password { get; set; } // 可选字段无特性 public string Nickname { get; set; } }3. 验证器逻辑public static bool Validate(object obj) { var type obj.GetType(); foreach (var prop in type.GetProperties()) { var value prop.GetValue(obj); // 检查 [Required] if (Attribute.IsDefined(prop, typeof(RequiredAttribute))) { if (value null || string.IsNullOrWhiteSpace(value.ToString())) { Console.WriteLine($验证失败: {prop.Name} 不能为空); return false; } } // 检查 [MaxLength] var maxAttr (MaxLengthAttribute)Attribute.GetCustomAttribute(prop, typeof(MaxLengthAttribute)); if (maxAttr ! null value ! null) { if (value.ToString().Length maxAttr.Length) { Console.WriteLine($验证失败: {prop.Name} 长度不能超过 {maxAttr.Length}); return false; } } } return true; } // 测试 // var req new RegisterRequest { Username , Password 123 }; // Validate(req); // 输出: 验证失败: Username 不能为空场景四废弃警告 (编译器内置特性)目的展示不需要反射直接由编译器处理的特性。public class LegacySystem { // 标记此方法为过时 // 第二个参数 true 表示将其视为“错误”而不是“警告”强制开发者修改代码 [Obsolete(DoNotUseOldLogin 已废弃请使用 NewLoginAsync 方法, true)] public void DoNotUseOldLogin() { Console.WriteLine(旧登录逻辑); } public void NewLoginAsync() { Console.WriteLine(新登录逻辑); } } // 如果在代码中调用 // var sys new LegacySystem(); // sys.DoNotUseOldLogin(); // - 编译直接报错无法生成 DLL直到你移除这行代码或改为调用 NewLoginAsync。总结特性在真实世界中的角色配置而非代码特性让你把“配置信息”如数据库表名、验证规则、路由路径直接写在代码旁边保持代码和内聚性而不是放在外部的 XML 或 JSON 文件中。框架的钩子 (Hooks)大多数时候你写特性不是为了自己写反射代码去读它而是为了让框架如 ASP.NET Core, Entity Framework, xUnit, Newtonsoft.Json去读它。xUnit看到[Fact]就知道这是个测试用例。JSON 序列化器看到[JsonProperty(id)]就知道要把 C# 的Id属性序列化成 JSON 的id。EF Core看到[Key]就知道这是主键。零运行时开销 (配合源生成器)在现代 .NET (C# 9/10/11) 中许多库如 System.Text.Json使用源生成器在编译时读取特性并生成优化的代码这意味着你在享受特性带来的便利时不再承担运行时反射的性能惩罚。