自定义注解-校验参数

自定义注解-校验参数

Step1:声明注解

自定义注解的作用，直接在实体类上的字段或者传参的参数上使用，就可以对字段进行自定义校验

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @Author: Javee
 * @Date: 2021/6/9 10:10
 * @Description: 对字段进行校验
 */
@Documented
@Target({ElementType.FIELD, ElementType.PARAMETER}) // 在参数和字段上都可以用
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = VerifyValidator.class) // 指定实现类
public @interface Verify {

    /**
     * 数据的长度
     */
    int length() default -1;

    /**
     * 数据的最小长度
     */
    int min() default -1;

    /**
     * 数据的最大长度
     */
    int max() default -1;

    /**
     * 校验不通过时的报错信息
     */
    String message() default "参数校验失败";

    /**
     * 将validator进行分类，不同的类group中会执行不同的validator操作
     */
    Class<?>[] groups() default {};

    /**
     * 主要是针对bean，很少使用
     */
    Class<? extends Payload>[] payload() default {};
}

Srep2:实现注解功能

import com.glodon.gcms.utils.GcmsListUtils;
import com.glodon.gcms.utils.GcmsStringUtil;
import com.glodon.gcms.utils.regex.GcmsRegexConstant;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;

/**
 * @Author: Javee
 * @Date: 2021/6/9 10:16
 * @Description: 对字段进行校验
 */
@Component
@Slf4j
public class VerifyValidator implements ConstraintValidator<Verify, Object> {

    private Integer length;
    private Integer min;
    private Integer max;

    @Override
    public void initialize(Verify validator) {
        this.length = validator.length();
        this.min = validator.min();
        this.max = validator.max();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {

        // 通过长度校验
        return isValid = isValid && lengthValid((String) value, length, min, max, constraintValidatorContext);

    }

    private boolean lengthValid(String value, int length, int min, int max, ConstraintValidatorContext constraintValidatorContext){
        if(length >= 0) {
            if (value.length() != length) {
                constraintValidatorContext.buildConstraintViolationWithTemplate("输入的内容长度必须为" + length).addConstraintViolation();
                log.error("输入的内容长度必须为" + length);
                return false;
            }
        }

        if(min >= 0) {
            if (value.length() < min) {
                constraintValidatorContext.buildConstraintViolationWithTemplate("输入的内容最小长度为" + min).addConstraintViolation();
                log.error("输入的内容最小长度为" + min);
                return false;
            }
        }

        if(max >= 0) {
            if (value.length() > max) {
                constraintValidatorContext.buildConstraintViolationWithTemplate("输入的内容最大长度为" + max).addConstraintViolation();
                log.error("输入的内容最大长度为" + max);
                return false;
            }
        }
        return true;
    }

}

到这里，自定义注解就完成了~

End:测试一下

编写controller

@GetMapping("/o/valid-test")
@ResponseBody
public String validTest(@Validated VerifyTestBo bo){
    return bo.getName();
}

编写实体类

@Data
public class VerifyTestBo {
    @Verify(min = 2, max = 10)
    private String name;
}

postman发送请求：

成功则返回姓名

失败则返回500，给出错误信息