自定义注解，校验参数

原创已于 2023-01-30 15:41:37 修改 · 261 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2023-01-30 15:34:58 首次发布

本文介绍了一种自定义注解的实现方式，该注解用于校验字符串是否符合预设的限制值。通过示例展示了如何创建自定义注解及对应的验证器，并应用于字段或参数的校验中。

自定义注解:

package com.fangzhou.common.annotation;
import com.fangzhou.common.validation.StringContainsValidator;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = StringContainsValidator.class)
@Target({ ElementType.PARAMETER,ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface StringContains {

    String message() default "字符串不符合规则";

    String[] limitValues() default {};  //校验参数 是否是 A/B/C 字符串

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

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

    boolean nullable() default false;  //允许参数为null

}

在这里插入图片描述

验证器:

在这里插入图片描述

package com.fangzhou.common.validation;
import cn.hutool.core.util.StrUtil;
import com.fangzhou.common.annotation.StringContains;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

public class StringContainsValidator implements ConstraintValidator<StringContains, String> {
    private Set<String> limitValues;
    private boolean nullable;
    
    @Override
    public void initialize (StringContains constraintAnnotation) {
        limitValues = Arrays.stream(constraintAnnotation.limitValues()).collect(Collectors.toSet());
        nullable = constraintAnnotation.nullable();
    }
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (StrUtil.isBlank(value)) {
            if (nullable) {
                return true;
            }
            return false;
        }
        return limitValues.contains(value.trim());
    }
}