c#特性(Attribute)与反射(Reflection)学习

最新推荐文章于 2025-03-28 19:48:07 发布

原创最新推荐文章于 2025-03-28 19:48:07 发布 · 843 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#c# #开发语言 #后端

本文深入探讨了.NET中的特性(Attribute)和反射(Reflection)。特性用于在运行时为程序元素添加元数据，如编译器指令和自定义信息。预设的AttributeUsage、Conditional和Obsolete特性分别用于定义自定义特性的使用范围、条件编译和废弃元素标记。自定义特性则允许创建特定用途的元数据标签。反射则允许程序在运行时动态地获取和修改自身状态，如创建对象、调用方法等。虽然反射带来灵活性，但也有性能开销。文章通过实例展示了如何声明、构建、应用和检索自定义特性，以及如何利用反射获取和操作程序元素。

概念

特性(Attribute)
用于在运行时传递程序中各种元素（比如类、方法、结构、枚举、组件等）的行为信息的声明性标签。放置在他所修饰的元素前面用[]包裹，用于添加元数据，如编译器指令和注释、描述、方法、类等其他信息。可以使用预定义的特性或者自定义。

反射(Reflection)
指程序可以访问、检测和修改它本身状态或行为的一种能力。可以使用反射动态地创建类型的**实例，将类型绑定到现有对象，或从现有对象中获取类型。然后，可以调用类型的方法或访问其字段和属性。

特性和反射都是在程序运行时动态地获取或改变运行状态的功能，可以通过特性对程序元素进行标记从而在程序运行时通过反射动态地获取到这些被标记元素，大幅提高灵活性和松耦合。

特性

预设特性

.NET中给了三个预设的特性，AttributeUsage，Conditional，Obsolete

AttributeUsage，用于标注自定义特性的特性,描述自定义特性的应用范围

[AttributeUsage(
   validon,  //AttributeTargets枚举，表示特性可标注的元素类型，字段、属性、方法、类、All等
   AllowMultiple=allowmultiple,  //是否可以多个特性标注一个元素，默认false
   Inherited=inherited  //是否可以被派生元素继承，默认false
)]

关于AttributeTargets枚举：

namespace System
{
    //
    // 摘要:
    //     指定可应用属性的应用程序元素。
    [ComVisible(true)]
    [Flags]
    public enum AttributeTargets
    {
        //
        // 摘要:
        //     特性可以应用于程序集。
        Assembly = 1,
        //
        // 摘要:
        //     特性可以应用于模块中。
        Module = 2,
        //
        // 摘要:
        //     特性可以应用于类。
        Class = 4,
        //
        // 摘要:
        //     特性可以应用于结构;即，类型值。
        Struct = 8,
        //
        // 摘要:
        //     特性可以应用于枚举。
        Enum = 16,
        //
        // 摘要:
        //     特性可以应用于构造函数。
        Constructor = 32,
        //
        // 摘要:
        //     特性可以应用于方法。
        Method = 64,
        //
        // 摘要:
        //     特性可以应用于属性。
        Property = 128,
        //
        // 摘要:
        //     特性可以应用于字段。
        Field = 256,
        //
        // 摘要:
        //     特性可以应用于事件。
        Event = 512,
        //
        // 摘要:
        //     特性可以应用于接口。
        Interface = 1024,
        //
        // 摘要:
        //     特性可以应用于参数。
        Parameter = 2048,
        //
        // 摘要:
        //     特性可以应用于委托。
        Delegate = 4096,
        //
        // 摘要:
        //     特性可以应用于返回的值。
        ReturnValue = 8192,
        //
        // 摘要:
        //     特性可以应用于泛型参数。
        GenericParameter = 16384,
        //
        // 摘要:
        //     特性可以应用于任何应用程序元素。
        All = 32767
    }
}

Conditional,用于指定条件标记，其执行依赖于指定的预处理标识符。比如 Debug 或 Trace，想要一个方法只在调试时执行的话可以这样：

[Conditional("DEBUG")]
public void Send(string message)
{
	console.write(message);}

Obsolete,标记了不应被使用的程序实体,可以告知编译器运行时弃某个特定的目标元素。

[Obsolete(
   message,
   iserror
)]

meseage表示程序执行到此被废弃元素时输出什么信息，iserror为true时表示将此废弃元素的使用视为错误处理。

自定义特性

自定义特性用于存储声明性的信息，且可在运行时被检索，也是和反射结合使用的关键。定义和使用特性有四个主要步骤：

