一起谈.NET技术,关于C# 中的Attribute 特性

简介:   Attribute与Property 的翻译区别  Attribute 一般译作“特性”,Property 仍然译为“属性”。  Attribute 是什么  Attribute 是一种可由用户自由定义的修饰符(Modifier),可以用来修饰各种需要被修饰的目标。

  Attribute与Property 的翻译区别

  Attribute 一般译作“特性”,Property 仍然译为“属性”。

  Attribute 是什么

  Attribute 是一种可由用户自由定义的修饰符(Modifier),可以用来修饰各种需要被修饰的目标。

  简单的说,Attribute就是一种“附着物” —— 就像牡蛎吸附在船底或礁石上一样。

  这些附着物的作用是为它们的附着体追加上一些额外的信息(这些信息就保存在附着物的体内)—— 比如“这个类是我写的”或者“这个函数以前出过问题”等等。

  Attribute 的作用

  特性Attribute 的作用是添加元数据。
  元数据可以被工具支持,比如:编译器用元数据来辅助编译,调试器用元数据来调试程序。

  Attribute 与注释的区别

  • 注释是对程序源代码的一种说明,主要目的是给人看的,在程序被编译的时候会被编译器所丢弃,因此,它丝毫不会影响到程序的执行。
  • 而Attribute是程序代码的一部分,不但不会被编译器丢弃,而且还会被编译器编译进程序集(Assembly)的元数据(Metadata)里,在程序运行的时候,你随时可以从元数据里提取出这些附加信息来决策程序的运行。

  举例:

  在项目中,有一个类由两个程序员(小张和小李)共同维护。这个类起一个“工具包”(Utilities)的作用(就像.NET Framework中的Math类一样),里面含了几十个静态方法。而这些静态方法,一半是小张写的、一半是小李写的;在项目的测试中,有一些静态方法曾经出过bug,后来又被修正。这样,我们就可以把这些方面划分成这样几类:

Box

  我们分类的目的主要是在测试的时候可以按不同的类别进行测试、获取不同的效果。比如:统计两个人的工作量或者对曾经出过bug的方法进行回归测试。

  如果不使用Attribute,为了区分这四类静态方法,我们只能通过注释来说明,但这种方式会有很多弊端;

  如果使用Attribute,区分这四类静态方法将会变得简单多了。示例代码如下:

 
 
#define Buged
// C# 的宏定义必须出现在所有代码之前。当前只让 Buged 宏有效。
using System;
using System.Diagnostics; // 注意:这是为了使用包含在此名称空间中的ConditionalAttribute特性
namespace Con_Attribute
{
class Program
{
static void Main( string [] args)
{
// 虽然方法都被调用了,但只有符合条件的才会被执行!
ToolKit.FunA();
ToolKit.FunB();
ToolKit.FunC();
ToolKit.FunD();
}
}
class ToolKit
{
[ConditionalAttribute(
" Li " )] // Attribute名称的长记法
[ConditionalAttribute( " Buged " )]
public static void FunA()
{
Console.WriteLine(
" Created By Li, Buged. " );
}
[Conditional(
" Li " )] // Attribute名称的短记法
[Conditional( " NoBug " )]
public static void FunB()
{
Console.WriteLine(
" Created By Li, NoBug. " );
}
[ConditionalAttribute(
" Zhang " )] // Attribute名称的长记法
[ConditionalAttribute( " Buged " )]
public static void FunC()
{
Console.WriteLine(
" Created By Zhang, Buged. " );
}
[Conditional(
" Zhang " )] // Attribute名称的短记法
[Conditional( " NoBug " )]
public static void FunD()
{
Console.WriteLine(
" Created By Zhang, NoBug. " );
}
}
}

  运行结果如下:

2010-12-21_113636

  注意:运行结果是由代码中“#define Buged ”这个宏定义所决定。

  分析:

  1.  在本例中,我们使用了ConditionalAttribute 这个Attribute,它被包含在 System.Diagnostics 名称空间中。显然,它多半时间是用来做程序调试与诊断的。

  2.  与ConditionalAttribute 相关的是一组C# 宏,它们看起来与C语言的宏别无二致,位置必须出现在所有C# 代码之前。顾名思义,ConditionalAttribute 是用来判断条件的,凡被ConditionalAttribute (或Conditional)“附着”了的方法,只有满足了条件才会执行。

  3.  Attribute 就像船底上可以附着很多牡蛎一样,一个方法上也可以附着多个ConditionalAttribute 的实例。把Attribute 附着在目标上的书写格式很简单,使用方括号把Attribute 括起来,然后紧接着写Attribute 的附着体就行了。当多个Attribute 附着在同一个目标上时,就把这些Attribute 的方括号一个挨一个地书写(或者在一对方括号中书写多个Attribute),而且不必在乎它们的顺序。

  4.  在使用Attribute 的时候,有“长记法”和“短记法”两种,请君自便。

  由上面的第3 条和第4 条我们可以推出,以下四种Attribute 的使用方式是完全等价:

 
 
// 长记法
[ConditionalAttribute( " LI " )]
[ConditionalAttribute(
" NoBug " )]
public static void Fun()
{ Console.WriteLine(
" Created By Li, NoBug. " ); }
// 短记法
[Conditional( " LI " )]
[Conditional(
" NoBug " )]
public static void Fun()
{ Console.WriteLine(
" Created By Li, NoBug. " ); }
// 换序
[Conditional( " NoBug " )]
[Conditional(
" LI " )]
public static void Fun()
{ Console.WriteLine(
" Created By Li, NoBug. " ); }
// 单括号叠加
[Conditional( " NoBug " ), Conditional( " LI " )]
public static void Fun()
{ Console.WriteLine(
" Created By Li, NoBug. " ); }

  Attribute 的本质

  从上面的代码中,我们可以看到Attribute 似乎总跟public、static 这些关键字(Keyword)出现在一起。

  莫非使用了Attribute 就相当于定义了新的修饰符(Modifier)吗?让我们来一窥究竟!

  示例代码如下:

 
 
#define XG // C# 的宏定义必须出现在所有代码之前
using System;
using System.Diagnostics; // 注意:这是为了使用包含在此名称空间中的ConditionalAttribute 特性
namespace Con_Attribute
{
class Program2
{
[Conditional(
" XG " )]
static void Fun()
{
Console.ForegroundColor
= ConsoleColor.Yellow;
Console.WriteLine(
" http://xugang.cnblogs.com " );
}
static void Main( string [] args)
{
Fun();
}
}
}

  使用微软的中间语言反编译器查看 MSIL 中间语言中TargetMethod:void() 方法的代码,截图如下:

2010-12-21_122656

  可以看出:Attribute 本质上就是一个类,它在所附着的目标对象上最终实例化。

  仔细观察中间语言(MSIL)的代码之后,那些被C# 语言所掩盖的事实,在中间语言(MSIL)中就变得赤身裸体了。而Attribute 也变得毫无秘密!

  图中红色所指的是Fun 方法及其修饰符,但Attribute 并没有出现在这里。

  图中蓝色所指的是在调用mscorlib.dll 程序集中System.Diagnostics 名称空间中ConditionalAttribute 类的构造函数。

  可见,Attribute 并不是修饰符,而是一个有着独特实例化形式的类!

  Attribute 实例化有什么独特之处呢?

  1.  它的实例是使用.custom 声明的。查看中间语言语法,你会发现.custom 是专门用来声明自定义特性的。

  2.  声明Attribute 的位置是在函数体内的真正代码(IL_0000  至IL_0014 )之前。

  这就从“底层”证明了Attribute不是什么“修饰符”,而是一种实例化方式比较特殊的类。

  元数据的作用

  MSIL 中间语言中,程序集的元数据(Metadata)记录了这个程序集里有多少个namespace、多少个类、类里有什么成员、成员的访问级别是什么。而且,元数据是以文本(也就是Unicode 字符)形式存在的,使用.NET的反射(Reflection)技术就能把它们读取出来,并形成MSIL 中的树状图、VS 里的Object  Browser 视图,以及自动代码提示功能,这些都是元数据与反射技术结合的产物。一个程序集(.EXE或.DLL)能够使用包含在自己体内的元数据来完整地说明自己,而不必像C/C++ 那样带着一大捆头文件,这就叫作“自包含性”或“自描述性”。

  Attribute 的实例化

  就像牡蛎天生就要吸附在礁石或船底上一样,Attribute 的实例一构造出来就必需“粘”在一个什么目标上。

  Attribute 实例化的语法是相当怪异的,主要体现在以下三点:

  1.  不使用new 操作符来产生实例,而是使用在方括号里调用构造函数来产生实例。

  2.  方括号必需紧挨着放置在被附着目标的前面。

  3.  因为方括号里空间有限,不能像使用new 那样先构造对象,然后再给对象的属性(Property)赋值。

  因此,对Attribute 实例的属性赋值也在构造函数的圆括号里。

  并且,Attribute 实例化时尤其要注意的是:

  1.  构造函数的参数是一定要写。有几个就得写几个,因为你不写的话实例就无法构造出来。

  2.  构造函数参数的顺序不能错。调用任何函数都不能改变参数的顺序,除非它有相应的重载(Overload)。因为这个顺序是固定的,有些书里称其为“定位参数”(意即“个数和位置固定的参数”)。

  3. 对Attribute 实例的属性的赋值可有可无。反正它会有一个默认值,并且属性赋值的顺序不受限制。有些书里称属性赋值的参数为“具名参数”。

  自定义Attribute 实例

  在此,我们不使用.NET  Framework 中的各种Attribute 系统特性,而是从头自定义一个全新的Attribute 类。

  示例代码如下:

 
 
using System;
namespace Con_Attribute
{
class Program3
{
static void Main( string [] args)
{
// 使用反射读取Attribute
System.Reflection.MemberInfo info = typeof (Student); // 通过反射得到Student类的信息
Hobby hobbyAttr = (Hobby)Attribute.GetCustomAttribute(info, typeof (Hobby));
if (hobbyAttr != null )
{
Console.WriteLine(
" 类名:{0} " , info.Name);
Console.WriteLine(
" 兴趣类型:{0} " , hobbyAttr.Type);
Console.WriteLine(
" 兴趣指数:{0} " , hobbyAttr.Level);
}
}
}
// 注意:"Sports" 是给构造函数的赋值, Level = 5 是给属性的赋值。
[Hobby( " Sports " , Level = 5 )]
class Student
{
[Hobby(
" Football " )]
public string profession;
public string Profession
{
get { return profession; }
set { profession = value; }
}
}
// 建议取名:HobbyAttribute
class Hobby : Attribute // 必须以System.Attribute 类为基类
{
// 参数值为null的string 危险,所以必需在构造函数中赋值
public Hobby( string _type) // 定位参数
{
this .type = _type;
}
// 兴趣类型
private string type;
public string Type
{
get { return type; }
set { type = value; }
}
// 兴趣指数
private int level;
public int Level
{
get { return level; }
set { level = value; }
}
}
}

  为了不让代码太长,上面的示例中Hobby 类的构造函数只有一个参数,所以对“定位参数”体现的还不够淋漓尽致。大家可以为Hobby 类再添加几个属性,并在构造函数里多设置几个参数,体验一下Attribute 实例化时对参数个数及参数位置的敏感性。

  能被Attribute 所附着的目标

  Attribute 可以将自己的实例附着在什么目标上呢?这个问题的答案隐藏在AttributeTargets 这个枚举类型里。

  这个类型的可取值集合为:

All                                         Assembly                      Class                              Constructor

Delegate                           Enum                               Event                              Field

GenericParameter         Interface                         Method                           Module

Parameter                         Property                         ReturnValue                Struct

  一共是16 个可取值。上面这张表是按字母顺序排列的,并不代表它们真实值的排列顺序。

  使用下面这个小程序可以查看每个枚举值对应的整数值,示例代码如下:

 
 
