- 了解attribute
Attribute 只是将一些附加信息与某个目标元素关联起来的方式。
Attribute 是一个类，这个类可以提供一些字段和属性，不应提供公共方法，事件等。在定义attribute类的构造方法，字段和属性时，对数据类型有严格的要求，一般要求为： Boolean, Char, Byte, Sbyte, Int16, UInt16, Int32, Int64,Single, Double, String, Type, Object, Enum, 可以使用数组，但是并不提倡使用。
使用attribute
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
[Conditional("Specify")]
public class DisplayNameAttribute : Attribute
{
public string PropertyName { get; set; } public DisplayNameAttribute()
{ } public DisplayNameAttribute(string propertyName)
{
this.PropertyName = propertyName;
}
}
- 检测attribute
- attribute定义和应用之后还没有任何意义，只有在运行的时候去检测，然后根据对应的attribute做一些不同事情才让attribute变得有意义，那么如何检测attribute呢？
|
方法名称 |
说明 |
|
IsDefined |
如果至少有一个指定的Attribute派生类的实例与目标关联，就返回true。这个方法效率很高，因为他不构造（反序列化）attribute类的任何实例 |
|
GetCustomAttributes |
返回一个数组，其中每个元素都是应用于目标的指定attribute类的一个实例。 如果不为这个方法指定具体的attribute类，数组中包含的就是已应用的所有attribute的实例，不管他们是什么类。每个实例都使用编译时指定的参数、字段和属性来构造（反序列化）。如果目标没有应用任何attribute类的实例，就返回一个空数组。该方法通常用于已将AllowMultiple 设为true的attribute |
|
GetCustomAttribute |
返回应用于目标的指定attribute类的一个实例。实例使用编译是指定的参数、字段和属性来构造（反序列化）。如果目标没有应用任何attribute类的实例，就返回null。如果目标应用了制定attribute的多个实例，抛出异常AmbiguousMatchException. 因此该方法通常用于AllowMultiple=false的attribute |
最后的例子中展示了如何使用这些方法。
2. 上面的方法在检测时进行了attribute对象的构造（需要反序列化），这样有可能调用set访问器和构造方法，可能出现安全风险（未知代码在AppDomain中运行）。因此可以使用CustomAttributeData类中定的静态方法进行检测
public override string ToString()
{
//在子类中对父类中的方法进行重写，使用不创建attribute对象不执行代码（反序列化）的方法
StringBuilder value = new StringBuilder();
if (!this.GetType().IsClass)
return value.ToString();
PropertyInfo[] properties = this.GetType().GetProperties(); foreach (var property in properties)
{
string propertyName = property.Name;
IList<CustomAttributeData> list = CustomAttributeData.GetCustomAttributes(property);
foreach (var item in list)
{
if (item.Constructor.DeclaringType == typeof(DisplayNameAttribute))
{
Console.Write("This property applies DisplayNameAttribute.");
}
}
}
return base.ToString();
}
- 条件attribute
应用attribute时生成元数据，如果想让attribute在编译是不生成元数据可以使用条件编译，下面是例子
#define Specify
//#define UnSpecify namespace Attribute
{
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Reflection;
using System.Diagnostics; public class Pepople
{
[DisplayName("姓名")]
[TestDemoAttribute]
public string Name { get; set; }
} public class Man : Pepople
{
[DisplayName("年龄")]
public int Age { get; set; } public float Height { get; set; }
} [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
[Conditional("Specify")]
public class DisplayNameAttribute : Attribute
{
public string PropertyName { get; set; } public DisplayNameAttribute()
{ } public DisplayNameAttribute(string propertyName)
{
this.PropertyName = propertyName;
}
} [Conditional("UnSpecify")]
public class TestDemoAttribute : Attribute
{ }
}
条件attribute
注意：赘述一句，在C#中进行预定义时，必须在文件在最前面
我们用ildasm查看元数据得知，TestDemoAttribute 没有被编译成员数据，而DisplayNameAttribute被编译成了元数据
- 实例
对上面提到的知识写了个例子，以便加强知识的理解运用。
#define Specify
//#define UnSpecify namespace Attribute
{
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Reflection;
using System.Diagnostics; public class Pepople
{
[DisplayName("姓名")]
[TestDemoAttribute]
public string Name { get; set; } public override string ToString()
{
StringBuilder value = new StringBuilder();
if (!this.GetType().IsClass)
return value.ToString();
PropertyInfo[] properties = this.GetType().GetProperties(); foreach (var property in properties)
{
string propertyName = property.Name;
if (property.IsDefined(typeof(DisplayNameAttribute), false))
{
DisplayNameAttribute attr = (DisplayNameAttribute)Attribute.GetCustomAttribute(property, typeof(DisplayNameAttribute));
if (attr != null)
{
propertyName = attr.PropertyName;
}
}
value.Append(propertyName);
value.Append("\t");
value.Append(property.GetValue(this, null));
value.Append("\n\r");
} return value.ToString();
}
} public class Man : Pepople
{
[DisplayName("年龄")]
public int Age { get; set; } public float Height { get; set; }
} public static class OutputerClass
{
public static string StringClass(object obj)
{
StringBuilder value = new StringBuilder();
if (!obj.GetType().IsClass)
return value.ToString();
PropertyInfo[] properties = obj.GetType().GetProperties(); foreach (var property in properties)
{
DisplayNameAttribute attr = (DisplayNameAttribute)Attribute.GetCustomAttribute(property, typeof(DisplayNameAttribute));
if (attr != null)
{
value.Append(attr.PropertyName);
value.Append("\t");
value.Append(property.GetValue(obj, null));
value.Append("\n\r");
}
} return value.ToString();
}
} //可以用attributeUsage声明属性应用的范围，可以多选，多选的时候|运算即可
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
[Conditional("Specify")]
public class DisplayNameAttribute : Attribute
{
public string PropertyName { get; set; } public DisplayNameAttribute()
{ } public DisplayNameAttribute(string propertyName)
{
this.PropertyName = propertyName;
}
} [Conditional("UnSpecify")]
public class TestDemoAttribute : Attribute
{ }
}
实例