C#-特性,反射,动态编程

参考文档

https://www.cnblogs.com/SignX/p/11569837.html

 

特性

侵删https://www.cnblogs.com/forever-Ys/p/10428568.html

一、什么是特性

  特性是一种允许我们向程序的程序集添加元数据的语言结构,它是用于保存程序结构信息的某种特殊类型的类。简单说就是为一个类或者类的属性等添加更多的说明与标记

  MSDN中对它的解释是:特性提供功能强大的方法以将声明信息与 C# 代码(类型、方法、属性等)相关联。特性与程序实体关联后,即可在运行时使用名为“反射”的技术查询属性。

  (有关元数据和反射的知识,点击查看 C# 反射

        公共语言运行时允许你添加类似关键字的描述声明,叫做attributes即特性,它对程序中的元素进行标注,如类型、字段、方法和属性等。Attributes和Microsoft .NET Framework文件的元数据保存在一起,可以用来          向运行时描述你的代码,或者在程序运行的时候影响应用程序的行为。

        在.NET中,Attribute被用来处理多种问题,比如序列化、程序的安全特征、防止即时编译器对程序代码进行优化从而代码容易调试等等。下面,我们先来看几个在.NET中标准的属性的使用,稍后我们再回过          头来讨论Attribute这个类本身。(文中的代码使用C#编写,但同样适用所有基于.NET的所有语言)

 

二、使用特性

  特性的目的是告诉编译器把程序结构的某组元数据嵌入程序集,它可以放置在几乎所有的声明中(但特定的属性可能限制在其上有效的声明类型)。其语法为:

  ● 在结构前放置特性片段来运用特性

  ● 特性片段被方括号包围,其中是特性名和特性的参数列表

  例:

  [Serializable]    //不含参数的特性
    public class MyClass
    {...}

   [MyAttribute("firt","second","finally")]    //带有参数的特性
  public class MyClass {...}

  注: 大多数特性只针对直接跟随在一个或多个特性片段后的结构

 

  单个结构可以运用多个特性,使用时可以把独立的特性片段互相叠在一起或使用分成单个特性片段,特性之间用逗号分隔

C#-特性,反射,动态编程
[Serializable]  
[MyAttribute("firt","second","finally")]    //独立的特性片段
...

[MyAttribute("firt","second","finally"), Serializable] //逗号分隔
...
C#-特性,反射,动态编程

 

  某些属性对于给定实体可以指定多次。例如,Conditional 就是一个可多次使用的属性:

[Conditional("DEBUG"), Conditional("TEST1")]
void TraceMethod()
{
    // ...
}

 

   特性的目标是应用该特性的实体。例如,特性可以应用于类、特定方法或整个程序集。默认情况下,特性应用于它后面的元素。但是,您也可以显式标识要将特性应用于方法还是它的参数或返回值。

C#中标准特性目标名称 适用对象
assembly 整个程序集
module 当前程序集模块(不同于Visual Basic 模块)
field 在类或结构中的字段
event Event
method 方法或get和set属性访问器
param 方法参数或set属性访问器的参数
property Property
return 方法、属性索引器或get属性访问器的返回值
type 结构、类、接口、枚举或委托
typevar 指定使用泛型结构的类型参数

 

三、自定义特性

  特性的用法虽然很特殊,但它只是某个特殊类型的类。

 

  3.1 声明自定义的特性

    总体上声明特性和声明其他类是一样的,只是所有的特性都派生自System.Attribute。根据惯例,特性名使用Pascal命名法并且以Attribute后缀结尾,当为目标应用特性时,我们可以不使用后缀。如:对于SerializableAttribute

和MyAttributeAttribute这两个特性,我们在把它应用到结构的时候可以使用[Serializable和MyAttribute短名

public class MyAttributeAttribute : System.Attribute
{...}

    当然它也有构造函数。和其他类一样,每个特性至少有一个公共构造函数,如果你不声明构造函数,编译器会产生一个隐式、公共且无参的构造函数。

C#-特性,反射,动态编程
public class MyAttributeAttribute : System.Attribute
    {
        public string Description;
        public string ver;
        public string Reviwer;

        public MyAttributeAttribute(string desc,string ver,string Rev)    //构造函数
        {
            Description = desc;
            this.ver = ver;
            Reviwer = Rev;
        }
    }
C#-特性,反射,动态编程

 

  3.2  限制特性的使用

  前面我们已经知道,可以在类上面运用特性,而特性本身就是类,有一个很重要的预定义特性AttributeUsage可以运用到自定义特性上,我们可以用它来限制特性使用在某个目标类型上

  下面的例子使自定义的特性只能应用到方法和类上

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
    public class MyAttributeAttribute : System.Attribute
    {...}

  简单解读一下AttributeUsage特性,它有三个重要的公共属性,如下表

名字 意义 默认值
ValidOn 指定特性允许的目标类型。构造函数的第一个参数必须是AttributeTarget类型的枚举值  
Inherited 布尔值,指示特性能否被派生类和重写成员继承  true
AllowMultiple 布尔值,指示特性能否被重复放置在同一个程序实体前多次  false

  在vs中按f12查阅定义我们可以看到,AttributeTarget枚举的成员有

C#-特性,反射,动态编程

  看一个小例子

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method,   //必须的,指示MyAttribute只能应用到类和方法上
        Inherited = false,   //可选,表明不能被派生类继承
        AllowMultiple = false)]   //可选,表明不能有MyAttribute的多个实例应用到同一个目标上
    public class MyAttributeAttribute : System.Attribute
    {...}

 

  3.3访问特性

  定义好特性了,怎么进行访问呢?对于自定义的特性,我们可以用Type中的IsDefined和GetCustomAttributes方法来获取

 

  3.3.1 使用IsDefined方法

  public abstract bool IsDefined(Type attributeType, bool inherit),它是用来检测某个特性是否应用到了某个类上

  参数说明:    attributeType : 要搜索的自定义特性的类型。 搜索范围包括派生的类型。

        inherit:true 搜索此成员继承链,以查找这些属性;否则为 false。 属性和事件,则忽略此参数

        返回结果: true 如果一个或多个实例 attributeType 或其派生任何的类型为应用于此成员; 否则为 false。

   下面代码片段是用来检查MyAttribute特性是否被运用到MyClass类

MyClass mc = new MyClass();
Type t = mc.GetType();
bool def = t.IsDefined(typeof(MyAttributeAttribute),false);
if (def)
    Console.WriteLine("MyAttribute is defined!");

 

   3.3.2 使用GetCustomAttributes方法

   public abstract object[] GetCustomAttributes(bool inherit),调用它后,会创建每一个与目标相关联的特性的实例

  参数说明: inherit: true 搜索此成员继承链,以查找这些属性;否则为 false

        返回结果:返回所有应用于此成员的自定义特性的数组,因此我们必须将它强制转换为相应的特性类型

 

C#-特性,反射,动态编程
//自定义特性

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] 
    public class MyAttributeAttribute : System.Attribute
    {
        public string Description;
        public string ver;
        public string Reviwer;

        public MyAttributeAttribute(string desc,string ver,string Rev)
        {
            Description = desc;
            this.ver = ver;
            Reviwer = Rev;
        }
    }

