自定义@Validated参数注解-阿里云开发者社区

自定义@Validated参数注解

2022-08-29 316

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： Spring Validated参数校验

一、参数校验的实现

1. 以前参数的校验大都通过编码的方式实现，如 Hutool 实现

StrUtil.isNotEmpty(arg);
StrUtil.isNotNull(arg);
StrUtil.isNotBlank(arg);
……

2. 新成员 @Validated 和 @Valid

关于两者的区别

@Validated是org.springframework.validation.annotation.Validated，支持group分组

@Valid是javax.validation.Valid

实际使用时，可以使用两者的嵌套

更多的高阶使用姿势，可参考：https://segmentfault.com/a/1190000022605819?utm_source=tag-newest

二、自定义一个 @Validated 参数注解

1. 定义注解

packagecom.example.validated.validation;
importjavax.validation.Constraint;
importjavax.validation.Payload;
importjava.lang.annotation.*;
/*** 自定义身份证校验注解** @author miaoxm* @date 2021/12/24*/@Documented@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=IdentityCardNumberValidator.class)
public@interfaceIdentityCardNumber {
Stringmessage() default"身份证号码不合法";
Class<?>[] groups() default {};
Class<?extendsPayload>[] payload() default {};
}

2. 注解校验实现

packagecom.example.validated.validation;
importjavax.validation.ConstraintValidator;
importjavax.validation.ConstraintValidatorContext;
/*** 真正的校验逻辑** @description* 1.必须实现 ConstraintValidator 接口* 2.实现了 ConstraintValidator 接口后即使不进行 Bean 配置,spring 容器也会将这个类进行 Bean 管理* 3.可以在实现了 ConstraintValidator 接口的类中依赖注入其他的 Bean* 4.实现了 ConstraintValidator 接口后必须重写 initialize 和 isValid 这两个方法*   - 其中 initialize 方法主要来进行初始化,通常用来获取自定义注解的属性*   - 其中 isValid 方法主要进行校验逻辑,返回true表示校验通过;返回false表示校验失败* @author miaoxm* @date 2021/12/24*/publicclassIdentityCardNumberValidatorimplementsConstraintValidator<IdentityCardNumber, Object> {
@Overridepublicvoidinitialize(IdentityCardNumberconstraintAnnotation) {
ConstraintValidator.super.initialize(constraintAnnotation);
    }
@OverridepublicbooleanisValid(Objecto, ConstraintValidatorContextconstraintValidatorContext) {
returncheck(o.toString());
    }
privatebooleancheck(Stringarg) {
// 具体的参数校验实现可以写在这儿returntrue;
    }
}

三、全局异常处理

作用：让校验生效，即参数校验时如果不合法就会抛出异常，我们就可以在全局异常中捕获拦截到，然后进行逻辑处理之后再返回

@RestControllerAdvicepublicclassMyGlobalExceptionHandler {
……}

文章标签：

Java

Spring