从零学 spring cloud第2-2课：基础 Web 开发之数据校验

什么是Hibernate Validator

    我们在项目中，经常要对用户输入的参数进行一些参初步的校验，有些人会在前端JS中写一些校验，也有人写在业务代码中。Hibernate Validator框架 提供了更好的解决方案来解决这些问题，可以很优雅的方式实现参数的校验，让业务代码 和 校验逻辑 分开,不再编写重复的校验逻辑。Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。
    JSR 是一个规范⽂文档，指定了了一整套 API，通过标注给对象属性添加约束。Hibernate Validator 就是 JSR 规 范的具体实现，Hibernate Validator 提供了 JSR 规范中所有内置约束注解的实现，以及一些附加的约束注 解，除此之外用户还可以自定义约束注解。Spring Boot 的参数校验依赖于 hibernate-validator 来进行。使用 Hibernate Validator 校验数据，需要定义一 个接收的数据模型，使用注解的形式描述字段校验的规则。

Hibernate Validator 的作用

• 验证逻辑与业务逻辑之间进行了分离，
• 降低了程序耦合度 统一且规范的验证方式，
• 无需你再次编写重复的验证代码 你将更专注于你的业务

Hibernate Validator 的使用

项目的DEMO代码：https://github.com/heyu52/-spring-cloud
项目中，主要用于接口api的入参校验和 封装工具类在代码中校验两种使用方式。
我们依然使用上节的代码做修改
我们对User的字段，增加一些校验

    @NotEmpty(message="姓名不能为空")
    private String name;
    @Max(value = 100, message = "年龄不能大于100岁")
    @Min(value= 18 ,message= "必须年满18岁！" )
    private int age;
    @NotEmpty(message="性别不能为空")
    private String sex;

在webController增加保存用户的方法

    //@Valid 参数前面添加 @Valid 注解，代表此对象使用了参数校验；
    //BindingResult 参数校验的结果会存储在此对象中，可以根据属性判断是否校验通过，
    //校验不通过可以将错误信息打印出来。
    @RequestMapping("/saveUser")
    public User saveUser(@Valid User user, BindingResult result) {
        Date currentTime = new Date();
        SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String dateString = formatter.format(currentTime);

        System.out.println(dateString+" user:"+user);
        if(result.hasErrors()) {
            List<ObjectError> list = result.getAllErrors();
            for (ObjectError error : list) {
                System.out.println(error.getCode()+ ":" + error.getDefaultMessage());
            }
        }
        return user;
    }

这里有一个很重要的点要进行说明，千万不要认为，一个参数只能有一个注解，实际上它是可以有多个注解的。
我们在WebControllerTest中增加一个测试方法

   @Test
    public void saveUsers() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.post("/saveUser")
                .param("name","csnd")
                .param("age","6")
                .param("sex","男")
        );
    }

运行测试代码，

因为age这个参数我们只给了6，小于指定校验的最小值18，所有会有一个提示输出。其它参数请自行测试。
接下来我们试着在Postman中调用这个方法

我们的控制台输出：

神奇的事情出现了，方法居然接收不到参数值。
我们只要给参数多加一个注解，就能解决这个问题了
public User saveUser(@RequestBody @Valid User user, BindingResult result)
请注意，这里是两个注解，然后我们编译，再测试一次

方法传参就没有问题了。
当然，你也可以不使用多的这个注解，可以使用下面的方法来进行测试，我们先将**@RequestBody**去掉

结果是一样的。

注解说明

Hibernate Validator 基本上包含了常用的数据校验，包括校验属性是否为空、长度、大小、特定格式等，最完整的教程请参考官网的手册，官网地址：http://hibernate.org/validator/documentation/
以下是对hibernate-validator中部分注解进行描述：

注解	说明
@AssertTrue	用于boolean字段，该字段只能为true
@AssertFalse	该字段的值只能为false
@CreditCardNumber	对信用卡号进行一个大致的验证
@DecimalMax	只能小于或等于该值
@DecimalMin	只能大于或等于该值
@Digits(integer=,fraction=)	检查是否是一种数字的整数、分数,小数位数的数字
@Email	检查是否是一个有效的email地址
@Future	检查该字段的日期是否是属于将来的日期
@Length(min=,max=)	检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max	该字段的值只能小于或等于该值
@Min	该字段的值只能大于或等于该值
@NotNull	不能为null
@NotBlank	不能为空，检查时会将空格忽略
@NotEmpty	不能为空，这里的空是指空字符串
@Null	检查该字段为空
@Past	检查该字段的日期是在过去
@Pattern(regex=,flag=)	被注释的元素必须符合指定的正则表达式
@Range(min=,max=,message=)	被注释的元素必须在合适的范围内
@Size(min=, max=)	检查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
@URL(protocol=,host,port)	检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件
@Valid	该注解主要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用，这样在检查当前对象的同时也会检查该字段所引用的对象