ConstraintValidator類如何實現自定義註解校驗前端傳參

Posted on by

前言

今天項目碰到這麼一個問題，前端傳遞的json格式到我的微服務後端轉換為vo類，其中有一個Integer的字段後端希望它在固定的幾個數裡面取值，例如隻能取值1、2、4。

一般咱們的思路是啥呢，找一些spring為我們提供的類似@Length、@NotBlank這些註解加在參數上面。

像下面這樣

在這裡插入圖片描述

不過我這個校驗一時間想不起來用哪個註解瞭，咋整呢？行吧，咱不求人，自己實現一個。

補充一句話，千萬別直接拿著實體類往後傳遞到service層校驗哈，太low瞭這樣子。

一、利用@Constraint定義註解

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
        validatedBy = {IllegalNumberValidator.class}
)
public @interface IllegalNumber {
    /**
     * 允許前端取的幾個值
     * 
     */
    int[] acceptValues();
    /**
     * 標識此字段是否為必選項
     * 
     */
    boolean required() default true;
 
    /**
     * 標識此字段是否為必選項
     * 
     */
    String message() default "數字不合法,不在要求的取值范圍之內";
 
    /**
     * 標識要校驗的值所屬組，這個後面詳細解釋
     * 
     */
    Class<?>[] groups() default {};
    
    /**
     * 這個字段一般不需要我們關註
     * 
     */
    Class<? extends Payload>[] payload() default {};
}

二、增強註解

1.編寫增強類

註意到剛才註解中的@Constraint註解瞭嗎

在這裡插入圖片描述

validatedBy屬性標識這個註解要被哪個類所增強，我們把增強類IllegalNumberValidator定義出來

import com.google.common.collect.Lists;
import org.springframework.util.StringUtils;
import java.util.List;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class IllegalNumberValidator implements ConstraintValidator<IllegalNumber, Integer> {
    private final List<Integer> valueList = Lists.newArrayList();
    private boolean require = false;
    @Override
    public void initialize(IllegalNumber constraintAnnotation) {
        require = constraintAnnotation.required();
        int[] ints = constraintAnnotation.acceptValues();
        for (int anInt : ints) {
            valueList.add(anInt);
        }
    }
    @Override
    public boolean isValid(Integer number, ConstraintValidatorContext constraintValidatorContext) {
        // 如果是必選的話,假設為我們傳遞的參數為空那肯定不行
        if (require) {
            if (number == null) {
                return false;
            }
            return valueList.contains(number);
        } else {
            // 如果不為必選參數，為空返回true，不為空還是得校驗
            if (StringUtils.isEmpty(number)) {
                return true;
            } else {
                return valueList.contains(number);
            }
        }
    }
}

增強類繼承ConstraintValidator類，實現的initialize()方法是初始化方法，啥意思呢，啥目的呢？在你真正執行校驗之前，可以做一些準備性工作，發生在要校驗的值上面的註解的IllegalNumber 已經給咱們傳進來瞭。我做的初始化工作就是load一下Integer類型的可選值，方便一會執行真正的校驗。

然後在isValid()方法中你可以做真正的校驗瞭，很簡單，我看下傳遞的Integer類型的值是不是acceptValues裡面的可選值就行瞭。

定義一個前端傳遞的類，方便調試註解

import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.NotNull;
@Data
public class TestVO {
    @NotNull
    @IllegalNumber(acceptValues = {0, 1,2},required = true,message = "請正確取值")
    private Integer number;
    @NotNull
    @Length(min = 1)
    private String password;
}

定義接口，用來接收前端傳遞的json數據並parse為TestVO類

    /**
     * 測試自定義註解
     *
     * @param vo json將會映射的實體
     * @return 默認信息
     */
    @PostMapping(value = "/v1.0/test2", name = "測試自定義註解")
    public String test2(@Valid @RequestBody TestVO vo) {
        log.info("get vo success , detail message is:{}", vo);
        return RETURN_MESSAGE;
    }

註意，如果說前端傳遞數據不符合註解的校驗，其實是會拋出異常的來自@Constraint註解實現的註解都有此特點，例如@Length、@Max等。咱們需要在異常拋出的時候給出攔截 這裡咱們做一個通用攔截：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import java.util.Objects;
import javax.validation.ConstraintViolationException;
@ControllerAdvice
public class RestResponseEntityExceptionHandler {
    private static final Logger LOG = LoggerFactory.getLogger(RestResponseEntityExceptionHandler.class);
    @Autowired
    private ApplicationContext applicationContext;
    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public String handleConstraintViolationException(ConstraintViolationException e) {
        LOG.info("ConstraintViolationException intercept success:{}", e.getMessage());
        return e.getMessage();
    }
    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public String handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        LOG.info("MethodArgumentNotValidException intercept success:{}", e.getMessage());
        return Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage();
    }
}

2.測試效果

下面測試一下。打開postman。直接幹！取值的限定是0、1、2。咱們先試下錯誤的

在這裡插入圖片描述

ok,再試下正確的

在這裡插入圖片描述

3.註解中的groups參數詳解

groups參數，代表所屬組的意思。演示下怎麼用，大傢也就知道這個參數啥意思瞭。 建立Group1接口

public interface Group1 {
}

建立Group2接口

public interface Group2 {
}

給TestVO增加一個參數，方便一會進行比較

@Data
public class TestVO {
    @NotNull
    @IllegalNumber(acceptValues = {0, 1,2},required = true,message = "請正確取值",groups = Group1.class)
    private Integer number;
    @NotNull
    @IllegalNumber(acceptValues = {0, 1,2},required = true,message = "請正確取值ha",groups = Group2.class)
    private Integer number2;
    @NotNull
    @Length(min = 1)
    private String password; 
}

使用註解的時候標明所屬組：

在這裡插入圖片描述

接口處也進行標識：

在這裡插入圖片描述

現在咱們分別測試下兩個接口，看groups參數是否能生效

test2接口

在這裡插入圖片描述

test3接口

在這裡插入圖片描述

ok，相信大傢對此參數已經掌握瞭，這裡不再多餘贅述。

總結

本篇介紹瞭自定義註解的另外一種手法，其實還有許許多多的手法，例如利用反射實現、利用攔截器實現等等。遇見的時候咱們再介紹。 以上僅為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet

推薦閱讀：