spring boot集成validation

1.maven引入依赖starter

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.验证Java Bean

2.1新增校验分组接口

针对不同接口对同一实体的不同校验

//空接口即可
public interface UpdateGroup {
}

2.2对java bean需要验证的字段加上注解

//修改时校验id是否为空
@NotEmpty(message = "id不能空", groups = {UpdateGroup.class})
private String id;
@NotEmpty(message = "名称字段不能为空")
@Size(max = 20, message = "名称限制0~20个字符")
private String name;
@NotEmpty(message = "账号字段不能为空")
@Size(max = 20, message = "账号限制0~20个字符")
private String username;
@NotEmpty(message = "密码字段不能为空")
@Size(max = 50, message = "密码限制0~50个字符")
private String password;

2.3controller对实体校验

//保存修改对同一实体校验
@PostMapping("/save")
@ApiOperation(value = "保存配置")
public Result<Boolean> save(@Validated @RequestBody T entity){
    boolean flag = service.save(entity);
    return Result.OK(flag);
}

//修改时使用分组策略校验id是否为空，保存时不校验
@PostMapping("/modify")
@ApiOperation(value = "修改配置")
public Result<Boolean> modify(@Validated(UpdateGroup.class) @RequestBody T entity){
    boolean flag = service.updateById(entity);
    return Result.OK(flag);
}

//对单一参数进行校验 此时类上需加上注解@Validated
@GetMapping("/getById")
@ApiOperation(value = "通过id查询详细数据")
public Result<T> getById(@NotEmpty(message = "id不能为空") @RequestParam String id){
    T t = service.getById(id);
    return Result.OK(t);
}

2.4对校验不通过的异常统一处理

//处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常
@ExceptionHandler(BindException.class)
@ResponseBody
public Result BindExceptionHandler(BindException e) {
    String message = 			e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
    log.debug(message);
    return Result.error(Constant.SC_VALIDATE_ERROR_400, message);
}

//处理请求参数格式错误 @RequestParam上validate失败后抛出的异常是javax.validation.ConstraintViolationException
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public Result ConstraintViolationExceptionHandler(ConstraintViolationException e) {
    String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
    log.debug(message);
    return Result.error(Constant.SC_VALIDATE_ERROR_400, message);
}

//处理请求参数格式错误 @RequestBody上validate失败后抛出的异常是MethodArgumentNotValidException异常。
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public Result MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
    String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
    log.debug(message);
    return Result.error(Constant.SC_VALIDATE_ERROR_400, message);
}

2.5新增配置，校验时只要出现校验失败的情况，就立即结束校验，不再进行后续的校验。（选配）

@Bean
public Validator validator() {
    ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
        .configure()
        //failFast的意思只要出现校验失败的情况，就立即结束校验，不再进行后续的校验。
        .failFast(true)
        .buildValidatorFactory();
    return validatorFactory.getValidator();
}

@Bean
public MethodValidationPostProcessor methodValidationPostProcessor() {
    MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
    methodValidationPostProcessor.setValidator(validator());
    return methodValidationPostProcessor;
}

2.6其他常用注解说明

空检查

注解	描述
@Null	验证对象是否为null
@NotNull	验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank	检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格
@NotEmpty	检查约束元素是否为NULL或者是EMPTY

Booelan检查

注解	描述
@AssertTrue	验证 Boolean 对象是否为 true
@AssertFalse	验证 Boolean 对象是否为 false

长度检查

注解	描述
@Size(min=, max=)	验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=)	验证字符串的长度是否在给定的范围之内，包含两端

日期检查

注解	描述
@Past	验证 Date 和 Calendar 对象是否在当前时间之前
@Future	验证 Date 和 Calendar 对象是否在当前时间之后

数值检查

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null

注解	描述
@Min	验证 Number 和 String 对象是否大等于指定的值
@Max	验证 Number 和 String 对象是否小等于指定的值
@DecimalMax	被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin	被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits	验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=)	验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=)	检查带注释的值是否位于(包括)指定的最小值和最大值之间。
@Email	验证是否是邮件地址，如果为null,不进行验证，算通过验证