An attribute is a language construct that allows us to add metadata to a program's assembly
It is a special type of class used to hold program structure information
Attributes provide a powerful way to associate declarative information with C# code (types, methods, properties, etc.).
After a feature is associated with a program entity, you can use reflection to query feature information at runtime
The purpose of the attribute is to tell the compiler to embed a certain set of metadata about the program structure into the assembly.
It can be placed in almost any declaration (class, variable, function, etc. declaration)
The essence of a feature is a class
We can use the feature class to add additional information to metadata
, such as a class, member variable, member method, etc., to add more additional information to them,
and then we can obtain this additional information through reflection
(1) Custom features
// 继承特性基类 Attribute
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field, AllowMultiple = true, Inherited = false)]
internal class MyCustomAttribute : Attribute
{
// 特性中的成员 一般根据需求来写
public string info;
public MyCustomAttribute(string info) {
this.info = info;
}
public void TestFun() {
Console.WriteLine("特性的方法");
}
}
(2) Use of features
// 基本语法:
// [特性名(参数列表)]
// 本质上 就是在调用特性类的构造函数
// 写在哪里?
// 类、函数、变量上一行,表示他们具有该特性信息
[MyCustom("这个是我自己写的一个用于计算的类")]
[MyCustom("这个是我自己写的一个用于计算的类")]
internal class MyClass
{
[MyCustom("这是一个成员变量")] public int value;
// [MyCustom("这是一个用于计算加法的函数")]
// public void TestFun( [MyCustom("函数参数")]int a )
// {
// }
public void TestFun(int a) { }
}
private static void Main(string[] args) {
Console.WriteLine("特性");
// 特性的使用
MyClass mc = new MyClass();
Type t = mc.GetType();
// t = typeof(MyClass);
// t = Type.GetType("xxx.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();
}
}
TestClass tc = new TestClass();
tc.OldSpeak("123");
tc.Speak();
tc.SpeakCaller("123123123123123");
Fun();
}
(3) Limit the scope of use of custom features
// 通过为特性类 加特性 限制其使用范围
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true)]
// 参数一:AttributeTargets —— 特性能够用在哪些地方
// 参数二:AllowMultiple —— 是否允许多个特性实例用在同一个目标上
// 参数三:Inherited —— 特性是否能被派生类和重写成员继承
public class MyCustom2Attribute : Attribute { }
(4) The system's own features - outdated features
// 过时特性
// Obsolete
// 用于提示用户 使用的方法等成员已经过时 建议使用新方法
// 一般加在函数前的特性
internal class TestClass
{
// 参数一:调用过时方法时 提示的内容
// 参数二:true-使用该方法时会报错 false-使用该方法时直接警告
[Obsolete("OldSpeak方法已经过时了,请使用Speak方法", false)]
public void OldSpeak(string str) {
Console.WriteLine(str);
}
public void Speak() { }
}
(5) The system's own features - caller information features
// 哪个文件调用?
// CallerFilePath特性
// 哪一行调用?
// CallerLineNumber特性
// 哪个函数调用?
// CallerMemberName特性
// 需要引用命名空间 using System.Runtime.CompilerServices;
// 一般作为函数参数的特性
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);
}
(6) The system's own features - conditional compilation features
// 条件编译特性
// Conditional
// 它会和预处理指令 #define配合使用
// 需要引用命名空间using System.Diagnostics;
// 主要可以用在一些调试代码上
// 有时想执行有时不想执行的代码
(7) The system's own features - external Dll package function features
// DllImport
// 用来标记非.Net(C#)的函数,表明该函数在一个外部的DLL中定义。
// 一般用来调用 C或者C++的Dll包写好的方法
// 需要引用命名空间 using System.Runtime.InteropServices