SpringBoot中使用JR303校验

参考资料：

https://blog.csdn.net/weixin_37199234/article/details/107253433

https://www.csdn.net/tags/NtTaUg0sMTA0NjMtYmxvZwO0O0OO0O0O.html

---

---

普通校验

1. SpringBoot2.3.0以后版本没有引入javax.validation，需要手动引入

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

1. entity层类参数上标注校验注解，并自定义message信息

@NotBlank(message = "品牌名必须提交")
private String name;

1. controller层接收参数时，标注注解@Valid开启校验功能。

// BindingResult中封装了校验结果，必须紧跟@Valid
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand) {
    brandService.save(brand);
    return R.ok();
}

1. 统一异常处理（可选统一处理校验结果）

/**
 * 集中处理所有异常
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.liu.gulimall.product.controller")
public class ProductControllerAdvice {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("提交数据校验异常{}", e.getMessage());
        BindingResult result = e.getBindingResult();
        Map<String, String> errorMap = new HashMap<>();
        result.getFieldErrors().forEach((item) -> {
            String message = item.getDefaultMessage();
            String field = item.getField();
            errorMap.put(field, message);
        });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", errorMap);
    }

    @ExceptionHandler(value = Throwable.class)
    public R handleValidException(Throwable throwable) {
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(), BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }
}

分组校验

可以针对不同操作url传来的行为进行分组，比如update传来的需要进行非空校验，save传来的可以不进行非空校验

1. 新建分组接口（只写interface，不用写实现）

public interface AddGroup {
}
public interface UpdateGroup {
}

1. 普通校验注解上加groups属性

@NotBlank(message = "品牌名不能为空", groups = {AddGroup.class, UpdateGroup.class})
private String name;

1. 在controller上使用@Validated注解，绑定request和分组接口的关系。这样来的request，就会自动进行相应分组校验

@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) 

自定义校验

1. 编写自定义校验注解

@Documented
@Constraint(validatedBy = { })
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface ListValue {
	// 必备
    String message() default "{com.liu.common.valid.ListValue.message}";
	// 必备
    Class<?>[] groups() default {};
	// 必备
    Class<? extends Payload>[] payload() default {};
	// 写明白传入什么值
    int[] vals() default {};
}

1. 在resource中，创建ValidationMessages.properties，并添加错误信息

com.liu.common.valid.ListValue.message = 必须提交指定值

1. 编写自定义校验器

/**
 * 自定义校验器
 */
// 实现ConstraintValidator接口，第一个泛型为注释类，第二个泛型为注释标注在什么类型上面
public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

    private Set<Integer> set = new HashSet<>();
    /**
     * 初始化方法
     * @param constraintAnnotation 注解
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {
//        ConstraintValidator.super.initialize(constraintAnnotation);
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    /**
     * 判断是否校验成功
     * @param value 需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

1. 在Constraint中，关联自定义校验注解和校验器（可关联多个）

@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface ListValue {

校验结果收集

1. 通过BindingResult收集entity的message

// BindingResult中封装了校验结果，必须紧跟@Valid
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {
    brandService.save(brand);
    return R.ok();
}

1. 设置统一的ControllerAdvice处理异常

/**
 * 集中处理所有异常
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.liu.gulimall.product.controller")
public class ProductControllerAdvice {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("提交数据校验异常{}", e.getMessage());
        BindingResult result = e.getBindingResult();
        Map<String, String> errorMap = new HashMap<>();
        result.getFieldErrors().forEach((item) -> {
            String message = item.getDefaultMessage();
            String field = item.getField();
            errorMap.put(field, message);
        });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", errorMap);
    }

    @ExceptionHandler(value = Throwable.class)
    public R handleValidException(Throwable throwable) {
        log.error("错误内容", throwable);
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(), BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }
}

注意

1. @Valid和@Validated注解一定要加在controller接受的bean参数前面，不能加在方法上
2. 在分组校验中，如果有entity的参数注释没有添加groups分组属性，那分组校验此参数校验不生效。比如：

// entity属性
@NotNull(message = "修改必须指定品牌id", groups = {UpdateGroup.class})
@Null(message = "新增不能指定id", groups = {AddGroup.class})
@TableId
private Long brandId;

@NotNull(message = "显示状态不能为空")
private Integer showStatus;

// controller方法只会检验brandId，不会检验showStatus
@RequestMapping("/save")
@Validated({AddGroup.class})
public R save( @RequestBody BrandEntity brand) 

常见注解

注解	描述
@Valid	对po实体进行校验
@AssertFalse	所注解的元素必须是Boolean类型，且值为false
@AssertTrue	所注解的元素必须是Boolean类型，且值为true
@DecimalMax	所注解的元素必须是数字，且值小于等于给定的值
@DecimalMin	所注解的元素必须是数字，且值大于等于给定的值
@Digits	所注解的元素必须是数字，且值必须是指定的位数
@Future	所注解的元素必须是将来某个日期
@Max	所注解的元素必须是数字，且值小于等于给定的值
@Min	所注解的元素必须是数字，且值大于等于给定的值
@Range	所注解的元素需在指定范围区间内
@NotEmpty	集合不能为空，用在集合类上面
@NotNull	所注解的元素值不能为null，用在基本类型上
@NotBlank	所注解的元素值有内容，用在String上面
@Null	所注解的元素值为null
@Past	所注解的元素必须是某个过去的日期
@PastOrPresent	所注解的元素必须是过去某个或现在日期
@Pattern	所注解的元素必须满足给定的正则表达式
@Size	所注解的元素必须是String、集合或数组，且长度大小需保证在给定范围之内
@Email	所注解的元素需满足Email格式