声明
构建
在目标元素上应用
通过反射检索被标记元素

声明

1.需要派生自System.Attribute
2.需要被AttributeUsage特性标记，描述此特性的应用范围

构建

通过在特性的构建中定义一些属性和方法，在特性应用时调用构造方法传入参数，使被标记的元素拥有更丰富的扩展，在通过反射获取到元素，并通过GetCustomAttributes方法获取标记特性时，可以调用其中的属性和方法。

应用

在被标记的目标元素上使用[特性(参数)]的方式实现应用。

通过反射检索

通过反射获取被自定义特性所标记的元素。可通过System.Attribute类中的方法进行检索。后面讲反射详细说明。

反射(Reflection)

反射最重要的在于动态，无需在程序代码中定义好需要用到的对象、需要调用的方法等，而在程序运行时根据需要动态创建实例，调用方法，改变状态，提高灵活性。

优缺点

优点：

1、反射提高了程序的灵活性和扩展性。
2、降低耦合性，提高自适应能力。
3、它允许程序创建和控制任何类的对象，无需提前硬编码目标类，降低代码量。
缺点：

1、性能问题：使用反射基本上是一种解释操作，用于字段和方法接入时要远慢于直接代码。因此反射机制主要应用在对灵活性和拓展性要求很高的系统框架上，普通程序不建议使用。
2、使用反射会模糊程序内部逻辑；程序员希望在源代码中看到程序的逻辑，反射却绕过了源代码的技术，因而会带来维护的问题，反射代码比相应的直接代码更复杂。

用途

反射（Reflection）有下列用途：

在运行时查看特性（attribute）信息。
审查集合中的各种类型，以及实例化这些类型。
延迟绑定的方法和属性（property）。
在运行时创建新类型，然后使用这些类型执行一些任务。

使用方法

前面讲可以反射获取被自定义特性标记的元素，初次之外，反射还可以通过元素名来获取该元素以及该元素所包含的各种元素。这些元素都包括哪些内容呢？这就需要先了解几个概念：程序集(Assembly)、
模块(Module)、类型(Type)(也可以说是Class类)、成员（Member）以及其他常见的基本元素方法(Method)、属性(Property)、字段(Field)、值(Value)等，反射提供一种编程的方式，可以在程序运行期获得这几个组成部分的相关信息

程序集，程序集构成了 .NET 应用程序的部署、版本控制、重用、激活范围和安全权限的基本单元。程序集是为协同工作而生成的类型和资源的集合，这些类型和资源构成了一个逻辑功能单元。程序集采用可执行文件 (.exe) 或动态链接库文件 (.dll) 的形式，是 .NET 应用程序的构建基块。它们向公共语言运行时提供了注意类型实现代码所需的信息。
通过System.Reflection.Assembly类来获取正在运行的装配件信息，使用 Assembly 类加载程序集、浏览程序集的元数据和构成部分、发现程序集中包含的类型以及创建这些类型的实例。可以通过Assembly.Load()方法获取装配件，传入装配件的路径作为参数，因为一般情况下程序编译产生的额装配件都在同一目录下，所以传入相对路径即可，也可以用Assembly.LoadFile()传入绝对路径。
可以从一个或多个源代码文件生成程序集,程序集可以包含一个或多个模块。
模块，是可移植的可执行文件，例如 type.dll 或 application.exe，由一个或多个类和接口组成。单个模块可包含多个命名空间，而一个命名空间可跨越多个模块。
类型Class及其相关联元素不再说明。

元素检索方法
可通过GetTypes()和GetType()方法获取类，第一个获取程序集下所有的类，返回一个数组，第二个要有参数，类名为完全类名：命名空间+类名,用于获取指定的类。
获取到一个类之后，就可以获取其包含的属性字段方法等，ConstructorInfo获取构造函数, FieldInfo获取字段, MethodInfo获取方法,PropertyInfo获取属性,EventInfo获取事件，ParameterInfo获取参数,通过他们的Get***获取,加s获取所有返回数组，不加s获取具体的。
BindFlags：对于检索得到的元素进行筛选，作为条件的枚举，例如public,static等，在Get元素的时候作为参数传进去，用“|”多选。
Activator：动态创建实例化对象，获取到Type之后，可以通过Activator.CreateInstance(t)创建这个类型的实例。如果这个类没有无参构造函数的话，还需要传入参数，注意传入的参数是一个Object，例如Activator.CreateInstance(t，new Object[]{“hello”}).