//定义类
[MyAttribute("firt","second","finally")]
    class MyClass
    {

    }

 static void Main(string[] args)
        {
            MyClass mc = new MyClass();
            Type t = mc.GetType();
            Object[] obj = t.GetCustomAttributes(false);

            foreach(Attribute a in obj)
            {
                MyAttributeAttribute attr = a as MyAttributeAttribute;
                if(attr != null)
                {
                    Console.WriteLine("Description : {0}", attr.Description);
                    Console.WriteLine("ver : {0}", attr.ver);
                    Console.WriteLine("review: {0}", attr.Reviwer);
                }
            }
        }    
C#-特性,反射,动态编程

结果:C#-特性,反射,动态编程

 

四、预定义的特性

  4.1 Obsolete特性

  Obsolete特性将public ObsoleteAttribute()程序结构标注为过期的,并且在代码编译时显式有用的警告信息,它有三种重载

  public ObsoleteAttribute()

  public ObsoleteAttribute(string message)  参数说明: message:描述了可选的变通方法文本字符串。

  public ObsoleteAttribute(string message, bool error)  参数说明:message:描述了可选的变通方法文本字符串。  error:true 如果使用过时的元素将生成编译器错误; false 如果使用它将生成编译器警告。

  举个例子:

C#-特性,反射,动态编程
using System;
using System.Runtime.CompilerServices;

namespace 特性
{
    class Program
    {
        [Obsolete("Use method SuperPrintOut")]
        static void Print(string str,[CallerFilePath] string filePath = "")
        {
            Console.WriteLine(str);
            Console.WriteLine("filePath {0}", filePath);
        }


        static void Main(string[] args)
        {
            string path = "no path";
            Print("nothing",path);
            Console.ReadKey();
        }
    }
}
C#-特性,反射,动态编程

运行没有问题,不过出现了警告:

C#-特性,反射,动态编程

