转载

Spring Boot - 表单校验（JSR303&Hibernate Validator）

回顾

Spring Boot - 初识 Hello World
Spring Boot - Servlet、过滤器、监听器、拦截器
Spring Boot - 静态资源处理、启动加载、日志处理
Spring Boot - 部署Deploy
Spring Boot - 整合jsp后必须通过spring-boot:run方式启动？
Spring Boot - 为什么整合jsp后必须通过spring-boot:run方式启动？
Spring Boot - 自定义启动banner

背景

本专栏所有案例基于Spring Boot 1.5.1进行讲解，在Spring Boot 1.5.1中使用的校验器是hibernate validator 5.3.4 Final。

hibernate validator 5.3.4 Final是JSR 303 Bean Validation 1.1的具体实现。

本文跟大家初步了解一下hibernate validator的一些使用技巧。

初步使用

hibernate vilidator主要使用注解的方式对bean进行校验，第一个例子：

package com.learn.validate.domain;

import javax.validation.constraints.Min;
import org.hibernate.validator.constraints.NotBlank;

public class Student {
     //在需要校验的字段上指定约束条件
     @NotBlank
     private String name;
     @Min(3)
     private int age;
     @NotBlank
     private String classess;
    
      public String getName() {
      return name;
     }
     public void setName(String name) {
      this.name = name;
     }
     public int getAge() {
      return age;
     }
     public void setAge(int age) {
      this.age = age;
     }
     public String getClassess() {
      return classess;
     }
     public void setClassess(String classess) {
      this.classess = classess;
     }

}

然后在controller中可以这样调用，加上@Validated注解即可。

package com.learn.validate.controller;

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.learn.validate.domain.Student;

@RestController
public class ValidateController {

     @RequestMapping(value="testStudent")
     public void testStudent(@Validated Student student,BindingResult bindingResult) {
     //
     }
}

如果校验失败，默认会返回Spring boot 框架的出错信息。是一个json串，里面有详细的出错描述。

分组校验

在上面的例子中，如果Student bean想要用于两个不同的请求中，每个请求有不同的校验需求，例如一个请求只需要校验name字段,一个请求需要校验name和age两个字段，那该怎么做呢？

使用注解的groups属性可以很好的解决这个问题,如下所示：

package com.learn.validate.domain;
import javax.validation.constraints.Min;

import org.hibernate.validator.constraints.NotBlank;

public class Student {
    //使用groups属性来给分组命名，然后在需要的地方指定命令即可
    @NotBlank(groups=NAME.class)
    private String name;
    @Min(value=3,groups=AGE.class)
    private int age;
    @NotBlank
    private String classess;

    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public String getClassess() {
        return classess;
    }
    public void setClassess(String classess) {
        this.classess = classess;
    }

    public interface NAME{};

    public interface AGE{};

}

根据需要在@Validated属性中指定需要校验的分组名，可以指定1到多个。指定到的分组名会全部进行校验，不指定的不校验。

package com.learn.validate.controller;

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.learn.validate.domain.Student;
import com.learn.validate.domain.Student.AGE;
import com.learn.validate.domain.Student.NAME;

@RestController
public class ValidateController {

    @RequestMapping(value="testStudent")
    public void testStudent(@Validated Student student,BindingResult bindingResult) {

    }


    @RequestMapping(value="testStudent1")
    public void testStudent1(@Validated(NAME.class) Student student,BindingResult bindingResult) {

    }

    @RequestMapping(value="testStudent2")
    public void testStudent2(@Validated({NAME.class,AGE.class}) 
    Student student,BindingResult bindingResult) {

    }
}