C# Attribute 使用技巧：编写更清晰、更强大的代码 – wiki基地

C# Attribute 使用技巧：编写更清晰、更强大的代码

C# 属性 (Attribute) 是一种强大的元数据编程工具，它允许我们将额外的声明性信息与类型、方法、属性等程序元素相关联。这些信息可以在编译时或运行时被读取和利用，从而实现各种各样的功能，例如代码生成、序列化、验证、依赖注入等。合理地使用属性可以显著提高代码的可读性、可维护性和灵活性。

本文将深入探讨 C# 属性的使用技巧，帮助你编写更清晰、更强大的代码。我们将涵盖以下几个方面：

1. 属性的基础知识：

• 什么是属性？
• 预定义属性 vs. 自定义属性
• 属性的使用语法
• 属性的 Target
• 属性的属性（AttributeUsage）

2. 常用的预定义属性：

• ObsoleteAttribute: 标记过时的方法、类或结构体。
• ConditionalAttribute: 控制方法是否编译。
• SerializableAttribute: 标记类可以被序列化。
• DllImportAttribute: 允许调用非托管代码（DLL）。
• DebuggerDisplayAttribute: 自定义调试器中类的显示方式。
• CompilerGeneratedAttribute: 标识由编译器生成的代码。

3. 自定义属性的创建与使用：

• 定义自定义属性类
• 使用构造函数传递数据
• 使用属性存储元数据
• 使用枚举、标志枚举作为属性参数
• 使用数组作为属性参数
• 高级技巧：属性路由与动态属性

4. 使用反射获取属性信息：

• 使用 Type.GetCustomAttributes() 获取属性
• 使用 Attribute.GetCustomAttribute() 获取属性
• 高效的属性缓存

5. 属性的实际应用场景：

• 序列化和反序列化
• 数据验证
• 依赖注入
• 代码生成
• ORM 框架
• AOP (面向切面编程)

6. 属性使用最佳实践：

• 保持属性简单和易于理解
• 避免过度使用属性
• 充分利用预定义属性
• 正确选择属性的目标 (Target)
• 注意性能问题，避免不必要的反射

1. 属性的基础知识

什么是属性？

在 C# 中，属性 (Attribute) 是一种允许你向程序元素（如类、方法、属性、字段、事件等）添加声明性信息的机制。可以将属性视为附加到代码元素的元数据，这些元数据可以在编译时或运行时被读取和使用。它们提供了一种以结构化方式表达代码元素的额外信息的方法，而无需更改元素的实际代码。

预定义属性 vs. 自定义属性

C# 提供了许多预定义的属性，例如 ObsoleteAttribute、ConditionalAttribute 和 SerializableAttribute。 这些属性已经定义好并可以在你的代码中直接使用。 除此之外，你还可以创建自己的自定义属性，以满足特定的应用程序需求。

属性的使用语法

使用方括号 [] 将属性应用于代码元素。 属性名称写在方括号内，如果属性接受参数，则参数也写在方括号内。

“`csharp
[Serializable] // 使用预定义属性
public class MyClass {
[Obsolete(“This method is deprecated. Use NewMethod instead.”)] // 带有参数的预定义属性
public void OldMethod() { / … / }

[MyCustomAttribute(“Some Value”)] // 使用自定义属性
public string MyProperty { get; set; }
}
“`

属性的 Target

属性可以应用于不同的程序元素，例如类、方法、属性、字段、事件等。 可以使用 AttributeTargets 枚举指定属性可以应用于哪些元素。 如果没有指定，默认情况下属性可以应用于所有元素。

csharp
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public class MyCustomAttribute : Attribute { /* ... */ }

在这个例子中，MyCustomAttribute 只能应用于类和方法。 AllowMultiple = false 表示属性只能应用于一个元素一次。 Inherited = true 表示属性可以被子类继承。

属性的属性（AttributeUsage）

AttributeUsage 属性本身就是一个属性，它用来控制如何使用其他属性。它有三个主要的参数：

• ValidOn (或 AttributeTargets): 指定属性可以应用到哪些类型的程序元素 (例如: 类、方法、字段等)。
• AllowMultiple: 指示属性是否可以多次应用于同一个元素。 默认值为 false。
• Inherited: 指示属性是否可以被子类或派生类继承。 默认值为 true。

2. 常用的预定义属性

C# 提供了许多有用的预定义属性，以下是一些常用的：

• ObsoleteAttribute: 标记过时的方法、类或结构体。 这会向编译器发出警告，告知开发者该代码已过时，并建议使用替代方法。

  csharp
[Obsolete("Use NewMethod instead.")]
public void OldMethod() { /* ... */ }

• ConditionalAttribute: 控制方法是否编译。 只有在定义了指定的预处理器符号时，才会编译被此属性标记的方法。

  csharp
[Conditional("DEBUG")]
public void DebugLog(string message) {
Console.WriteLine("Debug: " + message);
}

• SerializableAttribute: 标记类可以被序列化。 序列化是将对象转换为字节流的过程，以便存储到文件或通过网络传输。

  csharp
[Serializable]
public class MyClass { /* ... */ }

• DllImportAttribute: 允许调用非托管代码（DLL）。 这允许 C# 代码调用使用 C 或 C++ 等语言编写的 DLL。

  csharp
[DllImport("user32.dll")]
public static extern int MessageBox(IntPtr hWnd, string text, string caption, uint type);

• DebuggerDisplayAttribute: 自定义调试器中类的显示方式。 这可以帮助你在调试时更轻松地查看对象的状态。

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

• CompilerGeneratedAttribute: 标识由编译器生成的代码。编译器生成的代码通常是运行时为了特定功能的需要而创建的，例如迭代器或者 async/await 方法。

  csharp