如果将 [Obsolete("Use method SuperPrintOut")]  改成[Obsolete("Use method SuperPrintOut",true)] 的话,编译则会出现错误信息

 C#-特性,反射,动态编程

 

   4.2 Conditional 特性

  public ConditionalAttribute(string conditionString),指示编译器,如果定义了conditionString编译符号,就和普通方法没有区别,否则忽略代码中方法这个方法的所有调用

C#-特性,反射,动态编程
#define fun    //定义编译符号
using System;
using System.Runtime.CompilerServices;

namespace 特性
{
    class Program
    {
        [Conditional("fun")]
        static void Fun(string str)
        {
            Console.WriteLine(str);
        }

        static void Main(string[] args)
        {
            Fun("hello");
            Console.ReadKey();
        }
    }

}
C#-特性,反射,动态编程

  由于定义了fun,所以Fun函数会被调用,如果没有定义,这忽略Fun函数的调用

 

  4.3 调用者信息特性

  调用者信息特性可以访问文件路径、代码行数、调用成员的名称等源代码信息,这三个特性的名称分别为CallerFilePath、CallerLineNumber和CallerMemberName,这些方法只能用于方法中的可选参数

C#-特性,反射,动态编程
using System;
using System.Runtime.CompilerServices;

namespace 特性
{
    class Program
    {
        static void Print(string str,
            [CallerFilePath] string filePath = "",
            [CallerLineNumber] int num = 0,
            [CallerMemberName] string name = "")
        {
            Console.WriteLine(str);
            Console.WriteLine("filePath {0}", filePath);
            Console.WriteLine("Line {0}", num);
            Console.WriteLine("Call from {0}", name);
        }

        static void Main(string[] args)
        {
            Print("nothing");
            Console.ReadKey();
        }
    }
}
C#-特性,反射,动态编程

C#-特性,反射,动态编程

 

反射

原文链接:https://www.cnblogs.com/Stephenchao/p/4481995.html

反射定义

  反射提供了封装程序集、模块和类型的对象(Type类型)。可以使用反射动态创建类型的实例,将类型绑定到现有对象,或从现有对象获取类型并调用其方法或访问其字段和属性。如果代码中使用了特性,可以利用反射对它们进行访问。【MSDN】

使用场景

  • 需要访问程序元数据的特性。
  • 检查和实例化程序集中的类型。
  • 在运行时构建新类型。使用System.Reflection.Emit中的类。
  • 执行后期绑定,访问在运行时创建的类型的方法。【MSDN】

形象说明

  地球的内部结构:地球的内部结构大体可以分为三层:地壳、地幔和地核。地壳是固体,地核是液体,地幔则是半液半固的结构(地理知识)。如何在地球表面不用深入地球内部就知道其内部结构呢?答案是:向地球发射“地震波”。地震波分两种,一种是横波,另一种是纵波。横波只能穿透固体,而纵波既可以穿透固体又可以穿透液体。通过在地面对纵波和横波的返回情况,我们就可以大体断定地球内部的构造了。

  B型超声波:大家体检的时候都做过B超吧,B超可以透过肚皮探测到你的内脏的生理情况。这是如何做到的呢?答案是:它可以透过肚皮向你体内发射B型超声波,当超声波遇到内脏壁的时候就会产生一定的“回音”反射,然后把“回音”进行处理就可以显示出你的内脏的情况了。(部分细节不予追究)

  大家注意到这两个例子的共同特点,就是从一个对象的外部去了解对象内部的构造,而且都是利用了波的反射功能。在.NET中的反射也可以实现从对象的外部来了解对象(或程序集)内部结构的功能,哪怕你不知道这个对象(或程序集)是什么,另外.NET中的反射还可以动态创建出对象并执行它其中的方法。

  反射是.NET中重要的机制,通过反射,可以在运行时获得程序或程序集中每一个类型(包括类、结构、委托、接口和枚举等)的成员和成员的信息。有了反射,即可对每一个类型了如指掌。另外我还可以直接创建对象,即使这个对象的类型在编译时还不知道。

反射的用途

