Hibernate Validator 的使用及整合springboot

1. Hibernate Validator 简介

平时项目中，难免需要对参数 进行一些参数正确性的校验，这些校验出现在业务代码中，让我们的业务代码显得臃肿，而且，频繁的编写这类参数校验代码很无聊。鉴于此，觉得 Hibernate Validator 框架刚好解决了这些问题，可以很优雅的方式实现参数的校验，让业务代码 和 校验逻辑 分开,不再编写重复的校验逻辑。
Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。
Bean Validation 为 JavaBean 验证定义了相应的元数据模型和API。缺省的元数据是 Java Annotations，通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

2.Hibernate Validator 的作用

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

3.Hibernate Validator 的使用

项目中，主要用于接口api 的入参校验和 封装工具类 在代码中校验两种使用方式。

一般可用于PO表单提交对象的参数验证 @Validated @Valid

public class UserPo {
	@NotBlank(message = "用户名称不能为空。")
	private String name;
 
	@Range(max = 150, min = 1, message = "年龄范围应该在1-150内。")
	private Integer age;
 
	@NotEmpty(message = "密码不能为空")
	@Length(min = 6, max = 8, message = "密码长度为6-8位。")
	@Pattern(regexp = "[a-zA-Z]*", message = "密码不合法")
	private String password;
 }
 
 
     @PostMapping("v/sava")
     public void sava(@RequestBody @Validated User user, BindingResult result) {
         
     }

@Valid递归的对关联的对象进行校验
Bean Validation 中内置的 constraint
注解 作用

@Valid 被注释的元素是一个对象，需要检查此对象的所有字段值
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(value) 被注释的元素必须符合指定的正则表达式

Hibernate Validator 附加的 constraint

注解 作用
@Email 被注释的元素必须是电子邮箱地址
@Length(min=, max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=, max=) 被注释的元素必须在合适的范围内
@NotBlank 被注释的字符串的必须非空
@URL(protocol=,host=, port=, regexp=, flags=) 被注释的字符串必须是一个有效的url
@CreditCardNumber 被注释的字符串必须通过Luhn校验算法，银行卡，信用卡等号码一般都用Luhn计算合法性
@ScriptAssert(lang=, script=, alias=) 要有Java Scripting API 即JSR 223 (“Scripting for the JavaTM Platform”)的实现
@SafeHtml(whitelistType=, additionalTags=) classpath中要有jsoup包

hibernate补充的注解中，最后3个不常用，可忽略。
主要区分下@NotNull @NotEmpty @NotBlank 3个注解的区别：
@NotNull 任何对象的value不能为null
@NotEmpty 集合对象的元素不为0，即集合不为空，也可以用于字符串不为null
@NotBlank 只能用于字符串不为null，并且字符串trim()以后length要大于0
@Nullable 允许为空

4.Hibernate Validator 整合springboot

导入依赖

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.19.Final</version>
</dependency>

配置类

/**
 * @author: dxf
 * @description: 快速失败返回模式(只要有一个验证失败，则返回)
 * @date: 2020-12-14 22:03
 * @modified by:
 */
@Configuration
public class ValidatorConfiguration {

    /**
     * JSR和Hibernate validator的校验只能对Object的属性进行校验
     * 不能对单个的参数进行校验
     * spring 在此基础上进行了扩展
     * 添加了MethodValidationPostProcessor拦截器
     * 可以实现对方法参数的校验
     *
     * @return
     */
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();
        /**设置validator模式为快速失败返回*/
        postProcessor.setValidator(validator());
//                <!-- 校验器的工作模式:
//        validator.fail_fast:快速失败返回模式(只要有一个验证失败，则返回异常)
//        validator.normal:普通模式(会校验完所有的属性，然后返回所有的验证失败信息)

        return postProcessor;
    }

    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
                .configure()
                .addProperty( "hibernate.validator.fail_fast", "true" )
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        return validator;
    }
}

添加异常处理返回参数校验提示

/**
 * @Author: dxf
 * @Description: 自定义全局异常处理类
 * @Date: Created in 2020-08-20 15:32
 * @Modified By:
 */
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 处理自定义的业务异常
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class)
    @ResponseBody
    public ResultJson bizExceptionHandler(HttpServletRequest req, BizException e){
        log.error("发生业务异常！原因是：{}",e.getErrorMsg());
        return ResultJson.error(e.getErrorCode(),e.getErrorMsg());
    }


    /**
     *Hibernate validator参数校验
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    public Object validatorHandler(MethodArgumentNotValidException exception){
        FieldError fieldError = exception.getBindingResult().getFieldError();
        assert fieldError != null;
        return ResultJson.error(fieldError.getDefaultMessage());
    }

}

运用

@Data
public class RegistUserPo {

    @Length(min = 5,max = 12, message = "用户昵称，长度在[5,12]之间")
    @NotBlank(message = "用户昵称，不能为空")
    @ApiModelProperty(value = "用户昵称")
    private String name;

    @Email
    @NotBlank(message = "登录账号(邮箱)，不能为空")
    @ApiModelProperty(value = "登录账号(邮箱)")
    private String account;

    @Length(min = 6, max = 12, message = "用户密码，长度在[6,12]之间")
    @NotBlank(message = "用户密码，不能为空")
    @ApiModelProperty(value = "用户密码")
    private String password;

    @Length(min = 6, max = 12, message = "确认密码，长度在[6,12]之间")
    @NotBlank(message = "确认密码，不能为空")
    @ApiModelProperty(value = "确认密码")
    private String confirmPass;

    @NotBlank(message = "验证码，不能为空")
    @ApiModelProperty(value = "验证码")
    private String code;
}

@Valid

@PostMapping("/regist")
@ApiOperation("用户注册")
@ResponseBody
public ResultJson regist(@RequestBody @Valid RegistUserPo po){
    
}