你必须知道的特性和属性(转载)
1. 引⾔
attribute是框架引⼊的有⼀技术亮点,因此我们有必要花点时间⾛进⼀个发现attribute登堂⼊室的⼊⼝。因为 Framework 中使⽤了⼤量的定制特性来完成代码约定,[Serializable]、[Flags]、[DllImport]、[AttributeUsage]这些的构造,相信我们都见过吧,那么你是否了解其背后的技术。
提起特性,由于⾼级语⾔发展的历史原因,不免让⼈想起另⼀个⽿熟能详的名字:属性。特性和属性,往往给初学者或者从C++转移到C#的⼈混淆的概念冲击。那么,什么是属性,什么是特性,⼆者的概念和区别,⽤法与⽰例,将在本⽂做以概括性的总结和⽐较,希望给你的理解带来收获。另外本⽂的主题以特性的介绍为主,属性的论述重点突出在⼆者的⽐较上,关于属性的更多论述将在另⼀篇主题中详细讨论,敬请关注。
2. 概念引⼊
2.1. 什么是特性?
MSDN的定义为:公共语⾔运⾏时允许添加类似关键字的描述声明,叫做attributes, 它对程序中的元素进⾏标注,如类型、字段、⽅法和属性等。Attributes和Microsoft Framework⽂件的元数据保存在
⼀起,可以⽤来向运⾏时描述你的代码,或者在程序运⾏的时候影响应⽤程序的⾏为。
我们简单的总结为:定制特性attribute,本质上是⼀个类,其为⽬标元素提供关联附加信息,并在运⾏期以反射的⽅式来获取附加信息。具体的特性实现⽅法,在接下来的讨论中继续深⼊。
2.2. 什么是属性?
2.2. 什么是属性?
属性是⾯向对象编程的基本概念,提供了对私有字段的访问封装,在C#中以get和t访问器⽅法实现对可读可写属性的操作,提供了安全和灵活的数据访问封装。关于属性的概念,不是本⽂的重点,⽽且相信⼤部分的技术⼈员应该对属性有清晰的概念。以下是简单的属性⽰例:
public class MyProperty
{
//定义字段
private string _name;
private int _age;
//定义属性,封装_name字段
public string Name
{
get { return (_name == null) ? string.Empty : _name; }
t { _name = value; }
}
//定义属性,封装_age字段
//加⼊范围控制
public int Age
{
橘子英语
get { return _age; }
t
{
if( value > 0 && value<150)
{
_age = value;
}
el
{
throw new Exception(" Not a real age");
}
}
}
}
public class MyTest
{
public static void Mian( string[] args)
{
MyProperty myProperty = new MyProperty();
//触发t访问器
myProperty.Name = " Anytao";
//触发get访问器
Console.WriteLine(myProperty.Name);
文港
myProperty.Age = 66;
Console.WriteLine(myProperty.Age.ToString());
Console.ReadLine();
}
}
2.3. 区别与⽐较
2.3. 区别与⽐较
通过对概念的澄清和历史的回溯,我们知道特性和属性只是在名称上有过纠葛,在MSDN上关于attribute的中⽂解释甚⾄还是属性,但是我同意更通常的称呼:特性。在功能上和应⽤上,⼆者其实没有太多模糊的概念交叉,因此也没有必要来⽐较其应⽤的异同点。本⽂则以特性的概念为重点,来讨论其应⽤的场合和规则。
我理解的定制特性,就是为⽬标元素,可以是数据集、模块、类、属性、⽅法、甚⾄函数参数等加⼊附加信息,类似于注释,但是可以在运⾏期以反射的⽅式获得。定制特性主要应⽤在序列化、编译器指令、设计模式等⽅⾯。
3. 通⽤规则
3. 通⽤规则
定制特性可以应⽤的⽬标元素可以为:程序集(asmbly)、模块(module)、类型(type)、属性(property)、事件(event)、字段(field)、⽅法(method)、参数(param)、返回值(return),应该全了。
淡妆步骤
定制特性以[,]形式展现,放在紧挨着的元素上,多个特性可以应⽤于同⼀元素,特性间以逗号隔开,以下表达规则有效:[AttributeUsage][ Flags]、[AttributeUsage, Flags]、[Flags, AttibuteUsageAttribute]、[AttributeUsage(), FlagesAttribute()]
attibute实例,是在编译期进⾏初始化,⽽不是运⾏期。
C#允许以指定的前缀来表⽰特性所应⽤的⽬标元素,建议这样来处理,因为显式处理可以消除可能带来的⼆义性。例如: using System;
using System;
namespace Anytao
{
[asmbly: MyAttribute(1)] //应⽤于程序集
[moduel: MyAttribute(2)] //应⽤于模块
pubic class Attribute_how2 do
{
//
}
}
定制特性类型,必须直接或者间接的继承⾃System.Attribute类,⽽且该类型必须有公有构造函数来创建其实例。
所有⾃定义的特性名称都应该有个Attribute后缀,这是习惯性约定。
定制特性也可以应⽤在其他定制特性上,这点也很好理解,因为定制特性本⾝也是⼀个类,遵守类的公有规则。例如很多时候我们的⾃定义定制特性会应⽤AttributeUsageAttribute特性,来控制如何应⽤新定义的特性。
[AttributeUsageAttribute(AttributeTarget.All),
[AttributeUsageAttribute(AttributeTarget.All),
AllowMultiple = true,
Inherited = true]
class MyNewAttribute: System.Attribute
{
//
}
定制特性不会影响应⽤元素的任何功能,只是约定了该元素具有的特质。
所有⾮抽象特性必须具有public访问限制。
特性常⽤于编译器指令,突破#define, #undefine, #if, #endif的限制,⽽且更加灵活。
定制特性常⽤于在运⾏期获得代码注释信息,以附加信息来优化调试。
放烟花作文400字定制特性可以应⽤在某些设计模式中,如⼯⼚模式。
定制特性还常⽤于位标记,⾮托管函数标记、⽅法废弃标记等其他⽅⾯。
姬松茸的吃法
4. 特性的应⽤
4.1. 常⽤特性
4.1. 常⽤特性
常⽤特性,也就是已经提供的固有特性,事实上在框架中已经提供了丰富的固有特性由我们发挥,以下精选出我认为最常⽤、最典型的固有特性做以简单讨论,当然这只是我的⼀家之⾔,亦不⾜道。我想了解特性,还是从这⾥做为起点,从提供的经典开始,或许是⼀种求知的捷径,希望能给⼤家以启⽰。
AttributeUsage
AttributeUsage
AttributeUsage特性⽤于控制如何应⽤⾃定义特性到⽬标元素。关于AttributeTargets、AllowMultiple、Inherited、ValidOn,请参阅⽰例说明和其他⽂档。我们已经做了相当的介绍和⽰例说明,我们还是在实践中⾃⼰体会更多吧。
Flags
Flags
以Flags特性来将枚举数值看作位标记,⽽⾮单独的数值,例如:
enum Animal
{
Dog = 0x0001,
Cat = 0x0002,
Duck = 0x0004,
Chicken = 0x0008
}
因此,以下实现就相当轻松,
Animal animals = Animal.Dog | Animal.Cat;
馒头花样
Console.WriteLine(animals.ToString());
请猜测结果是什么,答案是:"Dog, Cat"。如果没有Flags特别,这⾥的结果将是"3"。关于位标记,也将在本系列的后续章回中有所交代,在此只做以探讨⽌步。
DllImport
DllImport
DllImport特性,可以让我们调⽤⾮托管代码,所以我们可以使⽤DllImport特性引⼊对Win32 API函数的调⽤,对于习惯了⾮托管代码的程序员来说,这⼀特性⽆疑是救命的稻草。
using System;
using System.Runtime.InteropServices;
namespace Anytao
{
class MainClass
{
[DllImport(" Ur32.dll")]
public static extern int MessageBox( int hParent, string msg, string caption, int type);
static int Main()
{
return MessageBox(0, " How to u attribute in ", " Anytao_net", 0);
}
}
}
Serializable
Serializable
Serializable特性表明了应⽤的元素可以被序列化(rializated),序列化和反序列化是另⼀个可以深⼊讨论的话题,在此我们只是提出概念,深⼊的研究有待以专门的主题来呈现,限于篇幅,此不赘述。
Conditional
Conditional
Conditional特性,⽤于条件编译,在调试时使⽤。注意:Conditional不可应⽤于数据成员和属性。
还有其他的重要特性,包括:Description、DefaultValue、Category、ReadOnly、BrowerAble等,有时间可以深⼊研究。
4.2. ⾃定义特性
4.2. ⾃定义特性
既然attribute,本质上就是⼀个类,那么我们就可以⾃定义更特定的attribute来满⾜个性化要求,只要遵守上述的12条规则,实现⼀个⾃定义特性其实是很容易的,典型的实现⽅法为:
定义特性
[AttributeUsage(AttributeTargets.Class |
AttributeTargets.Method,
Inherited = true)]
public class TestAttribute : System.Attribute
{
public TestAttribute( string message)
{
throw new Exception(" error:" + message);
}
public void RunTest()
{
Console.WriteLine(" TestAttribute here.");
}
}
应⽤⽬标元素 [Test(" Error Here.")]
[Test(" Error Here.")]
public void CannotRun()
{
/
/
}
获取元素附加信息
如果没有什么机制来在运⾏期来获取Attribute的附加信息,那么attribute就没有什么存在的意义。因此,中以反射机制来实现在运⾏期获取attribute信息,实现⽅法如下:
public static void Main( string[] args)
{
Tester t = new Tester();
t.CannotRun();
Type tp = typeof(Tester);
TestAttribute myAtt = (TestAttribute)Attribute.GetCustomAttribute((MemberInfo)tp, typeof(TestAttribute));
myAtt.RunTest();
}
5. 经典⽰例
5.1 ⼩菜⼀碟
5.1 ⼩菜⼀碟
啥也不说了,看注释吧。
using System;
using System.Reflection; //应⽤反射技术获得特性信息
namespace Anytao
{
//定制特性也可以应⽤在其他定制特性上,
/
/应⽤AttributeUsage,来控制如何应⽤新定义的特性
[AttributeUsageAttribute(AttributeTargets.All, //可应⽤任何元素
AllowMultiple = true, //允许应⽤多次
Inherited = fal)] //不继承到派⽣类
//特性也是⼀个类,
//必须继承⾃System.Attribute类,
//命名规范为:"类名"+Attribute。
public class MylfAttribute : System.Attribute
{
//定义字段
private string _name;
private int _age;
private string _memo;
//必须定义其构造函数,如果不定义有编译器提供⽆参默认构造函数
public MylfAttribute()
{
}
public MylfAttribute( string name, int age)
{
_name = name;
_age = age;
}
/
/定义属性
//显然特性和属性不是⼀回事⼉
public string Name
{
get { return _name == null ? string.Empty : _name; }
}
public int Age
{
get { return _age; }
}
public string Memo
{
get { return _memo; }
我是一朵小花t { _memo = value; }
}
//定义⽅法
猪蹄冻的家常做法public void ShowName()
{
Console.WriteLine(" Hello, {0}", _name == null ? " world." : _name);
}
}
//应⽤⾃定义特性
/
/可以以Mylf或者MylfAttribute作为特性名
//可以给属性Memo赋值
[Mylf(" Emma", 25, Memo = " Emma is my good girl.")]
public class Mytest
{
public void SayHello()
{
Console.WriteLine(" Hello, my world.");
}
}
public class Myrun
{
public static void Main( string[] args)
{
//如何以反射确定特性信息
Type tp = typeof(Mytest);
MemberInfo info = tp;
MylfAttribute myAttribute =
(MylfAttribute)Attribute.GetCustomAttribute(info, typeof(MylfAttribute));
if (myAttribute != null)
{
//嘿嘿,在运⾏时查看注释内容,是不是很爽
Console.WriteLine(" Name: {0}", myAttribute.Name);
Console.WriteLine(" Age: {0}", myAttribute.Age);
Console.WriteLine(" Memo of {0} is {1}", myAttribute.Name, myAttribute.Memo);
myAttribute.ShowName();
}
//多点反射
object obj = Activator.CreateInstance( typeof(Mytest));
MethodInfo mi = tp.GetMethod(" SayHello");
mi.Invoke(obj, null);
Console.ReadLine();
}
}
}
啥也别想了,⾃⼰做⼀下试试。
5.2 他⼭之⽯
5.2 他⼭之⽯
MSDN认为,特性 (Attribute) 描述如何将数据序列化,指定⽤于强制安全性的特性,并限制实时 (JIT) 编译器的优化,从⽽使代码易于调试。属性 (Attribute) 还可以记录⽂件名或代码作者,或在窗体开发阶段控制控件和成员的可见性。
dudu Boss收藏的系列⽂章《Attribute在编程中的应⽤》,给你应⽤⽅⾯的启⽰会很多,值得研究。
亚历⼭⼤ 的系列⽂章《⼿把⼿教你写ORM(六)》中,也有很好的诠释。
idior的⽂章《Remoting基本原理及其扩展机制》也有收获,因此补充。
6. 结论
Attribute是引⼊的⼀⼤特⾊技术,但在博客园中讨论的不是很多,所以拿出⾃⼰的体会来分享,希望就这⼀技术要点进⾏⼀番登堂⼊室的引导。更深层次的应⽤,例如序列化、程序安全性、设计模式多⽅⾯都可以挖掘出闪耀的⾦⼦,这就是在技术领域带来的百变魅⼒吧。希望⼤家畅所欲⾔,来完善和补充作者在这⽅⾯的不全⾯和认知上的不深⼊,那将是作者最⼤的⿎励和动⼒。