using System;
namespace Con_Attribute
{
class Program4
{
static void Main( string [] args)
{
Console.WriteLine(
" Assembly\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Assembly));
Console.WriteLine(
" Module\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Module));
Console.WriteLine(
" Class\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Class));
Console.WriteLine(
" Struct\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Struct));
Console.WriteLine(
" Enum\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Enum));
Console.WriteLine(
" Constructor\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Constructor));
Console.WriteLine(
" Method\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Method));
Console.WriteLine(
" Property\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Property));
Console.WriteLine(
" Field\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Field));
Console.WriteLine(
" Event\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Event));
Console.WriteLine(
" Interface\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Interface));
Console.WriteLine(
" Parameter\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Parameter));
Console.WriteLine(
" Delegate\t\t\t{0} " , Convert.ToInt32(AttributeTargets.Delegate));
Console.WriteLine(
" ReturnValue\t\t\t{0} " , Convert.ToInt32(AttributeTargets.ReturnValue));
Console.WriteLine(
" GenericParameter\t\t{0} " , Convert.ToInt32(AttributeTargets.GenericParameter));
Console.WriteLine(
" All\t\t\t\t{0} " , Convert.ToInt32(AttributeTargets.All));
Console.WriteLine(
" \n " );
}
}
}

  结果显示如下:

2010-12-21_232331

  AttributeTargets 使用了枚举值的另一种用法 —— 标识位。
  除了All 的值之外,每个值的二进制形式中只有一位是“1”,其余位全是“0”。
  如果我们的Attribute 要求既能附着在类上,又能附着在类的方法上。就可以使用C# 中的操作符“|”(也就是按位求“或”)。有了它,我们只需要将代码书写如下:

  AttributeTargets.Class  |  AttributeTargets.Method

  因为这两个枚举值的标识位(也就是那个唯一的“1”)是错开的,所以只需要按位求或就解决问题了。

  这样,你就能理解:为什么AttributeTargets.All 的值是32767 了。

  默认情况下,当我们声明并定义一个新的Attribute 类时,它的可附着目标是AttributeTargets.All。

  大多数情况下,AttributeTargets.All 就已经满足需求了。不过,如果你非要对它有所限制,那就要费点儿周折了。

  例如,你想把前面的Hobby 类的附着目标限制为只有“类”和“字段”使用,则示例代码如下:

 
 
[AttributeUsage(AttributeTargets.Class, AttributeTargets.Field)]
class Hobby : Attribute // 必须以System.Attribute 类为基类
{
// Hobby 类的具体实现
}

  这里是使用Attribute的实例(AttributeUsage)附着在Attribute 类(Hobby)上。Attribute 的本质就是类,而AttributeUsage 又说明Hobby 类可以附着在哪些类型上。

  附加问题:

  1.  如果一个Attribute 类附着在了某个类上,那么这个Attribute 类会不会随着继承关系也附着在派生类上呢?

  2.  可不可以像多个牡蛎附着在同一艘船上那样,让一个Attribute 类的多个实例附着在同一个目标上呢?

  答案:可以。代码如下:

 
 
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field, Inherited = false , AllowMultiple = true )]
class Hobby : System.Attribute
{
// Hobby 类的具体实现
}

  AttributeUsage 这个专门用来修饰Attribute 的Attribute ,除了可以控制修饰目标外,还能决定被它修饰的Attribute 是否可以随宿主“遗传”,以及是否可以使用多个实例来修饰同一个目标!

  那修饰ConditionalAttribute 的AttributeUsage 又会是什么样子呢?(答案在MSDN中)

  参考来源:

  Attribute 在.NET 编程的应用

  深入浅出Attribute[上] —— Attribute 初体验

  深入浅出Attribute[中] —— Attribute本质论 

  示例代码

目录
相关文章
|
4天前
|
Cloud Native API C#
C#的现代化:.NET Core引领的技术革命
【6月更文挑战第9天】`.NET Core引领C#现代化,实现跨平台革命,提升性能并支持云原生应用。异步编程模型优化体验,统一API简化开发流程。C#应用场景扩展,开发效率提高,技术创新加速,预示其未来在技术领域将持续发挥关键作用。`
22 10
|
9天前
|
前端开发 C#
【.NET Core】你认识Attribute之CallerMemberName、CallerFilePath、CallerLineNumber三兄弟
【.NET Core】你认识Attribute之CallerMemberName、CallerFilePath、CallerLineNumber三兄弟
12 0
|
10天前
|
存储 编译器
【.NET Core】特性(Attribute)详解
【.NET Core】特性(Attribute)详解
16 2
|
29天前
|
人工智能 开发框架 量子技术
【专栏】.NET 技术:驱动创新的力量
【4月更文挑战第29天】.NET技术,作为微软的开发框架,以其跨平台、开源和语言多样性驱动软件创新。它在云计算、AI/ML、混合现实等领域发挥关键作用,通过Azure、ML.NET等工具促进新兴技术发展。未来,.NET将涉足量子计算、微服务和无服务器计算,持续拓宽软件开发边界,成为创新的重要推动力。掌握.NET技术,对于开发者而言,意味着握有开启创新的钥匙。
|
29天前
|
开发框架 .NET C#
【专栏】理解.NET 技术,提升开发水平
【4月更文挑战第29天】本文介绍了.NET技术的核心概念和应用,包括其跨平台能力、性能优化、现代编程语言支持及Web开发等特性。文章强调了深入学习.NET技术、关注社区动态、实践经验及学习现代编程理念对提升开发水平的重要性。通过这些,开发者能更好地利用.NET构建高效、可维护的多平台应用。
|
29天前
|
机器学习/深度学习 vr&ar 开发者
【专栏】.NET 技术:引领开发新方向
【4月更文挑战第29天】本文探讨了.NET技术如何引领软件开发新方向,主要体现在三方面:1) 作为跨平台开发的先锋,.NET Core支持多操作系统和移动设备,借助.NET MAUI创建统一UI,适应物联网需求;2) 提升性能和开发者生产力,采用先进技术和优化策略,同时更新C#语言特性,提高代码效率和可维护性;3) 支持现代化应用架构,包括微服务、容器化,集成Kubernetes和ASP.NET Core,保障安全性。此外,.NET还不断探索AI、ML和AR/VR技术,为软件开发带来更多创新可能。
|
29天前
|
开发框架 前端开发 .NET
C#编程与Web开发
【4月更文挑战第21天】本文探讨了C#在Web开发中的应用,包括使用ASP.NET框架、MVC模式、Web API和Entity Framework。C#作为.NET框架的主要语言,结合这些工具,能创建动态、高效的Web应用。实际案例涉及企业级应用、电子商务和社交媒体平台。尽管面临竞争和挑战,但C#在Web开发领域的前景将持续拓展。
|
29天前
|
SQL 开发框架 安全
C#编程与多线程处理
【4月更文挑战第21天】探索C#多线程处理,提升程序性能与响应性。了解C#中的Thread、Task类及Async/Await关键字,掌握线程同步与安全,实践并发计算、网络服务及UI优化。跟随未来发展趋势,利用C#打造高效应用。
|
29天前
|
存储 安全 网络安全
C#编程的安全性与加密技术
【4月更文挑战第21天】C#在.NET框架支持下,以其面向对象和高级特性成为安全软件开发的利器。本文探讨C#在安全加密领域的应用,包括使用System.Security.Cryptography库实现加密算法,利用SSL/TLS保障网络传输安全,进行身份验证,并强调编写安全代码的重要性。实际案例涵盖在线支付、企业应用和文件加密,展示了C#在应对安全挑战的同时,不断拓展其在该领域的潜力和未来前景。
|
29天前
|
人工智能 C# 开发者
C#编程中的图形界面设计
【4月更文挑战第21天】本文探讨了C#在GUI设计中的应用,介绍了Windows Forms、WPF和UWP等常用框架,强调了简洁界面、响应式设计和数据绑定等最佳实践。通过实际案例,展示了C#在企业应用、游戏开发和移动应用中的GUI实现。随着技术发展,C#在GUI设计的未来将趋向于跨平台、更丰富的组件和AI集成,为开发者创造更多可能性。