(1)使用Assembly定义和加载程序集,加载在程序集中的所有模块以及从此程序集中查找类型并创建该类型的实例。
(2)使用Module了解包含模块的程序集以及模块中的类等,还可以获取在模块上定义的所有全局方法或其他特定的非全局方法。
(3)使用ConstructorInfo了解构造函数的名称、参数、访问修饰符(如pulic 或private)和实现详细信息(如abstract或virtual)等。
(4)使用MethodInfo了解方法的名称、返回类型、参数、访问修饰符(如pulic 或private)和实现详细信息(如abstract或virtual)等。
(5)使用FiedInfo了解字段的名称、访问修饰符(如public或private)和实现详细信息(如static)等,并获取或设置字段值。
(6)使用EventInfo了解事件的名称、事件处理程序数据类型、自定义属性、声明类型和反射类型等,添加或移除事件处理程序。
(7)使用PropertyInfo了解属性的名称、数据类型、声明类型、反射类型和只读或可写状态等,获取或设置属性值。
(8)使用ParameterInfo了解参数的名称、数据类型、是输入参数还是输出参数,以及参数在方法签名中的位置等。

反射用到的命名空间

System.Reflection
System.Type
System.Reflection.Assembly

反射用到的主要类

System.Type 类--通过这个类可以访问任何给定数据类型的信息。
System.Reflection.Assembly 类--它可以用于访问给定程序集的信息,或者把这个程序集加载到程序中。

System.Type类用法

  System.Type类对于反射起着核心的作用。但它是一个抽象的基类,Type有与每种数据类型对应的派生类,我们使用这个派生类的对象的方法、字段、属性来查找有关该类型的所有信息。获取给定类型的Type引用有3种常用方式:

1、使用 C# typeof 运算符

Type t = typeof(string);

2、 使用对象GetType()方法

string s = "grayworm";
Type t = s.GetType(); 

3、还可以调用Type类的静态方法GetType()

Type t = Type.GetType("System.String");

Type类的属性

  • Name数据类型名
  • FullName 数据类型的完全限定名(包括命名空间名)
  • Namespace 定义数据类型的命名空间名
  • IsAbstract 指示该类型是否是抽象类型
  • IsArray 指示该类型是否是数组
  • IsClass 指示该类型是否是类
  • IsEnum 指示该类型是否是枚举
  • IsInterface 指示该类型是否是接口
  • IsPublic 指示该类型是否是公有的
  • IsSealed 指示该类型是否是密封类
  • IsValueType 指示该类型是否是值类型

Type类的方法

  • GetConstructor(), GetConstructors():返回ConstructorInfo类型,用于取得该类的构造函数的信息
  • GetEvent(), GetEvents():返回EventInfo类型,用于取得该类的事件的信息
  • GetField(), GetFields():返回FieldInfo类型,用于取得该类的字段(成员变量)的信息
  • GetInterface(), GetInterfaces():返回InterfaceInfo类型,用于取得该类实现的接口的信息
  • GetMember(), GetMembers():返回MemberInfo类型,用于取得该类的所有成员的信息
  • GetMethod(), GetMethods():返回MethodInfo类型,用于取得该类的方法的信息
  • GetProperty(), GetProperties():返回PropertyInfo类型,用于取得该类的属性的信息

我们可以调用这些成员,其方式是调用Type的InvokeMember()方法,或者调用MethodInfo, PropertyInfo和其他类的Invoke()方法。

实例应用

//实例类
class ReflectionClass
{
    public int id;

    private string name;
    /// <summary>
    /// 姓名
    /// </summary>
    public string Name
    {
        get { return name; }
        set { name = value; }
    }
    private string age;
    /// <summary>
    /// 年龄
    /// </summary>
    public string Age
    {
        get { return age; }
        set { age = value; }
    }
    private string sex;
    /// <summary>
    /// 性别
    /// </summary>
    public string Sex
    {
        get { return sex; }
        set { sex = value; }
    }

    public ReflectionClass(string name, string age)
    {
        this.name = name;
        this.age = age;
    }
    public ReflectionClass(string sex)
    {
        this.sex = sex;
    }
    public ReflectionClass()
    { }

    public void Show()
    {
        Console.WriteLine("姓名:" + name + "\n" + "年龄:" + age + "\n" + "性别:" + sex);
    }
}

1、查看类中的构造方法

ReflectionClass rc = new ReflectionClass();
Type t = rc.GetType();
ConstructorInfo[] ciArray = t.GetConstructors(); //获取类的所有构造函数
foreach (ConstructorInfo ci in ciArray)
{
    ParameterInfo[] piArray = ci.GetParameters(); //取出每个构造函数的所有参数
    foreach (ParameterInfo pi in piArray)
    {
        Console.WriteLine(pi.ParameterType.ToString()+"\n"+pi.Name+"\n");
    }
}

 

打印结果:

C#-特性,反射,动态编程
图1-1 查看类中的构造方法


2、用构造函数动态生成对象

 

