C#高级开发之 特性(Attribute)三

一、什么是特性  

 特性：特性实际是一个类 直接/间接继承Attribute类 命名一般以Attribute结尾，用中括号([])标注申明该对象且一般省略Attribute。添加特性后，编译后元素会在IL内部产生，而且在metadata里会有记录(实际上会产生对应的构造函数从IL中可以查看)，所以必须通过反射才能查到或获取对应信息（反射读取metadata信息）。

 特性是额外附带的一些信息不主动调用它对程序并不产生相应功能，需要主动调用。系统里的特性是程序运行的时候已经调用好了且查找过所以可以直接标注就能用，自定义的特性就必须得主动去调用。

二、自定义特性

C#中除了系统自带的特性外我们可以自己定义一些特性。所有自定义的Attribute必须从Attribute类派生(直接或间接继承Attribute类)，命名一般以Attribute结尾，在使用的时候可以省略Attribute。特性在没有破坏类型封装的前提下，可以加点额外的信息和行为。特性 本身是没啥用处的，必须主动使用，程序运行的过程中，我们通过反射能找到，这样就可以用了。

1. 特性的声明及使用

namespace MyAttribute
{
    public class CustomAttribute : Attribute//必须直接或间接继承Attribute类
    {
        public CustomAttribute()
        {

        }
        public CustomAttribute(int i)
        {
        }
        public string Description { get; set; }
        public string Remark = null;
        public void show()
        {
            Console.WriteLine($"this is{nameof(CustomAttribute)}");
        }
        public void login()
        {
            Console.WriteLine($" this is{nameof(CustomAttribute)}登陆了");
        }
    }
}

 在user类中标记特性

namespace MyAttribute
{
    [Custom(123,Remark="总监",Description ="系统用户")]//修饰类，类似实例化一个类，指定调用的构造方法，指定类的属性，字段等
    public class User 
    {
        public string Name { set; get; }
        
        public string Account { set; get; }
        [Leng(2, 10)]
        public string Password { set; get; }

        public string Email { set; get; }

        public string Mobile { set; get; }

        public int CompanyId { set; get; }
        [Custom(Remark = "张氏集团", Description = "系统用户")]//类似实例化一个类，调用相对应的构造函数
        public string CompanyName { set; get; }

        /// <summary>
        /// 用户状态  0正常 1冻结 2删除
        /// </summary>
        [Custom(Remark = "正常")]
        public int State { set; get; }

        /// <summary>
        /// 用户类型  1 普通用户 2管理员 4超级管理员
        /// </summary>
        public int UserType { set; get; }

        public DateTime LastLoginTime { set; get; }

        public DateTime CreateTime { set; get; }

        public int CreatorId { set; get; }

        public int LastModifierId { set; get; }

        public DateTime LastModifyTime { set; get; }
        [Custom(Remark = "总监", Description = "系统用户")]//类似实例化一个类，默认调用无惨构造函数
        public void login([Custom(Remark ="123")]string name )//给方法的参数修饰
        {
            Console.WriteLine($"this is{name}");
        }
        public void logout()
        {
            Console.WriteLine("this is logout");
        }
    }
}

 三、反射查找类及类的成员上标注的特性 

 public static void Show(User user)
        {
            //通过反射访问类上标注的特性
            Type type = user.GetType();
            if (type.IsDefined(typeof(CustomAttribute), true))//检测某一类型是否有该特性
            {
                //通过反射查找特性实际上是在调用构造函数创建对象
                CustomAttribute customAttribute=(CustomAttribute)type.GetCustomAttribute(typeof(CustomAttribute), true);
                Console.WriteLine($"{customAttribute.Remark}_{customAttribute.Description}");
                //user.login();
            }
            //通过反射访问属性上标注的特性
            PropertyInfo propertyInfo = type.GetProperty("Name");
            if (propertyInfo.IsDefined(typeof(CustomAttribute), true))//检测某一类型是否有该特性
            {
                //通过反射查找特性实际上是在调用构造函数创建对象
                CustomAttribute customAttribute = (CustomAttribute)propertyInfo.GetCustomAttribute(typeof(CustomAttribute), true);
                Console.WriteLine($"{customAttribute.Remark}_{customAttribute.Description}");
                //user.login();
            }
            //通过反射访问方法上标注的特性
            MethodInfo methodInfo = type.GetMethod("login");
            if (methodInfo.IsDefined(typeof(CustomAttribute), true))//检测某一类型是否有该特性
            {
                //通过反射查找特性实际上是在调用构造函数创建对象
                CustomAttribute customAttribute = (CustomAttribute)methodInfo.GetCustomAttribute(typeof(CustomAttribute), true);
                Console.WriteLine($"{customAttribute.Remark}_{customAttribute.Description}");
                //user.login();
            }
            //通过反射访问方法参数上标注的特性
            ParameterInfo parameterInfo  = methodInfo.GetParameters()[0];
            if (parameterInfo.IsDefined(typeof(CustomAttribute), true))//检测某一类型是否有该特性
            {
                //通过反射查找特性实际上是在调用构造函数创建对象
                CustomAttribute customAttribute = (CustomAttribute)parameterInfo.GetCustomAttribute(typeof(CustomAttribute), true);
                Console.WriteLine($"{customAttribute.Remark}_{customAttribute.Description}");
                //user.login();
            }
            user.login("张三");
        }

  四、特性的运用（额外增加信息和行为）

