C#特性Attribute
特性(Attribute),是用于在运行时传递程序中各种元素(如:类、方法、结构、枚举、组件……)的行为信息的声明性标签。
一个声明性标签通过放置在它所应用的元素前面,使用[]来描述
对于特性分为两种:预定义特性、自定义特性
语法 如下:
[attribute(positional_parameters,name_parameter = value,……)]
element
特性的名称和值是在方括号[]中进行这下义的,它放置在所应用元素之前。
positional_parameters指定的必须信息
name_parameter指定可选信息
-
预定义特性
有三种预定义特性:AttributeUsage、Conditional、Obsolete -
AttributeUsage
描述了如何使用一个自定义特性类。
语法:
[AttributeUsage(
validon,
AllowMultiple=allowmultiple,
Inherited=inherited
)]
参数:
validon:规定特性可被放置的语言元素,它是枚举器AttributeTargets的值的组合,默认是AttributeTargets.All
allowmultiple(可选):为该特性的AllowMultiple属性(property)提供一个布尔值。如果为true,则该特性是多用的,默认为false表示单用的
inherited(可选):为该特性Inherited属性(property)提供一个布尔值。如果为true,则这个特性可被派生类继承,默认值为false表示是不被继承的。
比如:
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
AllowMultiple = true)]
- Conditional
这个预定义特性标记了一个条件方法,其执行依赖于预片是标识符。
它会引起方法调用的条件编译,取决于指定的值
定义:
[Conditional(conditionalSymbol)]
比如:
[Conditional(“DEBUG”)]
使用Visual Studio中新增C#控制台应用程序chapter21_001
声明一个预定义字符
#define DEBUG
在Main方法中添加如下代码进行测试:
[Conditional("DEBUG")]
public static void ShowMessage(string msg)
{
Console.WriteLine(msg);
}
static void Main(string[] args)
{
ShowMessage("Show Message");
Console.WriteLine("结束!");
Console.ReadKey();
}
当使用调试运行时,或者在未作用调试运行时,但是声明了预定义字符串#define DEBUG,那么编译运行的结果是:
否则编译运行的结果如下:
- Obsolete(过时的)
这个预定义特性标记了不应被使用的程序实体,可以用来通知编译器去丢弃某个特定的目标元素。
语法结构:
[Obsolet(message)]
[Obsolet(message,iserror)]
参数:
message:是一个字符串,可以用来描述为什么过时以及处理的方式是什么等
iserror:是一个布尔值,如果这个值是true,则编译器把这个项目的使用当作一个错误,默认值是false(编译器只是生成一个警告)
在生成的类中添加OldMessage方法和NewMessage方法
[Obsolete("请不要使用这个已停用的旧方法,请改用新方法NewMessage",true)]
public static void OldMessage()
{
Console.WriteLine("method:OldMessage");
}
public static void NewMessage()
{
Console.WriteLine("method:NewMessage");
}
在Main方法中添加如下代码:
OldMessage();
这时可以看到编译提示报错如下:
当把OldMessage方法的Obsolete特性中 iserror属性设置为false,编译器则通过只是做警告提示
修改后的方法特性声明如下:
[Obsolete("请不要使用这个已停用的旧方法,请改用新方法NewMessage",false)]
public static void OldMessage()
{
Console.WriteLine("method:OldMessage");
}
这时可以看到编译器的提示是警告如下:
此时编译运行也可以通过,运行结果如下:
-
创建自定义特性(内容摘自W3Cschool)
.Net框架可以自定义特性,用于存储声明性的信息,并且可以在运行时被检索。
创建并使用自定义特性包含四个步骤
1.声明自定义特性
2.构建自定义特性
3.在目标程序元素上应用自定义特性
4.通过反射访问特性 -
声明自定义特性
一个自定义特性应派生自System.Attribute类
[AttributeUsage(AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Porperty,
AllowMultiple = true)]
public class DeBugInfo : System.Attribute
上面的代码就声明了一个名为DeBugInfo的自定义特性
- 构建自定义特性
这里构建了一个名为DeBugInfo的自定义特性,这个特性会存储调试程序获得的信息:
1.bug的代码编号
2.辨认bug的开发人员
3.最后一次review代码时间
4.一个存储了开发人员标记的字符串
DeBugInfo类带有三个用于存储前三个信息的私有属性和一个用于存储消息的公有属性。
DeBugInfo类:
[AttribugeUsage(AttribugeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
ArrowMutiple = true)]
public class DeBugInfo : System.Attribute
{
private int bugNo;
private string developer;
private string lastReview;
public string message;
//构造函数
public DeBugInfo(int bg, string dev, string d)
{
this.bugNo = bg;
this.developer = dev;
this.lastReview = d;
}
public int BugNo
{
get
{
return bugNo;
}
}
public string Developer
{
get
{
return developer;
}
}
public string LastReview
{
get
{
return lastReview;
}
}
public string Message
{
get
{
return message;
}
set
{
message = value;
}
}
}
- 在目标元素前应用自定义特性
[DeBugInfo(45, "Zara Ali", "12/8/2012", Message = "Return type mismatch")]
[DeBugInfo(49, "Nuha Ali", "10/10/2012", Message = "Unused variable")]
class Rectangle
{
// 成员变量
protected double length;
protected double width;
public Rectangle(double l, double w)
{
length = l;
width = w;
}
[DeBugInfo(55, "Zara Ali", "19/10/2012",
Message = "Return type mismatch")]
public double GetArea()
{
return length * width;
}
[DeBugInfo(56, "Zara Ali", "19/10/2012")]
public void Display()
{
Console.WriteLine("Length: {0}", length);
Console.WriteLine("Width: {0}", width);
Console.WriteLine("Area: {0}", GetArea());
}
}