SpringValidation自定義注解及分組校驗功能詳解

更新時間：2024年01月06日 10:02:07 作者：六花i

這篇文章主要介紹了SpringValidation自定義注解及分組校驗功能,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧

1. 引入依賴

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
   <version>3.2.0</version>
</dependency>

2. 自定義注解校驗

使用場景：已有的注解不能滿足所有的校驗需求，特殊的情況需要自定義校驗(自定義校驗注解)。實現(xiàn)自定義注解可以通過模仿，SpringValidation提供的其他注解進行改寫。

舉例說明：

我有一個實體類，其中一個參數(shù)state需要接收到前端數(shù)據(jù)后進行校驗（要求該參數(shù)只能是已發(fā)布或者草稿）。而SpringValidation提供的注解無法滿足我的需求，此時便需要自定義注解。

2.1 創(chuàng)建Validation類

注意：該類需要實現(xiàn) ConstraintValidator接口，并實現(xiàn) isValid( )方法。方法內(nèi)即是校驗規(guī)則，我這里只是提供參考。請自行根據(jù)業(yè)務需求更改。

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
/**
 * ConstraintValidator<State, String>前一個代表需要校驗的注解，后一個代表校驗類型
 */
public class Validation implements ConstraintValidator<State, String> {
    /**
     *
     * @param value 將來要校驗的數(shù)據(jù)
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        //校驗規(guī)則
        if (value == null) {
            return false;
        }
        if (value.equals("已發(fā)布") || value.equals("草稿")) {
            return true;
        }
        return false;
    }
}

2.2 創(chuàng)建注解對象

注解名稱，請根據(jù)自己業(yè)務需求更改。

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;
@Documented //元注解，代表可在文檔顯示
@Constraint(
        validatedBy = {Validation.class} //指定提供校驗規(guī)則的類,該類需要自己指定
)
//元注解，代表注解適用的對象（方法、字段、注解、類、屬性）
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME) //元注解，代表注解的作用范圍
public @interface State {
    //報錯提示
    String message() default "state參數(shù)只能是已發(fā)布或者草稿";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}