特性定义
特性是一种允许我们向程序的程序集添加元数据的语言结构
它是用于保存程序结构信息的某种特殊类型的类
特性提供功能强大的方法以将声明信息与C#代码(类型、方法、属性等)相关联。
特性与程序实体关联后,即可在运行时使用反射查询特性信息
特性的目的是告诉编译器把程序结构的某组元数据嵌入程序集中
它可以放置在几乎所有的声明中(类、变量、函数等等申明)
说人话:
特性本质是个类
我们可以利用特性类为元数据添加额外信息
比如一个类、成员变量、成员方法等等为他们添加更多的额外信息
之后可以通过反射来获取这些额外信息
自定义特性
//继承特性基类
class MyCustomAttribute : Attribute
{
//特性中的成员 一般根据需求来写
public string info;
public MyCustomAttribute(string info)
{
this.info = info;
}
}
特性的使用
基本语法:
[特性名(参数列表)] 本质上 就是在调用特性类的构造函数
写在哪里?
类、函数、变量上一行,表示他们具有该特性信息
class Program
{
static void Main(string[] args)
{
#region 特性的使用
MyClass mc = new MyClass();
Type t = mc.GetType();
//t = typeof(MyClass);
//t = Type.GetType("ConsoleApp1.MyClass");
//判断是否使用了某个特性
//参数一 特性的类型
//参数二 代表是否搜索继承链(属性和事件忽略此参数)
//只判断了这个类
if (t.IsDefined(typeof(MyCustomAttribute), false))
{
Console.WriteLine("该类型应用了MyCustom特性");
}
//获取Type元数据中的所有特性
object[] array = t.GetCustomAttributes(true);
for (int i = 0; i < array.Length; i++)
{
if(array[i] is MyCustomAttribute)
{
Console.WriteLine((array[i] as MyCustomAttribute).info);
(array[i] as MyCustomAttribute).TestFun();
}
}
#endregion
}
#region 自定义特性
//继承特性基类
class MyCustomAttribute : Attribute
{
//特性中的成员 一般根据需求来写
public string info;
public MyCustomAttribute(string info)
{
this.info = info;
}
//特性的方法
public void TestFun()
{
Console.WriteLine("特性的方法");
}
}
#endregion
#region 特性的使用
[MyCustom("这个是自己写的特性")]
class MyClass
{
[MyCustom("这是一个成员变量")]
public int value;
[MyCustom("这世界用于计算的函数")]
public void TestFun( [MyCustom("函数参描述")]int a)
{
}
}
#endregion
}
限制自定义特性的使用范围
#region 限制自定义特性的使用范围
//通过为特性类 加特性 限制其使用范围
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true, Inherited = true)]
//参数一: AttributeTargets 特性能够用在哪些地方
//参数二 AllowMultiple 是否允许多个特性实例用在同一目标上
//参数三 Inherited 特性是否能被派生类和重写成员继承
public class MyCustom2Attribute : Attribute
{
}
#endregion
系统自带特性
过时特性
过时特性
Obsolete
用于提示用户 使用的方法等成员已经过时 建议使用新方法
一般加在函数前的特性
class TestClass
{
//参数一 调用过时方法时出现的提示
//参数二 true 使用该方法会报错 false 使用该方法直接警告
[Obsolete("OldSpeak方法已经过时,请使用Speak方法",false)]
public void OldSpeak()
{
}
public void Speak()
{
}
}
调用者信息特性
哪个文件调用?
CallerFilePath特性
哪一行调用?
CallerLineNumber特性
哪个函数调用?
CallerMemberName特件
需要引用命名空间 using system.Runtime.compilerservices;
一般作为函数参数的特性
TestClass tc = new TestClass();
tc.OldSpeak();
tc.Speak();
tc.SpeakCaller("123123");
public void SpeakCaller(string str,[CallerFilePath]string fileName = "",
[CallerLineNumber]int line = 0, [CallerMemberName]string target = "")
{
Console.WriteLine(str);
Console.WriteLine(fileName);
Console.WriteLine(line);
Console.WriteLine(target);
}
条件编译特性
条件编译特性
Conditional
它会和预处理指令 #define配合使用
需要引用命名空间using system.Diagnostics;
主要可以用在一些调试代码上
有时想执行有时不想执行的代码
#define Fun
[Conditional("Fun")]
static void Fun()
{
Console.WriteLine("Fun执行");
}
//没有define Fun 则不会执行。
Fun();
外部DLL包函数特性
DllImport
用来标记非.Net(c#)的函数,表明该函数在一个外部的DLL中定义
一般用来调用 C或者C++的Dll包写好的方法需要
引用命名空间 using system.Runtime.InteropServices
[DllImport("Test.dll")]
public static extern int Add(int a, int b);
总结
总结:特性是用于 为元数据再添加更多的额外信息(变量、方法等等)
我们可以通过反射获取这些额外的数据 来进行一些特殊的处理
自定义特性-继承Attribute类
系统自带特性:过时特性
为什么要学习特性
Unity引擎中很多地方都用到了特性来进行一些特殊处理