【Java 基础】Java Validation API分组，顺序校验，以及自定以校验注解的优雅写法

前言：

我们后端需要对前端或者其它地方传过来的参数需要进行校验，其中JSR303定义了一些标准，接下来我们看看是如何实现分组校验和顺序校验的。

前置工作

如下是一个基础测试实体类，和一个测试controller

@Data
public class TestValiated {
    /**
     * 品牌id
     */
    private Long brandId;
    /**
     * 品牌名
     */
    private String name;

    /**
     * 检索首字母
     */
    private String firstLetter;
}


    @RequestMapping("/testValidated")
    public String testValidated(@Validated @RequestBody TestValiated brand){
        return "success";
    }

/**
 * 集中处理所有异常，拦截异常处理类
 */
@Slf4j
@RestControllerAdvice
public class GulimallExceptionControllerAdvice {
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e) {
        log.error("数据校验出现问题{}，异常类型：{}", e.getMessage(), e.getClass());
        BindingResult bindingResult = e.getBindingResult();

        Map<String, String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError) -> {
            errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
        });
        return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", errorMap);
    }
}

1、分组校验

业务场景，同一个实体为了满足不同的业务场景而出现，比如添加和修改对以下的字段限制不同。
添加的时候brandId不能填写，而修改的时候是必填项；firstLetter是添加和修改都是必填项，name随意，代码：

@Data
public class TestValiated extends BaseGroup {
    /**
     * 品牌id
     */
    @NotNull(message = "修改必须指定品牌id", groups = {UpdateGroup.class})
    @Null(message = "新增不能指定id", groups = {AddGroup.class})
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank
    private String name;

    /**
     * 检索首字母
     */
    @NotEmpty(groups = {AddGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
    private String firstLetter;
}


@Data
public class BaseGroup {
    public @interface AddGroup{};

    public @interface  UpdateGroup{};
}


    @RequestMapping("/testValidated")
public String testValidated(@Validated(BaseGroup.AddGroup.class) @RequestBody TestValiated brand){
    return "success";
}

上面的结果就是，brandId和firstLetter是必填项，name上的notBlank 是不起作用的，因此它只对自己标记的分组起作用。

2、自定义注解实现入参为指定内容

目前支持的注解有以下：

但是现在想要让输入的参数为指定内容，比如增加一个字段showStatus 只能为0和1，那么我们后端怎么通过注解解决这个问题呢，可以按照下面的方式自己定义一个注解。

@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    int[] vals() default { };
}

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set = new HashSet<>();
    //初始化方法
    @Override
    public void initialize(ListValue 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);
    }
}

对应实体字段：

	/**
	 * 显示状态[0-不显示；1-显示]
	 */
    @NotNull(groups = {AddGroup.class, UpdateStatusGroup.class} ,message = "显示状态不能为空")
    @ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class},message = "内容必须是0和1")
    private Integer showStatus;

3、如何按照顺序提示

基于showStatus,我们想让先提示显示状态不能为空，然后在提示内容必须是0和1，这个要怎么做呢。
定义一个类：

@GroupSequence({ValidationOrder.Step1.class, ValidationOrder.Step2.class, ValidationOrder.Step3.class, ValidationOrder.Step4.class, Default.class })
public interface ValidationOrder {
    interface Step1 {}
    interface Step2 {}
    interface Step3 {}
    interface Step4 {}
}

实体：测试showStatus字段

    /**
     * 显示状态[0-不显示；1-显示]
     */
//	@Pattern()
    @NotNull(groups = {AddGroup.class, UpdateStatusGroup.class,ValidationOrder.Step2.class}, message = "显示状态不能为空")
    @ListValue(vals = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class,ValidationOrder.Step1.class}, message = "内容必须是0和1")
    private Integer showStatus;

我们将内容必须是0和1排序为第一个，然后下面首先显示的是0和1