C#特性 1

        什么是Attribute?Attribute是干什么使的?Attribute与Property到底有什么区别?……

长久以来,这些问题一直困扰着并不怎么广大的C#初学者。原因大概有两个,一是Attribute平时不怎么常用(没用惯怎么可能常用吗!)二是这个家伙不太好翻译——它与Property这个词意义相近,都有“属性”这个词条(而且在HTML语言中,Attribute也的确与C#面向对象概念中的Property意思一致),因此很多译者,特别是C#刚刚出来那阵子,拿捏不好应该怎么翻译,搞的C#初学者一遇到“属性”就发懵、一遇到“Attribute”就发怵。现在情况还算比较明朗了,Attribute一般译作“特性”,Property仍然译为“属性”。

        今天,先让我们来学习一下到底什么是Attribute并体验一下Attribute的威力,然后让我们彻底澄清Attribute与Property之间的区别。

什么是Attribute:

        大多数书籍都喜欢讲——“Attribute是一种可由用户自由定义的修饰符(Modifier),可以用来修饰各种需要被修饰的目标”——如此晦涩的言辞,怎么可能让新手一下子明白呢?(不过,等你看完这篇文章、成为“老手”之后,你会发现这句话说得还是挺有道理的。)况且,修饰符(比如private、public、static、ref、out等等)都是C#语言本身的关键字,而Attribute看起来又与语言本身不着边际。God!Attribute到底是个什么东东呢?

其实特别简单——Attribute就是一种“附着物”——就像牡蛎吸附在船底或礁石上一样。这些附着物的作用是为它们的附着体追加上一些额外的信息(这些信息就保存在附着物的体内)——比如“这个类是我写的”或者“这个函数以前出过问题”等等。

        你可能会问:这跟注释有什么区别呢?

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

        口说无凭,举个例子你马上就会明白了——让我们来考虑这样一种情况:

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

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

如果不使用Attribute,为了区分这四类静态方法,我们有两种方法:

1.         把这些信息体现在方法的名称中,看起来就像这样——

                  //...

                  public static void Li_Buged_Method_1(double arg1, double arg2) { /*...*/}

                  public static void Li_NoBug_Method_2(double arg1, double arg2) { /*...*/}

                  public static void Zhang_Buged_Method_3(double arg1, double arg2) { /*...*/}

                  public static void Zhang_NoBug_Method_4(double arg1, double arg2) { /*...*/}

        //...

                  很显然,这样是行不通的,因为这样会在方法命名中遗留很多与程序逻辑本身无关的“垃圾信息”。举个极端点儿的例子:如果小张和小李调走了,由小赵和小孙接手他们的工作,后来小赵和小孙也调走了,由小刘和小王接手维护工作……旧方法的名字不敢改,新方法的名字要用新姓氏命名,时间一长,这个类就跟《百家姓》没什么区别了:p

