自定义注解验证使用

前言

今天新接触到自定义注解验证功能，记录一下这个功能，便于以后使用

---

一、自定义注解验证是什么？

validation本身自带了一些校验注解

@Null   //被注释的元素必须为null
@NotNull  //被注释的元素必须不为null
@AssertTrue  //被注释的元素必须为true
@AssertFalse  //被注释的元素必须为false
@Min(value)   //被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)   //被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)   //被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)   //被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min)   //被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction)   //被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past       //被注释的元素必须是一个过去的日期
@Future     //被注释的元素必须是一个将来的日期
@Pattern(value)   //被注释的元素必须符合指定的正则表达式
@Email     //被注释的元素必须是电子邮箱地址
@Length(min=, max=)  //被注释的字符串的大小必须在指定的范围内
@NotEmpty            //被注释的字符串的必须非空
@Range(min=, max=)   //被注释的元素必须在合适的范围内
@NotBlank       //字符串不能为null,字符串trin()后也不能等于“”
@URL(protocol=,host=, port=, regexp=, flags=) //被注释的字符串必须是一个有效的url

但是有可能参数校验并不能满足当前校验需求，比如一个参数在代码中是枚举值，枚举值1，2，9，10，99，判断 参数是不是在枚举值中，就需要自定义注解验证

二、使用步骤

1.定义注解

代码如下（示例）：

// 在属性上添加自定义校验注解
@IdCheck
private String packageId;

// 注解作用目标，注解、属性
@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD})
 // 注解会在class字节码文件中存在，在运行时可以通过反射获取到
@Retention(RetentionPolicy.RUNTIME)
// 指定来处理验证的类PackageIdValidator
@Constraint(validatedBy = PackageIdValidator.class)
@Documented
public @interface IdCheck {
    String message() default ""; //这边可以标注默认的验证失败消息
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
}

// 建立校验类，实现ConstraintValidator接口，参数1：自定义注解，参数2：作用属性类型
public class PackageIdValidator implements ConstraintValidator<IdCheck, String> {
    // 初始化方法
    @Override
    public void initialize(IdCheck constraintAnnotation) {
		System.out.println("初始化");
    }

	// 校验方法
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
    	// value是请求值，根据value校验
        System.out.println(value);
        return false;
    }
}

三、代码中校验参数

当上传csv等数据文件时，需要进行字段校验

Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<Object>> violationSet = validator.validate(packageCommand);
if (CollectionUtils.isNotEmpty(violationSet)) {
     return false;
}
       

总结

自定义注解还有很多使用方法，这里只是简单记录一下