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();
        }

測試結果

 

此代碼純屬自己理解的原理性還原，代碼可能有多處寫的不嚴謹。