2.         另一种方法是为每个方法加注释,看起来会是这样——

                  //...

                  public static void Method_1(double arg1, double arg2) { /*...*/}          // Created By Li, Buged

                  public static void Method_2(double arg1, double arg2) { /*...*/}         // Created By Li, NoBug

                  public static void Method_3(double arg1, double arg2) { /*...*/}          // Created By Zhang, Buged

                  public static void Method_4(double arg1, double arg2) { /*...*/}          // Created By Zhang, NoBug

        //...

                  这样做的好处是清除了代码中的“垃圾信息”,但情况并没有好到哪儿去。为了统计程序员的工作量,你还得一边看注释一边计数,为了把出过bug和没出过bug的方法分开跑,你要在执行的时候不停地把这个方法注释掉(在调用前加//,取消它的执行)、为那个方法取消注释……如果是几十个方法还好办,如果是几千个呢?(别不相信,我在MSN测试组里呆着的时候,一组方法就有一千四百多个呢!)之所以出现这个问题,根本原因是注释会被编译器抛弃,因此在执行期注释丝毫帮不上我们的忙。

        难道我们没有别的办法了吗?峰回路转,Attribute登场!

Attribute范例

请编译运行下面这个程序:

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

//上善若水,润物无声//

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

//#define NOBUG

#define BUGED  // C#的宏定义必须出现在所有代码之前。当前我们只让BUGED宏有效。

//#define LI

//#define ZHANG

using System;

using System.Diagnostics; // 注意:这是为了使用包含在此名称空间中的ConditionalAttribute特性

namespace AttributeSample

{

        class ToolKit

        {

                  [ConditionalAttribute("LI")]                                           // Attribute名称的长记法

                  [ConditionalAttribute("BUGED")]

                  public static void Method1() { Console.WriteLine("Created By Li, Buged."); }

                  [ConditionalAttribute("LI")]

                  [ConditionalAttribute("NOBUG")]

                  public static void Method2() { Console.WriteLine("Created By Li, NoBug."); }

                  [Conditional("ZHANG")]                                               // Attribute名称的短记法

                  [Conditional("BUGED")]

                  public static void Method3() { Console.WriteLine("Created By Zhang, Buged."); }

                  [Conditional("ZHANG")]

                  [Conditional("NOBUG")]

                  public static void Method4() { Console.WriteLine("Created By Zhang, NoBug."); }

        }

        class Program

        {

                  static void Main(string[] args)

                  {

                           // 虽然方法都被调用了,但只有符合条件的才会被执行。

                           ToolKit.Method1();

                           ToolKit.Method2();

                           ToolKit.Method3();

                           ToolKit.Method4();

                  }

        }

}

执行结果:

实例分析:

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

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

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

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

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

                  [ConditionalAttribute("LI")]                        // 长记法

                  [ConditionalAttribute("NOBUG")]

        public static void Method2() { Console.WriteLine("Created By Li, NoBug."); }

                  [Conditional("LI")]                                        // 短记法

                  [Conditional("NOBUG")]

        public static void Method2() { Console.WriteLine("Created By Li, NoBug."); }

                  [Conditional("NOBUG")]                           // 换序

                  [Conditional("LI")]

        public static void Method2() { Console.WriteLine("Created By Li, NoBug."); }

                  [Conditional("NOBUG"), Conditional("LI")]                      // 单括号叠加

                  public static void Method2() { Console.WriteLine("Created By Li, NoBug."); }

        当我们对Attribute的用途有所了解后,我们就可以向Attribute的本质进发了!

TO BE CONTINUE

请关注:

《深入浅出Attribute》(中)——Attribute的本质

《深入浅出Attribute》(下)——Attribute V.S. Property

法律声明:本文章受到知识产权法保护,任何单位或个人若需要转载此文,必需保证文章的完整性(未经作者许可的任何删节或改动将视为侵权行为)。若您需要转载,请务必注明文章出处为51CTO以保障网站的权益;请务必注明文章作者为刘铁猛([url]http://liutiemeng.blog.51cto.com[/url]),并向liutm@beyondsoft.com发送邮件,标明文章位置及用途。转载时请将此法律声明一并转载,谢谢!

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

推荐阅读更多精彩内容

  • 深入浅出Attribute(中)——Attribute本质论 2007-06-04 小序: 上篇里,我们把Attr...
    北风知我意阅读 488评论 0 0
  • LSP:里氏替换原则 * 原则上来讲,子类对象可以赋给父类对象,也可以说子类替换父类,并且出现在父类能过出现的任何...
    Unity开发阅读 1,161评论 0 0
  • 1. 慧子姑娘昨天在公众号给我留言,她说:“诺诺,男生变心变得太快了,昨天还说喜欢我,今天就叫别人亲爱的了。” 一...
    诺然yz阅读 7,527评论 126 275
  • 嘿 号外号外 说个事。好消息 坏消息呢。好消息是女神和我聊天了唉,坏消息是女神竟然都不知道我唉。还有女神和我...
    LOVE20阅读 246评论 0 1
  • Aha:急什么呢?专注力会让你放慢速度。 早在15年上“相遇二”课程的时候,就会跟着老师冥想。但从来没有从内...
    奔跑的邓邓阅读 216评论 0 0