C# 知识回顾 - 特性 Attribute

【博主】反骨仔    【原文地址】http://www.cnblogs.com/liqingwen/p/5911289.html

目录

一、特性简介

  特性提供功能强大的方法,用以将元数据或声明信息与代码(程序集、类型、方法、属性等)相关联。特性与程序实体关联后,可在运行时使用“反射”查询特性。

  特性具有以下属性:

    (1)特性可向程序中添加元数据。元数据是有关在程序中定义的类型的信息。所有的 .NET 程序集都包含指定的一组元数据,这些元数据描述在程序集中定义的类型和类型成员。可以添加自定义特性,以指定所需的任何附加信息。

    (2)可以将一个或多个特性应用到整个程序集、模块或较小的程序元素(如类和属性)。

    (3)特性可以与方法和属性相同的方式接受参数。

    (4)程序可以使用反射检查自己的元数据或其他程序内的元数据。

二、使用特性

  特性可以放置在几乎所有的声明中(但特定的特性可能限制在其上有效的声明类型)。在 C# 中,特性的指定方法为:将括在方括号中的特性名置于其应用到的实体的声明上方。它必须位于所应用于的元素的紧前面并与该元素在同一行。

     [Serializable]  //使用特性 SerializableAttribute
     internal class MyClass
     {
         [DllImport("user32.dll")]   //使用特性 DllImportAttribute
         private static extern void Do();

         #region 一个声明上可放置多个特性

         private void MethodA([In][Out]ref double n) { }
         private void MethodB([In, Out]ref double n) { }

         #endregion 一个声明上可放置多个特性

         #region 某些特性对于给定实体可以指定多次

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

         #endregion 某些特性对于给定实体可以指定多次
     }

  【注意】根据约定,所有特性名称都以单词“Attribute”结束,以便将它们与“.NET Framework”中的其他项区分。但是,在代码中使用特性时,不需要指定 attribute 后缀。

三、特性的参数

  许多特性都有参数,而这些参数可以是定位参数、未命名参数或命名参数。任何定位参数都必须按特定顺序指定并且不能省略,而命名参数是可选的且可以按任意顺序指定。首先指定定位参数。例如,这三个特性是等效的:

 [DllImport("user32.dll")]
 [DllImport("user32.dll", SetLastError=false, ExactSpelling=false)] 

  第一个参数(DLL 名称)是定位参数并且总是第一个出现,其他参数为命名参数。在这种情况下,两个命名参数均默认为 false,因此可将其省略。

四、特性的目标

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

  若要显式标识特性目标,语法:

[target : attribute-list]
特性目标
C# 适用对象
assembly 整个程序集
module 当前程序集模块
field 在类或结构中的字段
event event
method 方法或 get 和 set 属性访问器
param 方法参数或 set 属性访问器参数
property 属性
return 方法、属性索引器或 get 属性访问器的返回值
type 结构、类、接口、枚举或委托
//示例:将特性应用于程序集和模块
[assembly: AssemblyTitle("assembly 4.6.1")]
[module: CLSCompliant(true)]
 //示例:将特性应用于方法、方法参数和方法返回值

 //默认:应用于方法
 [SomeAttr]
 ; } 

 //指定应用于方法
 [method: SomeAttr]
 ; } 

 //指定应用于返回值
 [return: SomeAttr]
 ; }

五、特性的常见用途

  以下列表包含特性的几个常见用途:

    (1)在 Web 服务中,使用 WebMethod 特性来标记方法,以指示该方法应该可通过 SOAP 协议进行调用。

    (2)描述当与本机代码进行交互操作时如何封送方法参数。有关更多信息。

    (3)描述类、方法和接口的 COM 属性。

    (4)使用 DllImportAttribute 类调用非托管代码。

    (5)在标题、版本、说明或商标方面描述您的程序集。

    (6)描述要持久性序列化类的哪些成员。

    (7)描述如何映射类成员和 XML 节点以便进行 XML 序列化。

    (8)描述方法的安全要求。

    (9)指定用于强制安全性的特性。

    (10)由实时 (JIT) 编译器控制优化,以便易于调试代码。

    (11)获取有关调用方的信息的方法。

