C# 利用特性(Attribute)实现通用实体类数据合法校验

用过asp.net mvc 的都应该知道，在实体类上添加一些特性,可以实现后端实体的数据校验，这里简单实现一下

实现原理：利用反射获取实体的每一个属性，并通过属性获取属性上标注的特性，调用特性的Validate方法（此方法自定义的）来验证属性的值是否合法。

1、创建自己的校验特性基类

此类继承了Attribute，表明为一个特性，Validate方法为抽象方法，目的是给实现的子类自己定义自己的Validate方法。error为错误消息提示信息。

[AttributeUsage(AttributeTargets.Property,AllowMultiple = true)]
    public abstract class BaseAttribute:Attribute
    {
        public virtual string error { get; set; }
        public abstract bool Validate(object value);
    }

2、创建特性类继承自BaseAttribute

这里只简单写3个特性，写法都一样，只是校验方法Validate中的逻辑不一样。

/// <summary>
    /// 约束属性不能为空
    /// </summary>
    public class RequiredAttribute : BaseAttribute
    {
        public override string error {
            get
            {
                if (base.error != null)
                {
                    return base.error;
                }
                return "属性不能为空";
            }
            set => base.error = value;
        }
        public override bool Validate(object value)
        {
            return !(value == null);
        }
    }

/// <summary>
    /// 约束字符串的长度范围
    /// </summary>
    public class StringRangeAttribute : BaseAttribute
    {
        public int min { get; set; }
        public int max { get; set; }
        public override string error {
            get {
                if (base.error != null)
                {
                    return base.error;
                }
                return $"字符串长度范围{this.min}-{this.max}";
            }
            set => base.error = value; }
        public override bool Validate(object value)
        {
            return value.ToString().Length >= this.min && value.ToString().Length <= this.max;
        }
    }

/// <summary>
    /// 约束符合正则表达式
    /// </summary>
    public class RegexAttribute : BaseAttribute
    {
        public string regexText;
        public override bool Validate(object value)
        {
            var regex = new Regex(regexText);
            return regex.Match(value.ToString()).Success;
        }
    }

3、给实体类扩展一个方法，用来验证实体类实例属性值是否合法

此方式的扩展方法会污染其他非实体类，不是太推荐用太多此种扩展写法，其实这里不写成扩展方法也没什么问题。

此扩展方法会验证实例中的所有属性，并将所有不通过验证的属性的提示信息以字符串的形式返回，所有都验证通过则返回空串。

public static string Validate<T>(this T t)
        {
            Type type = t.GetType();

            //获取所有属性
            PropertyInfo[] propertyInfos = type.GetProperties(BindingFlags.Instance|BindingFlags.Public|BindingFlags.NonPublic);
            List<string> errorList = new List<string>();
            foreach (PropertyInfo propertyInfo in propertyInfos)
            {
                if(propertyInfo.IsDefined(typeof(BaseAttribute)))//如果属性上有定义该属性,此步没有构造出实例
                {
                    foreach (BaseAttribute attribute in propertyInfo.GetCustomAttributes(typeof(BaseAttribute)))
                    {
                        if (!attribute.Validate(propertyInfo.GetValue(t, null)))
                        {
                            errorList.Add( $"[{propertyInfo.Name}]" + attribute.error);
                        }
                    }
                    
                }
            }
            return string.Join(",", errorList);
        }

4、定义一个实体类，并测试（控制台程序）。

假设有Student.cs ,在其id属性中添加Required特性，name属性上添加StringRange和Regex特性。

public class Student
    {
        [Required(error = "id 不能为空！")]
        public int? id { get; set; }
        [Regex(regexText = "^a.*a$",error = "属性不合格规则")]
        [StringRange(min =5,max =10)]
        public string name { get; set; }
    }

static void Main(string[] args)
        {
            Student student = new Student()
            {
                id = null,
                name = "ajiudsagasgasgaxb"
            };
            string errorStr = student.Validate();
            Console.WriteLine(errorStr);
            Console.ReadKey();
        }

测试结果

 

此代码纯属自己理解的原理性还原，代码可能有多处写的不严谨。