java 自定义注解校验

有时候JSR303的规范自带的注解不满足我们的数据校验需求，例如显示状态showStatus，只能接受0和1，这时我们可以自己写自定义注解校验规则；

在实体类加@ListValue注解，vals里面的值表示只能接收的值；

@ListValue(vals={0,1})
private Integer showStatus;

编写自定义ListValue自定义校验接口类；

import javax.validation.Constraint;
import javax.validation.Payload;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

	String message() default "{com.common.valid.ListValue.message}";

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

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

	int[] vals() default {};
}

创建validationMessages.properties 配置文件配置校验错误信息：

com.common.valid.ListValue.message=必须指定特定的值

ListValueConstraintValidator 数据校验器；

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * 自定义校验器
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
	
    //vals的值会保存在set容器
	private Set<Integer> set = new HashSet<>();

	/**
	 * 初始化方法
	 * @param   constraintAnnotation
	 * @return  void
	 */
	@Override
	public void initialize(ListValue constraintAnnotation) {
		int[] vals = constraintAnnotation.vals();
		for (int val:vals){
			set.add(val);
		}
	}

	/**
	 * 判断是否效验成功
	 * @param   value 需要效验的值
	 * @return  boolean
	 */
	@Override
	public boolean isValid(Integer value, ConstraintValidatorContext context) {
		boolean contains = set.contains(value);
		return contains;
	}
}