六、创建自定义的特性

  通过定义一个特性类,可以创建您自己的自定义特性。该特性类直接或间接地从 Attribute 派生,有助于方便快捷地在元数据中标识特性定义。

     /// <summary>
     /// 角色特性
     /// </summary>
     /// RoleAttribute:特性的名称,继承 Attribute,为自定义特性
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
     public class RoleAttribute : Attribute
     {
         private string _name;

         /// <summary>
         /// 启用标识
         /// </summary>
         /// IsEnable:命名参数
         public bool IsEnable { get; set; }

         /// <summary>
         /// 构造函数
         /// </summary>
         /// <param name="name"></param>
         /// name:定位参数
         public RoleAttribute(string name)
         {
             _name = name;
         }
     }
     [Role("Me", IsEnable = true)]   //调用特性的方式
     public class OurClass
     {

     }

  构造函数的参数是自定义特性的定位参数,任何公共的读写字段或属性都是命名参数。【注意】 AttributeUsage 特性,在这里它使得 Role 特性仅在类和 struct 声明中有效。

     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true)]  //AllowMultiple:该值指示能否为一个程序多次使用该特性
     public class RoleAttribute : Attribute
     {
         //... ...
     }
     [Role("You")]            //在同一个类上多次使用
     [Role("Me", IsEnable = true)]
     public class OurClass
     {
         //... ...
     }

  【注意】如果特性类包含一个属性,则该属性必须为读写属性。

七、使用反射访问特性

  使用反射,可检索用自定义特性定义的信息。主要方法是 GetCustomAttributes,它返回对象数组,这些对象在运行时等效于源代码特性。

     /// <summary>
     /// 角色特性
     /// </summary>
     /// RoleAttribute:特性的名称,继承 Attribute,为自定义特性
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
     public class RoleAttribute : Attribute
     {
         private string _name;
         /// <summary>
         /// 启用标识
         /// </summary>
         public bool IsEnable { get; set; }

         /// <summary>
         /// 构造函数
         /// </summary>
         /// <param name="name"></param>
         public RoleAttribute(string name)
         {
             _name = name;
         }
     }

RoleAttribute.cs

     [Role("Me", IsEnable = true)]
     public class OurClass
     {
         //... ...
     }

  概念上等效于

     RoleAttribute role = new RoleAttribute("Me");
     role.IsEnable = true;

  但是,直到查询 OurClass 来获取特性后才会执行此代码。对 OurClass 调用 GetCustomAttributes 会导致按上述方式构造并初始化一个 RoleAttribute 对象。如果该类具有其他特性,则按相似的方式构造其他特性对象。然后 GetCustomAttributes 返回 RoleAttribute 对象和数组中的任何其他特性对象。之后就可以对此数组进行迭代,确定根据每个数组元素的类型所应用的特性,并从特性对象中提取信息。

  这里,定义一个自定义特性,将其应用于若干实体并通过反射进行检索。

     /// <summary>
     /// 角色特性
     /// </summary>
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = true)]
     public class RoleAttribute : Attribute
     {
         private readonly string _name;

         /// <summary>
         /// 启用标识
         /// </summary>
         public bool IsEnable { get; set; }

         /// <summary>
         /// 构造函数
         /// </summary>
         /// <param name="name"></param>
         public RoleAttribute(string name)
         {
             _name = name;
         }

         public string GetName()
         {
             return _name;
         }
     }
    class MyClass1 { }

    [Role("Me")]
    class MyClass2 { }

    [Role("Me"), Role("You", IsEnable = true)]
    class MyClass3 { }
     class Program
     {
         static void Main(string[] args)
         {
             Output(typeof(MyClass1));
             Output(typeof(MyClass2));
             Output(typeof(MyClass3));

             Console.Read();
         }

         /// <summary>
         /// 输出
         /// </summary>
         /// <param name="t"></param>
         static void Output(Type t)
         {
             Console.WriteLine($"Class: {t}");

             var attributes = t.GetCustomAttributes();
             foreach (var attribute in attributes)
             {
                 var attr = attribute as RoleAttribute;

                 if (attr == null)
                 {
                     return;
                 }

                 Console.WriteLine($"    Name: {attr.GetName()}, IsEnable: {attr.IsEnable}");
             }
         }
     }

传送门

  《只是想简单说下表达式树 - Expression Trees

  《只是想简单说下序列化


【参考】微软官方文档

