实现ConstraintValidator完成自定义校验注解

最新推荐文章于 2025-03-09 16:31:30 发布

唯有代码不会骗人

最新推荐文章于 2025-03-09 16:31:30 发布

阅读量2.9k

点赞数 1

分类专栏： Spring Boot 文章标签： spring

本文链接：https://blog.youkuaiyun.com/weixin_44248000/article/details/124062584

版权

Spring Boot 专栏收录该内容

12 篇文章

订阅专栏

本文介绍了如何在Spring Boot中创建一个自定义注解`OnlyNumber`，用于验证字符串是否只包含数字并且长度在指定范围内。注解包含`min`和`max`属性以设定限制，并在`OnlyNumberClass`中实现`ConstraintValidator`进行逻辑校验。在实际使用中，需将注解应用于字段并配合`@Valid`注解在Controller层进行参数校验。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、导包

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

二、自定义注解类

此处我用一个非常简单的例子来说明，主要是看结构。
OnlyNumber ：

/**
 * @Description: 只能包含数字，同时可以控制数字位数
 * @Author: Felix.Du
 * @Date: 2022/3/8 7:01 下午
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.PARAMETER})
@Constraint(validatedBy = OnlyNumberClass.class)
public @interface OnlyNumber {

    int min() default 1;

    int max() default 99;

    String message() default "VERIFICATION_CODE_ERROR";

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

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

注解中的变量可以自己控制，我这里定义了min（最小位数），max（最大位数）两个。其中message为不满足要求提示的错误信息。
接下来我们来看OnlyNumberClass类：

/**
 * @Description: 只能为数字类型的String,且字符长度介于[min,max]之间
 * @Author: Felix.Du
 * @Date: 2022/3/9 10:55
 */
public class OnlyNumberClass implements ConstraintValidator<OnlyNumber, Object> {

    private int min;
    private int max;

    private static final String REGEX = "^[-\\+]?[\\d]*$";

    @Override
    public void initialize(OnlyNumber onlyNumber) {
        this.min = onlyNumber.min();
        this.max = onlyNumber.max();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        if (value == null) {
            return true;
        }
        //判断是否为纯数字
        Pattern pattern = Pattern.compile(REGEX);
        boolean isNumber = pattern.matcher(value.toString()).matches();

        //判断位数是否合法
        int length = value.toString().trim().length();
        boolean isUp =  min <= length;
        boolean isDown = max >= length;

        return isUp && isDown && isNumber;
    }
}

实现ConstraintValidator类主要是重写两个方法。
1.initialize()，会在校验实例化后被调用，一般用于做些初始化工作。
2.isValid()，实际执行验证的方法，第一个参数获取的是字段或对象实际对应的值，取决于类的枚举限定类型。第二个参数是ConstraintValidatorContext，上下文可以做些默认的设置。
我们主要是在isValid()方法中写自己的逻辑。其中返回true为校验通过，返回false为校验失败，给出错误信息message。

三、实际使用

通常我们的字段是放在对象里的，这个时候我们如果只在字段上打上这个注解通常是不会生效的。如：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class BindEmailOrPhoneParam {

    /**
     * 验证码
     */
    @ApiModelProperty(value = "验证码", required = true)
    @NotNull(message = "NOT_NULL")
    @OnlyNumber(min = 5, max = 5)
    private String code;

}

我们还需要在Controller层具体方法的参数前加上@Valid 注解，这个时候它才会认为我们需要校验这个对象里面的参数，如：

/**
 * 绑定手机、邮箱
 *
 * @param userId    用户id
 * @param param     绑定邮箱、手机请求参数
 * @return          0->失败, 1->成功
 */
@ApiOperation(value = "绑定手机、邮箱", notes = "绑定手机、邮箱", httpMethod = "POST")
@PostMapping(value = "/bind/account/{userId}", produces = MediaType.APPLICATION_JSON_VALUE)
public RestResult<Integer> appBindEmailOrPhone(@PathVariable("userId") Long userId,
                                        @RequestBody @Valid BindEmailOrPhoneParam param) {
    return RestResult.ok(RpcClientUtil.sync(() ->
                            tmdUserManageClient.bindEmailOrPhone(userId, BeanUtil.toBean(param, BindEmailOrPhoneDTO.class))
            )
    );
}