zoukankan      html  css  js  c++  java
  • .Net Attribute特性

    1、什么是Atrribute 
    首先,我们肯定Attribute是一个类,下面是msdn文档对它的描述: 
    公共语言运行时允许你添加类似关键字的描述声明,叫做attributes, 它对程序中的元素进行标注,如类型、字段、方法和属性等。Attributes和Microsoft .NET Framework文件的元数据保存在一起,可以用来向运行时描述你的代码,或者在程序运行的时候影响应用程序的行为。

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

    3、Attribute类 
    除了.NET提供的那些Attribute派生类之外,我们可以自定义我们自己的Attribute,所有自定义的Attribute必须从Attribute类派生。现在我们来看一下Attribute 类的细节:

    protected Attribute(): 保护的构造器,只能被Attribute的派生类调用。

    三个静态方法:

    static Attribute GetCustomAttribute():这个方法有8种重载的版本,它被用来取出施加在类成员上指定类型的Attribute。

    static Attribute[] GetCustomAttributes(): 这个方法有16种重载版本,用来取出施加在类成员上指定类型的Attribute数组。

    static bool IsDefined():由八种重载版本,看是否指定类型的定制attribute被施加到类的成员上面。

    实例方法:

    bool IsDefaultAttribute(): 如果Attribute的值是默认的值,那么返回true。

    bool Match():表明这个Attribute实例是否等于一个指定的对象。

    公共属性: TypeId: 得到一个唯一的标识,这个标识被用来区分同一个Attribute的不同实例。

    我们简单地介绍了Attribute类的方法和属性,还有一些是从object继承来的。这里就不列出来了。

    下面介绍如何自定义一个Attribute: 自定义一个Attribute并不需要特别的知识,其实就和编写一个类差不多。自定义的Attribute必须直接或者间接地从Attribute这个类派生,如:

    public MyCustomAttribute : Attribute { ... }

    这里需要指出的是Attribute的命名规范,也就是你的Attribute的类名+"Attribute",当你的Attribute施加到一个程序的元素上的时候,编译器先查找你的Attribute的定义,如果没有找到,那么它就会查找“Attribute名称"+Attribute的定义。如果都没有找到,那么编译器就报错。

    4、定义或控制特性的使用

    对于一个自定义的Attribute,你可以通过AttributeUsage的Attribute来限定你的Attribute 所施加的元素的类型。代码形式如下: 
    [AttriubteUsage(参数设置)] public 自定义Attribute : Attribute { ... }

    作为参数的AttributeTarges的值允许通过“或”操作来进行多个值得组合,如果你没有指定参数,那么默认参数就是All 。 AttributeUsage除了继承Attribute 的方法和属性之外,还定义了以下三个属性:

    AllowMultiple: 读取或者设置这个属性,表示是否可以对一个程序元素施加多个Attribute 。

    Inherited:读取或者设置这个属性,表示是否施加的Attribute 可以被派生类继承或者重载。

    ValidOn: 读取或者设置这个属性,指明Attribute 可以被施加的元素的类型。

    下面让我们来做一些实际的东西。我们将会在Help特性前放置AttributeUsage特性以期待在它的帮助下控制Help特性的使用。

    隐藏行号 复制代码 ?这是一段程序代码。
    1. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
      
    2. public class HelpAttribute : Attribute
      
    3. {
      
    4.     public HelpAttribute(String Description_in)
      
    5.     {
      
    6.         this.description = Description_in;
      
    7.     }
      
    8. 
      
    9.     protected String description;
      
    10. 
      
    11.     public String Description
      
    12.     {
      
    13.         get
      
    14.         {
      
    15.             return this.description;
      
    16.         }
      
    17.     }
      
    18. }
      

    代码讨论

    • 属性 AttributeUsage 指定该属性可以应用于的语言元素。
    • 属性类是从 System.Attribute 派生的公共类,至少有一个公共构造函数。
    • 属性类有两种类型的参数:
      •       “定位参数”,每次使用属性时都必须指定这些参数。定位参数被指定为属性类的构造函数参数。在上面的示例中,url 便是一个定位参数。
      •      “命名参数”,可选。如果使用属性时指定了命名参数,则必须使用参数的名称。通过包含非静态字段或属性来定义命名参数。在上面的示例中,Topic 便是一个命名参数。

    先让我们来看一下AttributeTargets.Class。它规定了Help特性只能被放在class的前面。这也就意味着下面的代码将会产生错误:

    隐藏行号 复制代码 ?这是一段程序代码。
    1. [Help("this is a do-nothing class")]
      
    2. public class AnyClass
      
    3. {
      
    4.     [Help("this is a do-nothing method")] //error 
      
    5.     public void AnyMethod()
      
    6.     {
      
    7.     }
      
    8. }
      

    编译器报告错误如下:

    AnyClass.cs: Attribute 'Help' is not valid on this declaration type.

    It is valid on 'class' declarations only.

    我们可以使用AttributeTargets.All来允许Help特性被放置在任何程序实体前。可能的值是:

    Assembly,Module,Class,Struct,Enum,Constructor,Method,Property,Field,Event,Interface, 
    Parameter,Delegate。

    All = Assembly | Module | Class | Struct | Enum | Constructor | Method | Property | Field | Event | Interface | Parameter | Delegate,

    ClassMembers = Class | Struct | Enum | Constructor | Method | Property | Field | Event | Delegate | Interface )

    下面考虑一下AllowMultiple = false。它规定了特性不能被重复放置多次。

    隐藏行号 复制代码 ?这是一段程序代码。
    1. [Help("this is a do-nothing class")]
      
    2. [Help("it contains a do-nothing method")]
      
    3. public class AnyClass
      
    4. {
      
    5.     [Help("this is a do-nothing method")] //error 
      
    6.     public void AnyMethod()
      
    7.     {
      
    8.     }
      
    9. }
      

    它产生了一个编译期错误。

    AnyClass.cs: Duplicate 'Help' attribute

    Ok,现在我们来讨论一下最后的这个属性。Inherited, 表明当特性被放置在一个基类上时,它能否被派生类所继承。

    隐藏行号 复制代码 ?这是一段程序代码。
    1. [Help("BaseClass")]
      
    2. public class Base
      
    3. {
      
    4. }
      
    5. 
      
    6. public class Derive : Base
      
    7. {
      
    8. }
      

    这里会有四种可能的组合:

    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ]

    [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]

    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]

    [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ]

    第一种情况:

    如果我们查询(Query)(稍后我们会看到如何在运行期查询一个类的特性)Derive类,我们将会发现Help特性并不存在,因为inherited属性被设置为false。

    第二种情况:

    和第一种情况相同,因为inherited也被设置为false。

    第三种情况:

    为了解释第三种和第四种情况,我们先来给派生类添加点代码:

    隐藏行号 复制代码 ?这是一段程序代码。
    1. [Help("BaseClass")]
      
    2. public class Base
      
    3. {
      
    4. }
      
    5. 
      
    6. [Help("DeriveClass")]
      
    7. public class Derive : Base
      
    8. {
      
    9. }
      

    现在我们来查询一下Help特性,我们只能得到派生类的属性,因为inherited被设置为true,但是AllowMultiple却被设置为false。因此基类的Help特性被派生类Help特性覆盖了。

    第四种情况:

    在这里,我们将会发现派生类既有基类的Help特性,也有自己的Help特性,因为AllowMultiple被设置为true。

            • 通过反射访问属性

    属性与程序元素关联后,可以使用反射查询属性存在及其值。查询属性的主要反射方法包含在 System.Reflection.MemberInfo 类(GetCustomAttributes 方法族)中。下面的示例演示使用反射获取对属性的访问的基本方法:

    隐藏行号 复制代码 ?这是一段程序代码。
    1. System.Reflection.MemberInfo info = typeof(Help);
      
    2. object[] attributes = info.GetCustomAttributes(true);
      
    3. for (int i = 0; i < attributes.Length; i++)
      
    4. {
      
    5.     System.Console.WriteLine(attributes[i]);
      
    6. }
      

    1.特性Attribute不能和属性Property混为一谈, 这是完全不同的两个东西.

    2.特性Attribute给类或方法标识的内容, 可以在程序运行的时侯, 通过反射获取到.

       例如1: .net添加的单元测试类, 里面有TestClass标识,里面的方法有TestMethod标识, 当用户想运行测试用例时, 一点按钮, 所有的测试用例类, 每个类中的测试方法就都显示在面前, 用户可以自由的选择运行哪些测试类及类中的哪些测试方法, 这是怎么做到的, 相信就是.net通过反射得到所有的TestClass标识的类, 做成一个list显示给用户, 点开这个类, 再通过反射得到所有该类中有TestMethod标识的方法, 再显示给用户, 就这样做到的.

       例如2:[Obsolete("这是一个过时的方法")] 加在一个方法或类前时,编译器能提示您这是一个过时的方法,如何做到的?肯定是编译程序时要扫描方法前是否有这个标志,如果有,就给记录下来,显示出来。

    3.特性Attribute这个东西类似静态的常量, 属于类所有, 不隶属于每一个特定的对象, 如果没有特性Attribute这个东西, 很多事情就很难做到.

    4.内置的三个重要特性Attribute和一个枚举enum AttributeTargets

       AttributeUsage
       ComVisible
       SerializableAttribute

       后两个特性实际上代码很简单,就是一个标志, 如SerializableAttribute。

    namespace System
    {
        [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Delegate, Inherited = false)]
        [ComVisible(true)]
        public sealed class SerializableAttribute : Attribute
        {
            public SerializableAttribute();
        }
    }

         AttributeUsage比较重要,有三个重要的参数可以设置,

         AttributeTargets 这是一个枚举,列出了自定义特性可以用来修饰谁,Class, interface 或者全都可以,多个中间用|隔开。如果你用一个只允许AttributeTargets.Class的特性修饰一个interface去,那注定编译失败。

    [AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Interface | AttributeTargets.Delegate, Inherited = false)]

         AllowMultiple 表示是否可以重复放置此特性来修饰一个方法或类。

        [Lzd(Name = "Animal")]
        [Lzd(Name = "Animals")] 
        public class Animal
        {
            ...
        }

         Inherited 表示是否可以被继承

         如果Inherited = false,则派生类继承不了特性。

         如果Inherited = true, 派生类可以继承特性,但是,如果AllowMultiple = false, 那么,如果派生类自己也加了同样的特性,则父类的特性会被屏蔽。

  • 相关阅读:
    lnmp架构下php安全配置分享
    Nginx配置文件nginx.conf中文详解
    记一次lnmp环境下无法执行php文件
    nginx php-fpm 输出php错误日志
    [php基础]记录PHP错误日志 display_errors与log_errors的区别
    [linux常用命令]查看当前文件夹或该文件夹下文件(夹)的大小
    [php基础]PHP Form表单验证:PHP form validator使用说明
    nginx负载均衡配置
    [php基础]Mysql日期函数:日期时间格式转换函数详解
    [php基础]PHP环境变量$_SERVER和系统常量详细说明
  • 原文地址:https://www.cnblogs.com/eric-qin/p/4300901.html
Copyright © 2011-2022 走看看