第十节：数据批注(DataAnnotationModel)和自定义验证(包括Model级别的验证)

一. 简介

　　写完上一个章节MVC中的常用特性，迫不及待将该系列补全，该章节主要介绍数据批注（也叫：注解）。

　　一听【数据批注】，好高大上的名字，但仔细一看，它们其实是【System.ComponentModel.DataAnnotations】程序集下的一些特性类，O(∩_∩)O哈哈~，既然是特性，就符合特性的所有特征，只不过这些特性是作用于“属性”上的。

　　再一看【System.ComponentModel.DataAnnotations】这个命名空间，有点眼熟，与之前EF中的一篇文章【EF的CodeFirst模式通过DataAnnotations修改默认协定】中的一类操作来源于同一个命名空间下。

　　所以综上所述：该命名空间下的特性，在EF中可以用来映射生成数据库中的表字段，在日常开发中也可以用于做类中属性的限制和验证。

原理：均继承了ValidationAttribute特性，通过覆写IsValide方法进行校验。

适用场景：很多项目需要客户端和服务器端进行双重格式验证,使之更加安全,这时服务器端就可以使用数据批注了来进行校验了。

以Required特性为例，查看一下源码：

 

二. 常用的数据批注

这里总结一下【System.ComponentModel.DataAnnotations】命名空间下常用的数据批注，即特性。

 ① Key ：声明主键

 ② Required：非空声明

 ③ MinLength和MaxLength：设置string类型的最大长度和最小长度,数据库的对应nvarchar

 ④ StringLength:设置string类型的长度，数据库对应nvarchar

 ⑤ Compare：新老密码对比

 ⑥ RegularExpression：正则的匹配

 ⑦ Phone：验证手机号码

 ⑧ Range：验证范围

 ⑨ Timestamp:将byte[]类型设置为timestamp类型  

 ⑩ ConcurrencyCheck:并发检查,执行update操作时，会检查并发性(乐观锁)   (在后面并发章节着重介绍Timestamp和ConcurrencyCheck)

另外还有一些不是很常用的，如：

 ① DisplayName：声明属性的名称

 ② Remote：远程验证，需要JQuery插件的支持  (这里不做测试等待补充  参考： https://www.cnblogs.com/JustRun1983/p/3505151.html)

 下面补充一下该命名空间反射源码，可以自行查找需要的批注：

 

代码测试： 

(1). 实体类，在其属性上添加数据标注

    /// <summary>
    /// 用户信息类 ,用于测试框架本身提供的数据批注
    /// </summary>
    public class UserInfor
    {
        [Required]
        public string id { get; set; }

        [StringLength(4)]
        public string userName { get; set; }

        [MaxLength(8)]
        public string userMsg { get; set; }

        [Range(2, 10)]
        public int userAge { get; set; }

        [RegularExpression("[a-d]")]   //a-d中的一个
        public string userMsg3 { get; set; }

        [Phone]
        public string userPhone { get; set; }

        public string userOldPwd { get; set; }

        [Compare("userOldPwd")]  //比较和userOldPwd的值是否相等
        public string userNewPwd { get; set; }

    }

(2). 前端代码

           //1. 测试数据批注
            $("#btn1").click(function () {
                $.ajax({
                    type: "Post",  
                    url: "TestDataAnnotationModel",
                    data: {
                        "id":"123",
                        "userName": "mr12",
                        "userMsg": "ypf1234",
                        "userAge": 6,
                        "userMsg3": "a",
                        "userPhone": "15764222366",
                        "userOldPwd": "123456",
                        "userNewPwd":"123456"

                    },
                    success: function (data) {
                        if (data == "ok") {
                            alert("测试通过");
                        }
                        if (data == "error") {
                            alert("测试未通过");
                        }
                    }
                });
            });        

(3). 服务器端代码

  public ActionResult TestDataAnnotationModel(UserInfor user)
        {
            //通过该方法进行验证
            var isValidate = ModelState.IsValid;

            if (isValidate)
            {
                return Content("ok");
            }
            return Content("error");
        }

 

三. 自定义数据批注

 思路：通过上面的批注源码可知，均为自定义类继承：ValidationAttribute，覆写IsValid方法

 需求：这里我们自定义一个批注，要求不为空，且长度区间为6-12位

 使用方法同样为：action中通过实体接收,通过ModelState.IsValid的值为true或false来判断验证是否通过

代码测试：

(1). 实体类和自定义批注

    /// <summary>
    /// 角色类，用于测试自定义业务的数据批注
    /// </summary>
    public class RoleInfor
    {

        public string id { get; set; }

        [myOwnCheck]
        public string roleName { get; set; }
    }

    /// <summary>
    /// 自定义数据批注,要求非空且长度为6-12位
    /// </summary>
    public class myOwnCheckAttribute : ValidationAttribute
    {
        public override bool IsValid(object value)
        {
            if (value != null && value.ToString().Length > 6 && value.ToString().Length < 12)
            {
                return true;
            }
            return false;
        }
    }

(2). 前端代码

           //2. 测试自定义业务逻辑的验证
            $("#btn2").click(function () {
                $.ajax({
                    type: "Post",
                    url: "TestMyOwnCheck", 
                    data: {
                        "id": "123",
                        "roleName": "mr12345"
                    },
                    success: function (data) {
                        if (data == "ok") {
                            alert("测试通过");
                        }
                        if (data == "error") {
                            alert("测试未通过");
                        }
                    }
                });
            });

(3). 服务器端代码

   public ActionResult TestDataAnnotationModel(UserInfor user)
        {
            //通过该方法进行验证
            var isValidate = ModelState.IsValid;

            if (isValidate)
            {
                return Content("ok");
            }
            return Content("error");
        }

 

四. Model级别的验证扩展

 　　实现IValidaableObjec接口，实现Validate方法。（了解即可）

 public class CarInfor: IValidatableObject
    {
        public string id { get; set; }

        public string carName { get; set; }

        public int carAge { get; set; }

        IEnumerable<ValidationResult> IValidatableObject.Validate(ValidationContext validationContext)
        {
            if (carAge % 2 == 0)
            {
                var result = new ValidationResult("车龄验证不通过", new string[] { "carAge" });

                yield return result;
            }
        }
    }