[C#] C# 知识回顾 - 特性 Attribute的更多相关文章

  1. [C#] C# 知识回顾 - 你真的懂异常(Exception)吗?

    你真的懂异常(Exception)吗? 目录 异常介绍 异常的特点 怎样使用异常 处理异常的 try-catch-finally 捕获异常的 Catch 块 释放资源的 Finally 块 一.异常介 ...

  2. [C#] C# 知识回顾 - 学会处理异常

    学会处理异常 你可以使用 try 块来对你觉得可能会出现异常的代码进行分区. 其中,与之关联的 catch 块可用于处理任何异常情况. 一个包含代码的 finally 块,无论 try 块中是否在运行 ...

  3. [C#] C# 知识回顾 - 学会使用异常

    学会使用异常 在 C# 中,程序中在运行时出现的错误,会不断在程序中进行传播,这种机制称为“异常”. 异常通常由错误的代码引发,并由能够更正错误的代码进行 catch. 异常可由 .NET 的 CLR ...

  4. [C#] C# 知识回顾 - 异常介绍

    异常介绍 我们平时在写程序时,无意中(或技术不够),而导致程序运行时出现意外(或异常),对于这个问题, C# 有专门的异常处理程序. 异常处理所涉及到的关键字有 try.catch 和 finally ...

  5. [.NET] C# 知识回顾 - Event 事件

    C# 知识回顾 - Event 事件 [博主]反骨仔 [原文]http://www.cnblogs.com/liqingwen/p/6060297.html 序 昨天,通过<C# 知识回顾 - ...

  6. [.NET] C# 知识回顾 - 事件入门

    C# 知识回顾 - 事件入门 [博主]反骨仔 [原文]http://www.cnblogs.com/liqingwen/p/6057301.html 序 之前通过<C# 知识回顾 - 委托 de ...

  7. [.NET] C# 知识回顾 - 委托 delegate (续)

    C# 知识回顾 - 委托 delegate (续) [博主]反骨仔 [原文]http://www.cnblogs.com/liqingwen/p/6046171.html 序 上篇<C# 知识回 ...

  8. [C#] C# 知识回顾 - 委托 delegate

    C# 知识回顾 - 委托 delegate [博主]反骨仔 [原文]http://www.cnblogs.com/liqingwen/p/6031892.html 目录 What's 委托 委托的属性 ...

  9. [C#] 剖析 AssemblyInfo.cs - 了解常用的特性 Attribute

    剖析 AssemblyInfo.cs - 了解常用的特性 Attribute [博主]反骨仔 [原文]http://www.cnblogs.com/liqingwen/p/5944391.html 序 ...

随机推荐

  1. Atitit 代码复用的理解attilax总结

    Atitit 代码复用的理解attilax总结 1.1. 继承1 1.1.1. 模式1:原型继承1 1.1.2. 模式2:复制所有属性进行继承 拷贝继承1 1.1.3. 模式3:混合(mix-in)1 ...

  2. save(),saveOrUpdate(),merge()的区别

    Save save()方法能够保存实体到数据库,正如方法名称save这个单词所表明的意思.我们能够在事务之外调用这个方法,这也是我不喜欢使用这个方法保存数据的原因.假如两个实体之间有关系(例如empl ...

  3. Struts2配置Result(Struts2_result)

    一.概要 二.常用四种类型的配置 Struts.xml <?xml version="1.0" encoding="UTF-8" ?> <!D ...

  4. Eclipse for j2ee 无法调式问题

    首先要配置tomcat,window--preference--server--Installed Runtimes, add--选择tomcat--next--选择tomcat的安装目录(根目录)- ...

  5. vs2012中编译时出现程序集所使用的版本高于所引用的版本

    我在运行别人的项目时出现版本不兼容的问题:

  6. 1-2+3-4+5-6+7......+n的几种实现

    本文的内容本身来自一个名校计算机生的一次面试经历,呵呵,没错,你猜对了,肯定 不是我 个人很喜欢这两道题,可能题目原本不止两道,当然,我这里这分析我很喜欢的两道. 1.写一个函数计算当参数为n(n很大 ...

  7. topcoder-srm701-div2-900 博弈\计算二进制位1的个数\dp\状态压缩

    借用一下qls翻译过来的题面  现在有 n 个石子,A 和 B 轮流取石子,A先,每次最多可以取 m 个石子,取到最后一个石子的人获胜,但是某个人如果取完石子时候剩余石子数的二进制表示中有奇数个1,这 ...

  8. eclipse下导入工程的小问题

  9. hdu 1247 map的使用

    http://acm.hdu.edu.cn/showproblem.php?pid=1247 Hat’s Words Time Limit: 2000/1000 MS (Java/Others)    ...

  10. iOS开发之 在release版本禁止输出NSLog内容

    因为NSLog的输出还是比较消耗系统资源的,而且输出的数据也可能会暴露出App里的保密数据,所以发布正式版时需要把这些输出全部屏蔽掉. 我们可以在发布版本前先把所有NSLog语句注释掉,等以后要调试时 ...