[CompilerGenerated]
private class <MyMethod>d__0 : IAsyncStateMachine
{
// ...编译器生成的代码...
}

3. 自定义属性的创建与使用

创建自定义属性可以极大地扩展属性的功能，使其能够适应特定的应用程序需求。

定义自定义属性类

自定义属性类必须继承自 System.Attribute 类。

“`csharp
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public class MyCustomAttribute : Attribute
{
public string Value { get; set; }

public MyCustomAttribute(string value)
{
    Value = value;
}

}
“`

使用构造函数传递数据

属性可以通过构造函数接收数据。 在应用属性时，传递给构造函数的参数会存储在属性的实例中。

csharp
[MyCustomAttribute("Hello World")] // 使用构造函数传递数据
public class MyClass { /* ... */ }

使用属性存储元数据

除了构造函数，还可以使用属性的属性 (Property) 来存储元数据。

“`csharp
[AttributeUsage(AttributeTargets.Class)]
public class MyAttribute : Attribute
{
public string Description { get; set; }
public int Version { get; set; }
}

[MyAttribute(Description = “My Class Description”, Version = 1)]
public class MyClass { / … / }
“`

使用枚举、标志枚举作为属性参数

枚举类型也可以作为属性参数。

“`csharp
public enum LogLevel {
Info,
Warning,
Error
}

[AttributeUsage(AttributeTargets.Method)]
public class LogAttribute : Attribute {
public LogLevel Level { get; set; }

public LogAttribute(LogLevel level) {
Level = level;
}
}

[LogAttribute(LogLevel.Error)]
public void MyMethod() { / … / }
“`

使用数组作为属性参数

数组也可以作为属性参数，允许传递多个值。

“`csharp
[AttributeUsage(AttributeTargets.Class)]
public class AllowedValuesAttribute : Attribute {
public int[] Values { get; set; }

public AllowedValuesAttribute(params int[] values) {
Values = values;
}
}

[AllowedValues(1, 2, 3)]
public class MyClass { / … / }
“`

高级技巧：属性路由与动态属性

• 属性路由: 可以通过属性来配置 MVC 路由，让路由更加灵活和易于维护。
• 动态属性: 可以结合反射和属性，动态地创建和配置对象的属性，例如基于数据库表的列信息动态创建实体类的属性。

4. 使用反射获取属性信息

反射是获取属性信息的关键。 C# 提供了丰富的反射 API 来访问类型及其成员的元数据，包括属性。

使用 Type.GetCustomAttributes() 获取属性

Type.GetCustomAttributes() 方法返回应用于类型或成员的所有属性。

“`csharp
Type type = typeof(MyClass);
object[] attributes = type.GetCustomAttributes(true); // 传入 true 表示包含继承的属性

foreach (Attribute attribute in attributes) {
if (attribute is MyCustomAttribute myAttribute) {
Console.WriteLine(“MyCustomAttribute Value: ” + myAttribute.Value);
}
}
“`

使用 Attribute.GetCustomAttribute() 获取属性

Attribute.GetCustomAttribute() 方法返回应用于类型或成员的指定类型的单个属性。 这是一个更有效的方法，如果你只关心特定类型的属性。

“`csharp
Type type = typeof(MyClass);
MyCustomAttribute myAttribute = (MyCustomAttribute)Attribute.GetCustomAttribute(type, typeof(MyCustomAttribute));

if (myAttribute != null) {
Console.WriteLine(“MyCustomAttribute Value: ” + myAttribute.Value);
}
“`

高效的属性缓存

由于反射操作的性能开销相对较高，因此建议缓存属性信息，尤其是当需要多次访问同一类型的属性时。 可以使用 Dictionary 或 ConcurrentDictionary 来缓存属性。

5. 属性的实际应用场景

属性在各种应用场景中都非常有用：

• 序列化和反序列化： 使用 SerializableAttribute 标记可序列化的类，并通过自定义属性控制序列化的行为。
• 数据验证： 使用自定义属性来定义验证规则，例如 RequiredAttribute、StringLengthAttribute 等，并在运行时验证数据。 Entity Framework Core 使用属性进行模型定义。
• 依赖注入： 使用属性标记需要注入依赖项的属性或构造函数参数，并使用依赖注入容器解析依赖项。
• 代码生成： 使用属性标记需要生成代码的元素，并使用代码生成工具生成相应的代码。 例如：使用 T4 模板基于属性生成代码。
• ORM 框架： ORM 框架使用属性来映射类到数据库表，并定义字段之间的关系。
• AOP (面向切面编程)： 可以使用属性标记需要应用切面的方法，并在运行时使用拦截器或代理来实现切面逻辑。

6. 属性使用最佳实践

• 保持属性简单和易于理解： 避免创建过于复杂的属性，并确保属性的用途清晰明了。
• 避免过度使用属性： 只在必要时使用属性，避免过度使用导致代码难以理解和维护。
• 充分利用预定义属性： 优先使用 C# 提供的预定义属性，以减少自定义属性的数量。
• 正确选择属性的目标 (Target)： 根据属性的用途，选择合适的 AttributeTargets，确保属性只能应用于相关的程序元素。
• 注意性能问题，避免不必要的反射： 由于反射操作的性能开销较高，因此应该尽可能避免不必要的反射，例如缓存属性信息。

总而言之，C# 属性是一种强大的元数据编程工具，可以帮助我们编写更清晰、更强大的代码。 通过合理地使用属性，我们可以实现各种各样的功能，并提高代码的可读性、可维护性和灵活性。 理解并掌握属性的使用技巧，对于任何 C# 开发者来说都是至关重要的。