自定義Hibernate Validator約束

定義注解

實現一個只能輸入指定狀態的約束條件

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.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = StatusValidator.class)
@Documented
public @interface ValidStatus {
    String message() default "狀態錯誤 ";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    /**
     * 有效的狀態值集合，默認{1,2}
     */
    int[] value() default {1,2};
}

 

定義校驗類

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

/**
 * 校驗狀態是否屬於指定狀態集
 (ConstraintValidator后指定的泛型對象類型為
 注解類和注解注釋的字段類型<ValidStatus, Integer>)
 */
public class StatusValidator implements ConstraintValidator<ValidStatus, Integer> {
    private Integer[] validStatus;

    @Override
    public void initialize(ValidStatus validStatus) {
        int[] ints = validStatus.value();
        int n = ints.length;
        Integer[] integers = new Integer[n];
        for (int i = 0; i < n; i++) {
            integers[i] = ints[i];
        }
        this.validStatus = integers;
    }

    @Override
    public boolean isValid(Integer n, ConstraintValidatorContext constraintValidatorContext) {
        List<Integer> status = Arrays.asList(validStatus);
        if (status.contains(n)) {
            return true;
        }
        return false;
    }
}

 

程序中使用

public class QueryDTO {
@ValidStatus
@NotNull
private Integer type;
//...省略n行代碼
}
@RestController
@RequestMapping(value = "xxx")
public class DemoController {
//...省略n行代碼
@PostMapping(value = "/testUrl")
    public Response<ResultVO> getXXXList(@RequestBody @Valid QueryDTO dto){
    //...省略n行代碼
    }
    
}

也可以這樣用：

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        validator = factory.getValidator();
        Set<ConstraintViolation<QueryDTO>> constraintViolations =
            validator.validate(queryDTO);