首页 > 代码库 > C#基础--Attribute(标签) 和 reflect(反射) 应用
C#基础--Attribute(标签) 和 reflect(反射) 应用
1.Attribute的定义与作用:
公共语言运行时允许你添加类似关键字的描述声明,叫做attributes, 它对程序中的元素进行标注,如类型、字段、方法和属性等。Attributes和Microsoft .NET Framework文件的元数据保存在一起,可以用来向运行时描述你的代码,或者在程序运行的时候影响应用程序的行为.比如在WCF中常用的序列化。比如添加的[DataMenber]就是一种标签。以及xml序列化也是一样的。
2.Reflect的定义与作用
反射可以用于观察并修改程序在运行时的执行。一个reflection-oriented程序组件可以监测一个范围内的代码执行情况,可以根据期望的目标与此相关的范围修改本身。这通常是通过在运行时动态分配程序代码实现。在面向对象的编程语言如Java中,反射允许在编译期间不知道接口的名称,字段、方法的情况下在运行时检查类、接口、字段和方法。它还允许的实例化新对象和调用的方法。(摘抄至维基百科). 其实可以简单理解为,通过反射可以很轻易的获取到一个类中的所有方法属性字段状态。
3.为了更方便的认识反射以及Attribute的应用,下面有个例子.
业务背景如下: 有个Person对象,目前只有Name和Num属性,然后要用方法校验Person对象的合法性。
判断规则: 1.Name必填,若Name为空,则提示"Name不能为空";
2.Num可以为空,但是若有数据的话必须由数字组成,若为非数字字符串则弹出"格式不正确".
3.Address可以为空,若有数据的话长度不能超过12,若超过12则提示"Address 长度不能超过12"
需要考虑: 对于Person类,以后熟悉的判断规则可能会变化,也可能增加属性,减少属性。
4.解决方案一:
对于常规解决方案,可能大家会想到。目前只有Name,Address,Num三个属性,每次我就写三个代码段分别对Name,Address,Num验证。如果增加属性, 比如增加了公共属性EmailAddress,那么就必须添加验证字符串是否是邮箱的代码,若删除了某个属性,就吧判断该属性是否合格的代码删除掉不进行判断。这个也是我最开始想到的方法。不过这样不好的地方是可维护性不好。改动太大了。而且会导致重复代码。不如如果需求改成Address不能为空了。那么在判断address是否合法的时候还要去添加判断不能为空的情况。
5.解决方案二:
为了解决方案一的问题,其实我们可以通过Attribute和反射来实现。思路如下:
5.1 首先我们创建一个PersonCheckAttribute对象,他继承与System.Attribute.
复制代码
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace ReflectTest.Model
{
public class PersonCheckAttribute:Attribute
{
// 三个bool变量用于确定是有要验证这些信息
private bool checkEmpty = false; //是否为空
private bool checkMaxLength = false; //最大长度
private bool checkRegex = false; //用正则表达式验证参数(是邮箱,是否刷数字)
private int maxLength = 0;
private string regexStr = string.Empty;
public bool CheckEmpty
{
get { return this.checkEmpty; }
set { this.checkEmpty = value; }
}
public bool CheckMaxLength
{
get { return this.checkMaxLength; }
set { this.checkMaxLength = value; }
}
public bool CheckRegex
{
get { return this.checkRegex; }
set { this.checkRegex = value; }
}
public int MaxLength
{
get { return this.maxLength; }
set { this.maxLength = value; }
}
public string RegexStr
{
get { return this.regexStr; }
set { this.regexStr = value; }
}
}
}
复制代码
5.2 然后我们来添加Person类。注意里面的标签。
Tips:我在里面打了标签,对于5.1的PersonCheckAttribute类中bool变量用来确定是否要进行验证,公共属性用来存取判断参数。
复制代码
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace ReflectTest.Model
{
public class Person
{
[PersonCheck(CheckEmpty=true)]
public string Name { get; set; }
[PersonCheck(CheckRegex = true, RegexStr = "^[0-9]*[1-9][0-9]*$")]
public string Num { get; set; }
[PersonCheck(CheckMaxLength = true, MaxLength = 12)]
public string Address { get; set; }
}
}
复制代码
5.3 属性已经搞定,下面来看看,如何通过反射来获取类的公共属性,以及每个属性的Attribute。
复制代码
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using ReflectTest.Model;
using System.Reflection;
using System.Text.RegularExpressions;
namespace ReflectTest.Business
{
public class PersonCheck
{
// 获取所有的错误提示
public static string GetErrorMessage(Person person)
{
PropertyInfo[] propertyInfos = person.GetType().GetProperties(); // 获取一个类的所有属性
string errorMsg = string.Empty;
//对所有公用属性(Name,Num,Address)遍历
foreach (PropertyInfo info in propertyInfos)
{
errorMsg += GetSignalPropertity(info, person);
}
return errorMsg;
}
// 获取单个公共属性的Attribute.也就是model类里面的[PersonCheck]信息
private static string GetSignalPropertity(PropertyInfo propertyInfo,Person person)
{
// 因为对于此示例,每个Properties(属性)只有一个Attribute(标签),所以用了first()来获取,
// 不过有一点,就是必须在属性里面添加[PersonCheck]标签,但是可以不设置表情里面的字段.因为没有的.GetCustomAttributes()返回为null.指向first会报错.
PersonCheckAttribute attribute = propertyInfo.GetCustomAttributes().First() as PersonCheckAttribute;
string errorMsg = string.Empty;
//以下的if语句是判断标签里面的设置,设置了什么就执行什么数据校验
if (attribute.CheckEmpty)
{
string obj = propertyInfo.GetValue(person) as string;
if (string.IsNullOrEmpty(obj))
{
errorMsg += Environment.NewLine + string.Format("{0} 不能为空", propertyInfo.Name);
}
}
if (attribute.CheckMaxLength)
{
string obj = propertyInfo.GetValue(person) as string;
if (obj != null && obj.Length > attribute.MaxLength)
{
errorMsg += Environment.NewLine + string.Format("{0} 最大长度为{1}", propertyInfo.Name, attribute.MaxLength);
}
}
// 对于判断数字邮箱都可以通过正则表达式
if (attribute.CheckRegex)
{
string obj = propertyInfo.GetValue(person) as string;
Regex regex = new Regex(attribute.RegexStr);
if (obj != null && !regex.IsMatch(obj))
{
errorMsg += Environment.NewLine + string.Format("{0} 格式不对", propertyInfo.Name);
}
}
return errorMsg;
}
}
}
C#基础--Attribute(标签) 和 reflect(反射) 应用
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。