JSR验证框架 hibernate-validator

原文地址：https://blog.csdn.net/wuseyukui/article/details/81164207

JSR-303 与 hibernate-validator

Spring3支持JSR-303验证框架，JSR-303 是Java EE 6 中的一项子规范，叫做BeanValidation，官方参考实现是hibernate-validator（与Hibernate ORM 没有关系），JSR 303 用于对Java Bean 中的字段的值进行验证。

hibernate-validator实现了JSR-303规范，并扩展了一些注解，提供了一套比较完善、便捷的验证实现方式。

常用验证：
@Null 任意类型限制只能为null
@NotNull 任意类型限制必须不为null
@NotEmpty CharSequence子类型、Collection、Map、数组验证注解的元素值不为null且不为空字符串""，但是可以是多个空格" "（字符串长度不能为0、集合大小不能为0）
@NotBlank CharSequence子类型验证注解的元素值不为空（不为null、去除首位空格后长度不能为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的前后空格
@AssertFalse Boolean,boolean 限制必须为false
@AssertTrue Boolean,boolean 限制必须为true
@DecimalMax(value=值) 和@Max要求一样限制必须为一个小于等于指定值的数字
@DecimalMin(value=值) 和@Min要求一样限制必须为一个大于等于指定值的数字
@Max(value) 限制必须为小于等于指定值的数字
@Min(value) BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型限制必须为大于等于指定值的数字
@Digits(integer=整数位数, fraction=小数位数) 限制必须为一个小数，且整数部分的位数不能超过元素值的整数位数和小数位数上限
@Future 与@Past要求一样验证注解的元素值（日期类型）限制必须是一个将来的日期（比当前时间晚）
@Pattern(value) String，任何CharSequence的子类型限制必须符合指定的正则表达式
@Size(max,min) 字符串、Collection、Map、数组等限制长度必须在min到max之间，如字符长度、集合大小
@Past java.util.Date,java.util.Calendar;Joda Time类库的日期类型验证注解的元素值（日期类型）限制必须是一个过去的日期（比当前时间早）
@Email 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式（注意，@Email默认是不校验非空的，需额外加上@NotBlank等注解）
@Length(min=下限, max=上限) CharSequence子类型验证注解的元素值长度在min和max区间内
@Range(min=最小值, max=最大值) BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型验证注解的元素值在最小值和最大值之间
@Valid 任何非原子类型指定递归验证关联的对象；如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

spring-boot-starter-web已默认依赖hibernate-validator包，故无需重复添加 spring-boot-starter-validation 依赖。若想单独实现 Bean 验证，则只需单加入 spring-boot-starter-validation 依赖即可。
spring-boot-starter-web依赖关系：


        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-starter-tomcat
        
        
            org.hibernate
            hibernate-validator
        
        
            com.fasterxml.jackson.core
            jackson-databind
        
        
            org.springframework
            spring-web
        
        
            org.springframework
            spring-webmvc

spring-boot-starter-validation依赖关系：


        
            org.springframework.boot
            spring-boot-starter
        
        
            org.apache.tomcat.embed
            tomcat-embed-el
        
        
            org.hibernate
            hibernate-validator

校验bean（参数封装成对象）

POST接口 + @Valid + BindingResult 验证示例：

@Controller
@RequestMapping("/user")
public class UserController {

    /**
     * 创建用户
     * @requestBody可以将请求体中的JSON字符串绑定到相应的bean上
     * BindingResult是验证不通过的结果集合
     */
    @RequestMapping(value = "/create", method = RequestMethod.POST)
    @ResponseBody
    public String postUser(@RequestBody @Valid User user, BindingResult result) {
        if (result.hasErrors()) {
            for (ObjectError error : result.getAllErrors()) {
                System.out.println(error.getDefaultMessage());
            }
            return "error";
        }
        return "success";
    }
}

常用示例

User.java

@Data // Lombok注解，可以使我们不用再在代码里手动加get、set、toString、equals和hashCode等方法
public class User {

    @NotBlank(message = "用户名不能为空")
    private String name;

    @NotBlank(message = "年龄不能为空")
    @Range(min = 0, max = 120, message = "年龄只能从0-120岁")
    private String age;

    // 如果是空，则不校验，如果不为空，则校验
    @Pattern(regexp = "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", message = "出生日期格式不正确")
    private String birthday;

}

示例2

import javax.validation.Configuration;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

public class Test{
    private static final Validator VALIDATOR;

    //获得验证器实例
    static {
        Configuration config = Validation.byDefaultProvider().configure();
        ValidatorFactory factory = config.buildValidatorFactory();
        VALIDATOR = factory.getValidator();
        factory.close();
    }

    public static void main(String []args){
        UserBo userBo = new UserBo(loginno, userName, operatorid, orgId, email, 
                                   mobile, password, status, effectDateLong, expireDateLong);
        Set> addValidate = VALIDATOR.validate(userBo);
        if (CollectionUtils.isNotEmpty(addValidate)) {
            StringBuilder stringBuilder = new StringBuilder();
            addValidate.forEach(item -> stringBuilder.append(item.getMessage()));
            return ResponseXml.updateAppAcctSoapResponse(
                "", "",
                SystemBusinessUtils.getArgusPropertyUtilValue("fourA.serviceid"),
                modifyMode, userId, loginno, "1", stringBuilder.toString());
        }
    }
}