给字段或是属性添加额外的信息 本示例是给枚举类型扩展一个方法来读取添加的额外信息

 public enum UserState
    {
        /// <summary>
        /// 正常
        /// </summary>
        [Remark("正常")]
        Normal = 0,
        /// <summary>
        /// 冻结
        /// </summary>
        [Remark("冻结")]
        Frozen = 1,
        /// <summary>
        /// 
        /// </summary>
        [Remark("删除")]
        Deleted = 2

    }
    /// <summary>
    /// 自定义特性 获取传入参数的值
    /// </summary>
    public class RemarkAttribute : Attribute
    {
        private string _remark = null;
        public RemarkAttribute(string remark)
        {
            this._remark = remark;
        }
        public string GetRemark()
        {
            return this._remark;
        }
    }
 /// <summary>
    /// 枚举扩展方法 静态类+静态方法 然后参数前面加个this
    /// </summary>
    public static class RemarkExtension
    {
        public static string GetRemark(this Enum value)
        {
            Type type = value.GetType(); //typeof(Enum);
            FieldInfo field = type.GetField(value.ToString());//反射获取字段信息
            if (field.IsDefined(typeof(RemarkAttribute), true))//查看是否有该属性
            {   //获取字段上面的属性
                RemarkAttribute remarkAttribute = (RemarkAttribute)field.GetCustomAttribute(typeof(RemarkAttribute), true);
                return remarkAttribute.GetRemark();
            }
            else
            {
                return value.ToString();
            }
        }
    }

扩展方法特特殊调用方式：UserState.Frozen.GetRemark()等价于RemarkExtension.GetRemark(UserState.Frozen)//原本调用方式静态类静态方法

给字段或是属性添加额外的行为 本示例是给object类型扩展一个方法来调用特性中的方法即添加额外行为

给实体类中添加特性行为
[Leng(2, 10)]
public string Password { set; get; }

  public class LengAttribute : Attribute
    {
        private int _max;
        private int _min;

        public LengAttribute(int min, int max)
        {
            _max = max;
            _min = min;
        }
        public bool Validate(object value)
        {
            if (value != null && value.ToString().Length > this._min && value.ToString().Length < this._max)
            {
                return true;
            }
            return false;
        }

    }
    /// <summary>
    /// object类型扩展方法 静态类+静态方法 然后参数前面加个this
    /// </summary>
    public static class ValidateExtension
    {
        public static bool Validate(this object ovalue)
        {
            Type type = ovalue.GetType(); //typeof(Enum);
            foreach (var propertyInfo in type.GetProperties()) //反射获取字段信息
            {
                if (propertyInfo.IsDefined(typeof(LengAttribute), true))//查看是否有该属性
                {   //获取字段上面的属性
                    LengAttribute lengAttribute = (LengAttribute)propertyInfo.GetCustomAttribute(typeof(LengAttribute), true);
                    if (!lengAttribute.Validate(propertyInfo.GetValue(ovalue)))
                    { return false; }
                }
            }
            return true;
        }
    }

 调用方式 

User user = new User();
user.Name = "张三";
user.Password = "123456";
if (user.Validate()) //扩展方法的方式调用方法
{
Console.WriteLine($"{user.Name}验证通过");
}
user.Password = "1";
if (ValidateExtension.Validate(user))//普通方式调用静态方法静态类等价上述调用方式
{
Console.WriteLine($"{user.Name}的密码太简单不通过");
}

目前.Net中特性在框架中运用的比较平凡，内部封装了很多特性，架构一个框架特性的运用少不了。