springboot 自定义注解校验

最新推荐文章于 2025-05-02 09:36:52 发布

原创最新推荐文章于 2025-05-02 09:36:52 发布 · 450 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

文章介绍了如何在Java中创建自定义注解以进行字段和类级别的验证。首先，定义了一个用于检查输入值是否在指定列表中的注解接口类和对应的验证器。然后，创建了一个类级注解及其验证器，以确保特定字段满足特定条件。最后，展示了如何在控制器中使用@Valid注解触发验证，并处理验证异常。

1.普通字段自定义注解校验例如：校验传入值是否在指定的多个值中

1.1.创建注解接口类：

@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.FIELD})
@Documented
@Constraint(validatedBy = InValuesValidator.class)
public @interface InValuesAnnotation {

    String values();

    String message() default "不在指定的值中";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

}

1.2.创建具体的校验类

public class InValuesValidator implements ConstraintValidator<InValuesAnnotation, Object> {

    private InValuesAnnotation constraintAnnotation;

    @Override
    public void initialize(InValuesAnnotation constraintAnnotation) {
        this.constraintAnnotation = constraintAnnotation;
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        // 如果没有传入不进行校验
        if (Func.isNull(value)) return Boolean.TRUE;

        List<String> values = Arrays.asList(this.constraintAnnotation.values().split(","));

        boolean result = values.contains(Func.toStr(value));

        // 如果校验失败就自定义返回消息
        if (!result) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("不在指定的值" + this.constraintAnnotation.values() + "中").addConstraintViolation();
        }

        return result;
    }

}

1.3.在bean中使用

// 状态，0-禁用，1-启用
@InValuesAnnotation(values = "0,1")
private Integer status;

2.对类自定义注解校验

2.1.注解接口类：

@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.TYPE})
@Documented
@Constraint(validatedBy = DIYFildValidator.class)
public @interface DIYAnnotation {
    String message() default "!!!!!!No";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2.2.具体校验类：

public class DIYFildValidator implements ConstraintValidator<DIYAnnotation, TestValid> {
    @Override
    public void initialize(DIYAnnotation constraintAnnotation) {
    }
    @Override
    public boolean isValid(TestValid testValid, ConstraintValidatorContext context) {
        if(testValid.getInt1() == 0 && nonNull(testValid.getInt2())) {
            return diyErrMsg(context, "int1为0时,int2必须为null");
        }
        if (testValid.getInt1() == 1 && isNull(testValid.getInt2())) {
            return false;
        }
        return true;
    }
    // 自定义message
    private boolean diyErrMsg(ConstraintValidatorContext context, String message) {
        context.disableDefaultConstraintViolation();
        context.buildConstraintViolationWithTemplate(message).addConstraintViolation();
        return false;
    }
}

2.3.将自定义注解加在需要校验的类上：

@Data
@DIYAnnotation
public class TestValid {
    // 当int1为0时,int2必须为null；当int1为1时,int2必须不为null；
    private Integer int1;
    private Integer int2;
}

以上就完成了自定义的类校验，别忘了在controller方法上加上@Valid

public int test(@RequestBody @Valid TestValid testValid)

捕获MethodArgumentNotValidException异常，获取错误信息，封装返回

@ExceptionHandler(value = {MethodArgumentNotValidException.class})
    public @ResponseBody
    ResponseObject handleValidException(MethodArgumentNotValidException ex, NativeWebRequest request) {
        BindingResult result = ex.getBindingResult();
        List<FieldError> fieldErrorList = result.getFieldErrors();
        List<String> filedErrorInfo = new ArrayList<String>();
        String message = null;
        HttpServletRequest requestHttp = request.getNativeRequest(HttpServletRequest.class);
        for (FieldError filedError : fieldErrorList) {
            filedErrorInfo.add(filedError.getField());
            message = filedError.getDefaultMessage();
            log.error("/data/controller 参数校验失败 路径:{},错误信息:{}", requestHttp.getServletPath(), message);
            break;
        }
        return ResponseObject.getResponseObject(BaseCodeType.PARAM_FAIL, message);
    }