C#特性 2

深入浅出Attribute(中)——Attribute本质论

2007-06-04

小序:

上篇里,我们把Attribute“粘”在类的成员方法上show了一把,让Attribute跟大家混了个脸儿熟。中篇里,我们将探讨“究竟什么是Attribute”和“如何创建及使用Attribute”这两个问题。

准备好了吗?Let’s go!

正文:

从上篇里我们可以看到,Attribute似乎总跟public、static这些关键字(Keyword)出现在一起。莫非使用了Attribute就相当于定义了新的修饰符(Modifier)吗?让我们来一窥究竟!

先把下面这个例子编译出来:

#define

OK

using System;

using System.Diagnostics;

namespace Sample

{

class

Program

{

[Conditional("OK")]

publicstaticvoid TargetMethod()

{

Console.ForegroundColor = ConsoleColor.Green;

Console.WriteLine("\t=<

水之真谛>=\nhttp://blog.csdn.net/FantasiaX\n\n"

);

}

staticvoid Main(string[] args)

{

TargetMethod();

}

}

}

毋庸置疑,它的运行结果会是这样:

接下来,让我们把编译出的结果(.EXE文件)用“微软中间语言反编译器”打开,查看存储在程序集(Assembly,这在个例子中就是这个.EXE文件)中的中间语言代码(中间语言也就是我们常说的通用语言)。

如果你认为反汇编是件很神秘的事情,那你可就错了!比起x86汇编语言来,对.NET程序集的反汇编要简单得多——甚至可以说是与C#语言一一对应:

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

扯的有点儿远了——让我们回到正题,双击反编译器中的TargetMethod:void()。这回弹出窗口里显示的内容是真正的微软中间语言代码了。这些代码也都是文本形式的,需要经过.NET的“虚拟机”再编译后才能被CPU所执行。顺便说一句:VB.NET代码也会编译成这样的中间代码,所以,.NET平台上所有语言的编译结果都是通用的。换句话说,你用C#编写了一个组件,把它编译成一个DLL文件并交给VB.NET程序员,VB.NET程序员可以直接使用,丝毫不必有任何担心J

今天我们不打算研究中间语言的编译和执行,主要是打算通过中间语言对一些被C#语言所掩盖的事实一窥究竟。

仔细观察中间代码之后,Attribute变得了无秘密!图中蓝色箭头所指处是两个“真正的”修饰符——Attribute并没有出现在这里。而在红色箭头所标识的位置,我们可以清楚地看出——这分明是在调用mscorlib.dll程序集System.Diagnostics名称空间中ConditionalAttribute类的构造函数。可见,Attribute并不是修饰符,而是一个有着独特实例化形式的类!

Attribute实例化有什么独特之处呢?还是让我们再次观察中间语言代码——它有两个独特之处。

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

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

God,我怀疑是不是讲的太深了。没关系,上面关于中间语言的东西你都可以不care,只需要记住一个结论就可以了——我们已经从“底层”证明了Attribute不是什么“修饰符”,而是一种实例化方式比较特殊的类。

Attribute的实例化

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

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

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

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

3.因为方括号里空间有限,不能像使用new那样先构造对象后再对对象的属性(Property)一一赋值。因此,对Attribute实例的属性的赋值也都挤在了构造函数的圆括号里L

说实话,写代码的时候对于第1、第2两条适应起来还算容易,第3条写出来怎么看怎么别扭……而且尤其要记着的是:

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

2.构造函数参数的顺序不能错,这个很容易理解——调用任何一个函数你都不能改变参数的顺序——除非它有相应的重载(Overload)。因为这个顺序的固定的,所以有些书里管这些参数称为“定位参数”,意即“个数和位置固定的参数”。

3.对Attribute实例的属性的赋值可有可无——反正它会有一个默认值。而且,先对哪个属性赋值、后对哪个属性赋值不受限制。有些书管这些为属性赋值的参数叫“具名参数”——令人匪夷所思。

OK,百闻不如一见,还是让我们自己写一个Attribute类来体验一下吧!

自己动手写Attribute

这回我们抛弃.NET Framework给我们准备好的各种Attribute,从头写一个全新的Attribute——Oyster。

下面我给出一个完整的小例子:

//======水之真谛

=======//

//上善若水,润物无声

//

/*[url]http://blog.csdn.net/FantasiaX[/url]*/

using

System;

namespace OysterAttributeSample

