C# 特性(Attribute)介绍

1.概述

特性本质上是用来给代码添加额外信息的一种手段,它可以应用于类、结构、方法、构造函数等。在 C# 中,特性是继承自 Attribute 基类的类。所有继承自 Attribute 的类都可以用作给代码添加额外信息。

2.使用特性

例如,有一个名为 ObsoleteAttribute 的特性。 它用于示意代码已过时,不再使用。 可以使用方括号将此特性应用于某个类或者其他。

[Obsolete]
public class TestClass
{
}

虽然此特性类的名称为 ObsoleteAttribute,但只需在代码中使用 Obsolete。 这是 C# 得一项约定。虽然也可以使用全名 ObsoleteAttribute

将类标记为已过时时还可以通过将参数传递给 Obsolete 特性额外添加一些说明,只能传递bool, int, double, string, Type, enums, etc和这些类型的数组。 不能使用表达式或变量。

[Obsolete("TestClass已经过时,请使用NewTestClass")]
public class TestClass
{
}

3.自定义特性

自定义特性只需要让一个类继承Attribute类并且名称后缀是Attribute结尾即可。

class MsgAttribute : Attribute
{
    private string msg;
    public MyAttribute(string msg)
    {
        this.msg = msg;
    }
    public void ShowMsg()
    {
        Console.WriteLine(msg);
    }
}

[Msg("这是一条信息")]
class MyClass
{
}

4. 读取特性信息

特性只做标识所用。不借助一些外在力量,特性其实什么用也没有。

若要使用特性,通常需要使用反射。例如,可以使用反射获取类的相关信息。

TypeInfo typeInfo = typeof(MyClass).GetTypeInfo();//获取类型信息
MsgAttribute customAttribute = typeInfo.GetCustomAttribute<MsgAttribute>(); //获取特性信息,返回特性的实例对象
customAttribute.GetName();//调用方法 控制台中输出 这是一条信息

GetCustomAttribute<T>泛型方法用于获取某个特定的特性,返回该特性实例,还有一个GetCustomAttributes()方法用于获取所有的特性。

特性只有使用 GetCustomAttribute 或 GetCustomAttributes,它们才会实例化。 并且每次调用都会重新实例化并返回不同的特性实例。

5.总结

特性可以提供声明能力,但它们是一种元数据形式的代码,本身并不执行操作。

猜你喜欢

转载自blog.csdn.net/echozly/article/details/122288573