创建自定义特性(C# 和 Visual Basic)
通过定义一个特性类,可以创建您自己的自定义特性。该特性类直接或间接地从 Attribute 派生,有助于方便快捷地在元数据中标识特性定义。 假设您要用编写类型的程序员的名字标记类型。 可以定义一个自定义 Author 特性类:
<System.AttributeUsage(System.AttributeTargets.Class Or
System.AttributeTargets.Struct)>
Public Class Author
Inherits System.Attribute
Private name As String
Public version As Double
Sub New(ByVal authorName As String)
name = authorName
version = 1.0
End Sub
End Class
[System.AttributeUsage(System.AttributeTargets.Class |
System.AttributeTargets.Struct)
]
public class Author : System.Attribute
{
private string name;
public double version;
public Author(string name)
{
this.name = name;
version = 1.0;
}
}
类名是特性的名称,即 Author。 它由 System.Attribute 派生而来,因此是自定义特性类。 构造函数的参数是自定义特性的定位参数。 本示例中 name 是定位参数。 任何公共的读写字段或属性都是命名参数。 在本例中,version 是唯一的命名参数。 请注意 AttributeUsage 特性的用法,它使得 Author 特性仅在类和 struct(在 Visual Basic 中是 Structure)声明中有效。
可以按如下所示使用此新特性:
<Author("P. Ackerman", Version:=1.1)>
Class SampleClass
' P. Ackerman's code goes here...
End Class
[Author("P. Ackerman", version = 1.1)]
class SampleClass
{
// P. Ackerman's code goes here...
}
AttributeUsage 有一个命名参数 AllowMultiple,使用它可以使自定义特性成为一次性使用或可以使用多次的特性。 在下面的代码示例中,创建了一个使用多次的特性。
' multiuse attribute
<System.AttributeUsage(System.AttributeTargets.Class Or
System.AttributeTargets.Struct,
AllowMultiple:=True)>
Public Class Author
Inherits System.Attribute
[System.AttributeUsage(System.AttributeTargets.Class |
System.AttributeTargets.Struct,
AllowMultiple = true) // multiuse attribute
]
public class Author : System.Attribute
在下面的代码示例中,向某个类应用了同一类型的多个特性。
<Author("P. Ackerman", Version:=1.1),
Author("R. Koch", Version:=1.2)>
Class SampleClass
' P. Ackerman's code goes here...
' R. Koch's code goes here...
End Class
[Author("P. Ackerman", version = 1.1)]
[Author("R. Koch", version = 1.2)]
class SampleClass
{
// P. Ackerman's code goes here...
// R. Koch's code goes here...
}
备注
如果特性类包含一个属性,则该属性必须为读写属性。
请参见
参考
AttributeUsage(C# 和 Visual Basic)