{

classOyster: System.Attribute// 必需以System.Attribute类为基类

{

// Kind属性,默认值为

null

privatestring kind;

publicstring Kind

{

get { return kind; }

set { kind = value; }

}

// Age属性,默认值为

privateuint age;

publicuint Age

{

get { return age; }

set { age = value; }

}

// 值为null的string是危险的,所以必需在构造函数中赋值

public Oyster(string arg)// 定位参数

{

this.Kind = arg;

}

}

[Oyster("Thorny ", Age=3)]// 3年的多刺牡蛎附着在轮船(这是一个类)上。注意:对属性的赋值是在圆括号里完成的!

classShip

{

[Oyster("Saddle")]// 0

年的鞍形牡蛎附着在船舵(这是一个数据成员)上,Age使用的是默认值,构造函数的参数必需完整

publicstring Rudder;

}

classProgram

{

staticvoid Main(string[] args)

{

// ...

使用反射来读取

Attribute

}

}

}

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

能被Attribute所附着的目标

让我们思考这样一个问题:牡蛎可以附着在船底、礁石上、桥墩上……甚至是别的牡蛎身上,那么Attribute呢?都可以将自己的实例附着在什么目标上呢?

这个问题的答案隐藏在AttributeTargets这个枚举类型里——这个类型的可取值集合为:

=============================================================================

AllAssemblyClassConstructor

DelegateEnumEventField

GenericParameterInterfaceMethodModule

ParameterPropertyReturnValueStruct

=============================================================================

一共是16个可取值。

不过,上面这张表是按字母顺序排列的,并不代表它们真实值的排列顺序。使用下面这个小程序可以查看每个枚举值对应的整数值。

// =<水之真谛

>=

// [url]http://blog.csdn.net/FantasiaX[/url]

using

System;

namespace AttributeTargetValue

{

classProgram

{

staticvoid 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");

}

}

}

程序的运行结果是:

可能出乎你的预料——它们的值并不是步长值为1的线性递增。你观察出什么规律来了吗?提醒你一下:从二进制的角度来考虑喔!!

我想你一定发现了规律——除了All的值之外,每个值的二进制形式中只有一位是“1”,其余位全是“0”。这就是枚举值的另一种用法——标识位。那么,标识位有什么好处呢?

考虑这样一种情况:我们的Attribute要求既能附着在类上,又能附着在类的方法上,应该怎么做呢?

我们知道,C#中有一个操作符“|”(也就是按位求“或”)。有了它,我们只需要书写

AttributeTargets.Class | AttributeTargets.Method

就可以了。因为这两个枚举值的标识位(也就是那个唯一的“1”)是错开的,所以只需要按位求或就解决问题了。我想,聪明的你一定立刻就能解释为什么AttributeTargets.All的值是32767了吧:p

OK,了解了这些之后,我们应该怎样控制一个Attribute的附着目标呢?

默认情况下,当我们声明并定义一个新Attribute类时,它的可附着目标是AttributeTargets.All。大多数情况下AttributeTargets.All就已经满足需求了,不过,如果你非要对它有所限制,那就要费点儿周折了。

还拿我们上面创建的OysterAttribute举例——如果你想把它的附着目标限制为只有“类”和“值域”,你就应该这样书写:

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Field)]

classOyster : System.Attribute

{

// OysterAttribute类的具体实现

}

没想到吧!原来是用Attribute(的实例)附着在Attribute(类)上!本来吗,Attribute的本质就是类,而AttributeTargets.Class又说明Attribute可以附着在类上,所以,使用Attribute来“修饰”Attribute也就顺理成章了J

最后,细心的读者可能会问这样两个问题:

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

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

Very good! 这真是两个好问题!请看下面的代码:

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

classOyster : System.Attribute

{

// OysterAttribute类的具体实现

}

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

OK,大家猜一猜,修饰ConditionalAttribute的AttributeUsage会是什么样子呢?

TO BE CONTINUE

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 2017/10/29 1.C#基础语法: 矩阵类的实现 using System; using System.Co...
    文袁阅读 515评论 0 0
  • 1、C#中 property 与 attribute的区别,他们各有什么用处,这种机制的好处在哪里? proper...
    胤醚貔貅阅读 4,944评论 0 7
  • (十)没有故事的女同学 大二那年的寒假,顾漫程结束了为期半年的美国交换生之旅,言默默刚刚从新闻传播理论的苦海中解脱...
    夏沐春吟阅读 218评论 0 4
  • 昨晚听你笑来老师的一块听听,整体给我的感觉是,笑来老师想传达的不是他对比特币的理解,而是在讲 ‘深入独立思...
    极速小蜗犇阅读 869评论 1 4