总结一下 C# 如何自定义特性 Attribute 并进行应用

news2024/10/7 8:19:45

前言

Attribute（特性）是一种用于为程序元素（如类、方法、属性等）提供元数据信息的方法。

特性是一种声明式的信息，附加到程序元素上，提供额外的数据用于描述和控制这些元素的行为。

在编译和运行时，都可以读取特性提供的信息对程序元素进行分析和操作。

特性通常用于实现以下功能：

为代码添加元数据信息：特性为元素（类、方法、属性等）添加额外的元数据信息，描述其用途、状态、约束等。
控制编译行为：特性可以用于控制编译器对代码的处理，如指示编译器生成额外的代码、忽略特定警告等。
在运行时进行反射操作：特性可以在运行时通过反射获取并读取，用于实现一些动态的行为，如配置加载、权限检查等。

C# 本身提供了一些常用的特性，如 Serializable、Obsolete、Conditional 等，同时我们也可以自定义特性来满足特定的需求。

特性的应用范围非常广泛，在实际开发中经常用于标记和控制程序的行为，提高代码的可读性和灵活性。

下面看看如何自定义特性 Attribute 并进行应用。

Step By Step 步骤：

创建一个 ASP.NET Core Web Api 项目

创建一个 Attribute

namespace AttributeSample
{
	// 说明此特性应用在属性上
	[AttributeUsage(AttributeTargets.Property)]
	public class TestAttribute: Attribute
	{
		public string DisplayName { get; set; }
	 
		public int DisplayWidth { get; set; }

		public TestAttribute(string displayName, int displayWidth)
		{
			DisplayName = displayName;
			DisplayWidth = displayWidth;
		}
	}
}

创建一个类，应用这个 Attribute

public class Points
{
    [Test("站点名称", 100)]
    public string StationNo { get; set; }

    [Test("P1数据名称", 100)]
    public float TD_P1 { get; set; }

    [Test("P2数据名称", 100)]
    public float TD_P2 { get; set; }
}

在控制器中读取 Points 类的属性的特性的值并应用

namespace AttributeSample.Controllers
{
	[ApiController]
	[Route("[controller]")]
	public class WeatherForecastController : ControllerBase
	{
		private readonly ILogger<WeatherForecastController> _logger;

		public WeatherForecastController(ILogger<WeatherForecastController> logger)
		{
			_logger = logger;

			// 获取 Attribute 内容
			Type t = typeof(Points);
			foreach (PropertyInfo pi in t.GetProperties())
			{
				string propertyName = pi.Name;
				string displayName = pi.GetCustomAttribute<TestAttribute>()?.DisplayName!;
				int displayWidth = pi.GetCustomAttribute<TestAttribute>().DisplayWidth;
				
				// 读取类属性的特性值之后，可以进行一些操作，这里是打印出来
				_logger.LogInformation("属性名称：" + propertyName + "；显示名称：" + displayName + "；显示宽度：" + displayWidth);
			}
		}
		......
	}

总结

Attrbiute 本身只是 “标签”，脱离了通过反射操作它的代码逻辑，它什么也不是
Attribute 本身，就是个标记，没什么功能。但是，别的工具、框架（比如上面的控制器）在做事的时候，会看相关的 Attribute，做相应的处理。这是最主要的作用
总的来说就是可以用 Attribute 给代码元素（类，方法，成员变量，属性等等）打个标签，附加一些信息，在调用这些代码的时候利用反射取出这些信息并根据这些信息做些不同的事情
Attribute 一定是配合反射使用的。也就说，你看不到的外层框架性代码一定有调用反射去寻找这些 Attribute。
可以利用 Attribute 更好地解耦业务，更好地符合单一职责原则，比如一个方法要实现三个业务场景，保存数据之后要发送一个邮件和发送一个消息，就可以在方法中只做保存数据的业务场景，利用 Attribute 来实现发送邮件和消息的业务场景。