【实战】自定义注解的使用示例

当在一些业务实现代码中往往需要对传入实体或参数进行校验，为了使业务代码更加简洁清爽，有现成的JSR303,当有时这些不能满足我们的使用需求时，可以自定义注解.

/**
 * 自定义的校验注解
 */
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

    String message() default "提交的数据必须在数据列表中";

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

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

    int[] val() default {};
}

1、@Documented:
这个注解表示@ListValue注解会被包含在Javadoc文档中，方便开发者查阅和理解。
2、@Constraint(validatedBy = { ListValueConstraintValidator.class }):
这个注解表示@ListValue是一个约束注解，用于数据验证。validatedBy属性指定了一个验证器类ListValueConstraintValidator.class，该类将负责实现具体的验证逻辑。
3、@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }):
这个注解定义了@ListValue可以应用的位置。@Target的值是一个枚举数组，表示注解可以应用在方法、字段、构造函数参数等地方。
4、@Retention(RUNTIME):
这个注解表示@ListValue在运行时是可见的。这意味着可以通过反射获取到这个注解的信息。
5、public @interface ListValue:
这定义了一个名为ListValue的注解接口。
6、String message() default "提交的数据必须在数据列表中":
这个方法定义了验证失败时的默认错误消息。默认值为"提交的数据必须在数据列表中"，这是当验证失败时返回的错误消息文本。
7、Class<?>[] groups() default { }:
这个方法定义了验证组，用于分组验证。默认情况下不指定任何组。
8、Class<? extends Payload>[] payload() default { }:
这个方法定义了注解的元数据，通常用于传递附加信息。默认情况下不指定任何元数据。
9、int[] val() default {}:
这个方法定义了@ListValue注解的自定义属性val，用于指定需要验证的值列表。默认情况下，这个数组为空。

/**
 * 对应的校验注解的校验器
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
    private HashSet<Integer> set = new HashSet<>();

    /**
     * 初始化的方法
     * 举例：@ListValue(val={1,0})
     * 获取到 1 0
     * @param constraintAnnotation
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] val = constraintAnnotation.val();// 0 1
        for (int i : val) {
            set.add(i);
        }
    }

    /**
     * 判断校验是否成功的方法
     * @param value 客户端传递的对应的属性的值 判断value是否在0 ， 1 中
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

使用

/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@ListValue(val={0,1})
	private Integer showStatus;

当传入的状态值不在这以上就是，就会提示提交的数据必须在数据列表中