天天看点

特性和反射

特性

特性(Attribute)是用于在运行时传递程序中各种元素(比如类、方法、结构、枚举、组件等)的行为信息的声明性标签。我们可以通过使用特性向程序添加声明性信息。一个声明性标签是通过放置在它所应用的元素前面的方括号([ ])来描述的。

特性(Attribute)用于添加元数据,如编译器指令和注释、描述、方法、类等其他信息。.Net 框架提供了两种类型的特性:预定义特性和自定义特性。

元数据是什么?我们可以认为元数据是结构化的数据,它是从数据中提取出来的用于说明其特征、内容的结构化的数据。例如:一只猫有体重、毛色两个属性,则体重毛色就是元数据。元数据是用来描述一个数据的特征的数据。

Obsolete特性

我们在更新代码的过程中,有个方法已经被弃用了,但是在一个类中又正在使用这个方法,我们不能够删除这个方法,那么我们要怎么去提醒开发人员不再使用这个方法呢?我们可以在该方法前面使用Obsolete特性。

[Obsolete("This is the OldMethod,Please use the NewMethod")] //如果加个true则不能调用这个方法
        static void OldMethod()
        {
            Console.WriteLine("OldMethod");
        }

        static void NewMethod()
        {

        }

static void Main(string[] args)
        {
            OldMethod();
            NewMethod();
            Console.ReadKey();
        }
           

我们使用这个特性之后,当我们再去调用这个方法,IDE会提示我们这个方法已经被弃用,推荐使用新的方法,如果在特性的字符串后面添加true,那么这个方法就不能够被使用了,不推荐这种用法。

Conditional特性

当我们写一个大型程序的时候,我们需要取消某个方法的调用,只能在代码中在每一处使用了这个方法的代码都删除掉,但是Conditional特性能够直接取消特定方法的调用,即使在某个类里调用了该方法,该方法也不会执行。

#define IsTest1 //若添加了宏定义,则Conditional特性失效,我们可以通过宏定义随时控制特性是否生效
using System;
...
[Conditional("IsTest1")] //这个特性能允许我们包括或取消特定方法的所有调用
        static void Tes1()
        {
            Console.WriteLine("Test1");
        }

        static void Tes2()
        {
            Console.WriteLine("Test2");
        }
           

值得注意的是,即使添加了这个特性,该方法不被调用,但是定义方法的CIL本身还是会包含在程序集里。

DebuggerStepThrough特性

当我们调试程序时,有一些方法我们认为已经是确定无误的方法,可以使用这个特性,在调试过程中就可以直接跳过该方法。

[DebuggerStepThrough]
        static void PrintOut(string str,string filePath,
            int lineNumber,string methodName)
        {
            Console.WriteLine(str);
            Console.WriteLine(filePath);
            Console.WriteLine(lineNumber);
            Console.WriteLine(methodName);
        }
           

这时候如果我们开始调试程序,主函数里一旦遇到PrintOut方法,不会跳进这个方法体内,会直接往后执行。这个特性能够减少我们调试程序的时间。

Caller特性

在C#中我们可以获取当前类参数的属性,比如路径,行数,方法名。

CallerFilePath:获取当前类编译的所在路径

CallerLineNumber:获取程序在哪一行调用方法

CallerMemberName:获取是哪个类调用了这个方法

static void PrintOut(string str, [CallerFilePath]string filePath = "",[CallerLineNumber]int lineNumber = , [CallerMemberName]string methodName = "")
        {
            Console.WriteLine(str);
            Console.WriteLine(filePath);
            Console.WriteLine(lineNumber);
            Console.WriteLine(methodName);
        }
           

使用这一类特性的时候需要初始化参数。

自定义特性

特性本质上也是一个类,我们可以在项目中添加自己想要的特性。

添加特性类需要注意四点:

  1. 特性类的后缀以Attribute结尾
  2. 特性类需要继承System.Attribute类
  3. 特性类需要被声明为sealed
  4. 特性类用来目标结构的一些状态(字段、属性),所以一般不定义方法