Type t = typeof(ReflectionClass);
Type[] pt = new Type[2];
pt[0]=typeof(string);
pt[1]=typeof(string);
//根据参数类型获取构造函数
ConstructorInfo ci = t.GetConstructor(pt);
//构造Object数组,作为构造函数的输入参数
object[] obj = new object[2] {"zhangsan","23"};
//调用构造函数生成对象
object o = ci.Invoke(obj);
//调用生成的对象的方法测试是否对象生成成功
((ReflectionClass)o).Show();

 

打印结果:

C#-特性,反射,动态编程
图1-2 用构造函数动态生成对象


3、用Activator生成对象

 

Type t = typeof(ReflectionClass);
object[] obj = new object[2] {"zhangsan","23"};
//用Activator的CreateInstance静态方法,生成新对象
object o = Activator.CreateInstance(t, obj);
((ReflectionClass)o).Show();

打印结果:

C#-特性,反射,动态编程
图1-3 用Activator生成对象


4、查看类中的属性

 

ReflectionClass rc = new ReflectionClass();
Type t = rc.GetType();
PropertyInfo[] piArray = t.GetProperties();
foreach (PropertyInfo pi in piArray)
{
    Console.WriteLine(pi.Name);
}

打印结果:

C#-特性,反射,动态编程
图1-4 查看类中的属性


5、查看类中的public方法

 

ReflectionClass rc = new ReflectionClass();
Type t = rc.GetType();
MethodInfo[] mi = t.GetMethods();
foreach (MethodInfo method in mi)
{
    Console.WriteLine(method.ReturnType + "\n" + method.Name);
}

打印结果:

C#-特性,反射,动态编程
图1-5 查看类中的public方法


6、查看类中的public字段

 

ReflectionClass rc = new ReflectionClass();
Type t = rc.GetType();
FieldInfo[] fi = t.GetFields();
foreach (FieldInfo fieldInfo in fi)
{
    Console.WriteLine(fieldInfo.Name);
}

打印结果:

C#-特性,反射,动态编程
图1-6 查看类中public字段


7、用反射生成对象,并调用属性、方法和字段进行操作

 

ReflectionClass rc = new ReflectionClass();
Type t = rc.GetType();
object obj = Activator.CreateInstance(t);
//取得ID字段
FieldInfo fi = t.GetField("id");
//给ID字段赋值
fi.SetValue(obj, 2);
//取得Name属性
PropertyInfo piName = t.GetProperty("Name");
//给Name属性赋值
piName.SetValue(obj, "jujianfei", null);
PropertyInfo piAge = t.GetProperty("Age");
piAge.SetValue(obj, "23", null);
//取得Show方法
MethodInfo mi = t.GetMethod("Show");
//调用Show方法
mi.Invoke(obj, null);
Console.WriteLine("ID为:" + ((ReflectionClass)obj).id);

 

打印结果:

C#-特性,反射,动态编程
图1-7 综合应用

 

System.Reflection.Assembly类的用法

  Assembly类可以获得程序集的信息,也可以动态的加载程序集,以及在程序集中查找类型信息,并创建该类型的实例。使用Assembly类可以降低程序集之间的耦合性,有利于软件结构的合理化。
1、通过程序集名称返回Assembly对象

Assembly assembly = Assembly.Load("ReflectionDemo2");

2、通过DLL文件名称返回Assembly对象

Assembly assembly = Assembly.LoadFrom("ReflectionDemo2.dll");

3、通过Assembly获取程序集中类

Type t = assembly.GetType("ReflectionDemo2.ReflectionClass"); //参数必须是类的全名

4、通过Assembly获取程序集中所有的类

Type[] tArray = assembly.GetTypes(); 

5、通过程序集的名称反射

Assembly assembly = Assembly.Load("ReflectionDemo2");
Type t = assembly.GetType("ReflectionDemo2.ReflectionClass"); //参数必须是类的全名
object o = Activator.CreateInstance(t,"男");
MethodInfo mi = t.GetMethod("Show");
mi.Invoke(o,null);

打印结果:
C#-特性,反射,动态编程
图1-8 通过程序集的名称反射


6、通过DLL文件全名反射其中的所有类型

 

Assembly assembly = Assembly.LoadFrom("ReflectionDemo2.dll");
Type[] tArray = assembly.GetTypes();
foreach (Type t in tArray)
{
    if (t.FullName == "a.b.c")
    {
        object o = Activator.CreateInstance(t);
    }
}

总结

  上面的例子,都是对类中public修饰的成员的操作,实际上private和protected修饰的成员也可以访问到

 

动态编程

C#-特性,反射,动态编程

上一篇:题解——Acwing.342 道路与航线


下一篇:validator API文档