一、特性(Attribute)的概念:公共语言运行时允许添加类似关键字的描述声明,它对程序中的元素进行标注,如类、字段、方法等,其本质上就是一个类,如果没有什么机制来在运行期来获取Attribute的附加信息,那么Attribute就没有什么存在的意义,.NET中以反射机制来实现在运行期获取Attribute的附加信息。那么特性到底长啥样子呢?比如: 在方法的前面加上 [Obsolete("此方法声明为已过期")] 这个特性,其实ObsoleteAttribute就是一个.net framework程序集中的特性类,"此方法声明为已过期" 是为ObsoleteAttribute类中的message字段赋值,程序集中对ObsoleteAttribute类的定义如下:
namespace System
{
public sealed class ObsoleteAttribute : Attribute
{
public ObsoleteAttribute(string message);
}
}
详细的特性描述和示例在后面讲。
二、属性(Property)的概念:属性是面向对象编程的基本概念,提供了对私有字段的访问封装,在C#中以get和set访问器方法实现对可读可写属性的操作,提供了安全和灵活的数据访问封装。那么属性到底长啥样子呢?例子如下:
public class myProperty
{
private string _name;
private int _age;
public string Name
{
get{ retuen _name; }
set{ _name=value; }
}
public int Age
{
get{ retuen _age; }
set{ _age=value; }
}
}
public class myTest
{
public static void main(string[] args)
{
myProperty myProperty=new myProperty();
//触发set访问器
myProperty.Name="张珊";
//触发get访问器
string name=myProperty.Name;
}
}
三、特性(Attribute)和属性(Property)的区别比较:通过对概念的澄清和历史的回溯,我们知道特性和属性只是在名称上有过纠葛,其他一点关系都没有,在MSDN上关于Attribute的中文解释甚至还是属性,但是我更同意将其称呼为:特性。在功能上和应用上,二者其实没有太多模糊的概念交叉,因此也没有必要来比较其应用的异同点。一句话就是它两有毛关系。
四、特性的应用场景和规则:我理解的特性,就是为目标元素(可以是数据集assembly、模块module、类class、属性property、方法method、字段field、甚至函数参数param等)加入附加信息,但是可以在编译期进行初始化、在运行期以反射的方式获得。定制特性主要应用在序列化、编译器指令、设计模式等方面。特性的规则:
特性以[,]形式展现,放在紧挨着的元素上,多个特性可以应用于同一元素,特性间以逗号隔开,以下表达规则有效:[AttributeUsage][ Flags]、[AttributeUsage, Flags]、[Flags, AttibuteUsageAttribute]、[AttributeUsage(), FlagesAttribute()]。C#允许以指定的前缀来表示特性所应用的目标元素,例如:
using System;
namespace CX.Net
{
[assembly: MyAttribute(1)] //应用于程序集
[moduel: MyAttribute(2)] //应用于模块
pubic class AttributeCX
{
//
}
}
定制特性类型,必须直接或者间接的继承自System.Attribute类,而且该类型必须有公有构造函数来创建其实例。
所有自定义的特性名称都应该有个Attribute后缀(即自定义属性的类名称必须为 XXXXAttribute 以Attribute结尾),这是习惯性约定。
定制特性也可以应用在其他定制特性上,这点也很好理解,因为定制特性本身也是一个类,遵守类的公有规则。
定制特性不会影响应用元素的任何功能,只是约定了该元素具有的特质。
所有非抽象特性必须具有public访问限制。
特性常用于编译器指令,突破#define, #undefine, #if, #endif的限制,而且更加灵活。
定制特性常用于在运行期获得代码注释信息,以附加信息来优化调试。
定制特性可以应用在某些设计模式中,如工厂模式。
定制特性还常用于位标记,非托管函数标记、方法废弃标记等其他方面。
五、常用特性说明:常用特性,也就是.NET已经提供的固有特性,事实上在.NET框架中已经提供了丰富的固有特性由我们发挥,以下精选出我认为最常用、最典型的固有特性做以简单讨论,当然这只是我的一家之言,亦不足道。
1、AttributeUsage:AttributeUsage特性用于控制如何应用自定义特性到目标元素。例子如下:
// AttributeTargets设置特性的可使用范围,AllowMultiple 是否能在一个目标身上多次使用,Inherited 特性是否能继承到子类身上
2、Serializable:Serializable特性表明了应用的元素可以被序列化(serializated)。
3、Conditional:Conditional特性,用于条件编译,在调试时使用。注意:Conditional不可应用于数据成员和属性。还有其他的重要特性,包括:Description、DefaultValue、Category、ReadOnly、BrowerAble等。
六、通过反射机制获取特性(Attribute)信息的小例子:
using System;
using System.Reflection; //应用反射技术获得特性信息
namespace Anytao.net
{
//定制特性也可以应用在其他定制特性上,
//应用AttributeUsage,来控制如何应用新定义的特性
[AttributeUsageAttribute(AttributeTargets.All, //可应用任何元素
AllowMultiple = true, //允许应用多次
Inherited = false)] //不继承到派生类
//特性也是一个类,
//必须继承自System.Attribute类,
//命名规范为:"类名"+Attribute。
public class MyselfAttribute : System.Attribute
{
//定义字段
private string _name;
private int _age;
private string _memo;
//必须定义其构造函数,如果不定义有编译器提供无参默认构造函数
public MyselfAttribute()
{
}
public MyselfAttribute(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; }
set { _memo = value; }
}
//定义方法
public void ShowName()
{
Console.WriteLine("Hello, {0}", _name == null ? "world." : _name);
}
}
//应用自定义特性
//可以以Myself或者MyselfAttribute作为特性名
//可以给属性Memo赋值
[Myself("Emma", 25, Memo = "Emma is my good girl.")] //前两个是给特性中的字段赋值,后面一个是给特性中的属性字段赋值
public class Mytest
{
public void SayHello()
{
Console.WriteLine("Hello, my.net world.");
}
}
public class Myrun
{
public static void Main(string[] args)
{
//如何以反射确定特性信息
Type tp = typeof(Mytest); //获取Mytest的System.Type类型
MemberInfo info = tp; //MemberInfo存放反射的成员信息
MyselfAttribute myAttribute =
(MyselfAttribute)Attribute.GetCustomAttribute(info, typeof(MyselfAttribute)); //检索应用于目标元素(Mytest类)的自定义特性(MyselfAttribute)的信息
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();
}
}
}
此示例代码摘自CSDN,作者Neo_in_SAP