[AttributeUsage(AttributeTargets.Class)] //表示该特性类可以应用到的程序结构有哪些
    sealed class MyClassAttribute:System.Attribute
    {
        public int ID { get; set; }
        public string Description { get; set; }
        public int VersionNumber { get; set; }

        public MyClassAttribute(string des)
        {
            this.Description = des;
        }
    }
           

我们定义的特性类是用于类的,用法如下

//通过制定属性的名字,给属性赋值,这种叫命名参数
    [MyClass("简单的特性类",ID=)] //当我们使用特性类时,后面的Attribute不需要写
    class Program
    {
    }
           

反射

反射指程序可以访问、检测和修改它本身状态或行为的一种能力。

程序集包含模块,而模块包含类型,类型又包含成员。反射则提供了封装程序集、模块和类型的对象。

我们可以使用反射从现有对象中获取类型。然后,可以调用类型的方法或访问其字段和属性。

我们先创建一个用于测试的类

class myClass
    {
        private int id;
        private int age;
        public int number;
        public string Name { get; set; }
        public string Name2 { get; set; }
        public string Name3 { get; set; }

        public void Test1()
        {

        }

        public void Test2()
        {

        }


    }
           

每个类都对应着一个type,这个type对象存储了有哪些方法、成员、数据。

所以我们需要创建myClass类的对象以获取type对象

myClass mc = new myClass();//一个类中的数据是存储在对象中的,但是type对象只存储类的成员
            Type type = mc.GetType();//通过对象获取这个类的type对象
           

然后我们可以通过type对象来获取类的名字、命名空间、程序集、公共成员、属性、方法以及程序集里所有的类型。

  1. 类名
  1. 命名空间
  1. 程序集
  1. 公共成员
FieldInfo[] fi = type.GetFields(); 
foreach (FieldInfo info in fi)
{
   Console.Write(info.Name+" ");
}
           
  1. 属性
PropertyInfo[] pi = type.GetProperties(); 
foreach (PropertyInfo info in pi)
{
   Console.Write(info.Name+" ");
}
           
  1. 方法
MethodInfo[] mi = type.GetMethods(); 
foreach (MethodInfo info in mi)
{
   Console.Write(info.Name + " ");
}
           
  1. 通过Type对象获取程序集
myClass mc = new myClass();;
Assembly assem = mc.GetType().Assembly; 
Console.WriteLine(assem.FullName);
           
  1. 获取程序集内所有类型
Type[] types = assem.GetTypes();
foreach (var type in types) 
{
   Console.WriteLine(type);
}
           

我们在前面创建了一个自己的特性类,我们可以利用type对象来获取特性类的属性

Type type = typeof(Program); //通过typeof+类名也可以获取type对象 等同于type.GetType方法
            object[] ob = type.GetCustomAttributes(false); //创建一个Object对象来存储获取到的特性属性,因为不需要检查基类里的特性,所以为false
            MyClassAttribute myClass = ob[] as MyClassAttribute; //将对象转换成MyClassAttribute类型
            Console.WriteLine(myClass.Description);
            Console.WriteLine(myClass.ID);
           

总结

特性

  • Obsolete特性:提示旧方法已被弃用,通过true和false来控制方法是否还能够被调用
  • Conditional特性:能够控制特定的方法在整个程序内全都无法调用,可以通过宏定义来决定该特性是否生效。(方法即使不被调用,定义方法的CIL代码依旧会包含在程序集里)
  • DebuggerStepThrough特性:能够在debug过程中跳过我们已经确定无误的方法,节省调试的精力
  • 自定义特性:1.特性类后缀以Attribute结尾 2.需要集成System.Attribute 3.声明为sealed 4.特性类不定义方法,只定义字段属性 5.使用特性类时后面的Attribute不需要写

反射

  • 每个类都对应着type对象,这个type对象存储了这个类的成员、方法,不存储具体数据
  • 通过type对象可以获取这个类的名字、命名空间、程序集、程序集内所有类型、公共成员、属性、方法