API接口參數驗證的必備神器，讓你的代碼更高效！-魔扣目錄

環境：Springboot2.6.12

1. 簡介

Spring Validation是一種輕量級的數據驗證框架，主要用于對JAVA對象進行校驗。它為數據驗證提供了統一的接口和基本的校驗功能，解決了數據校驗這一常見問題，讓開發人員能夠方便地對數據進行驗證，從而保證數據的有效性和安全性。

Spring Validation提供了一套注解，用于對Java對象進行校驗，支持嵌套校驗和分組校驗，支持國際化和自定義注解和校驗器，可以滿足各種復雜的校驗需求。它的主要特點包括：

輕量級：Spring Validation只做驗證相關的事情，不包含復雜的業務邏輯。
簡單易用：基于注解，簡潔明了，易于維護。
校驗規則靈活：支持自定義校驗規則，可擴展性強。
支持國際化：根據不同的語言環境，使用不同的校驗提示消息。
集成Hibernate Validator：Spring Validation默認使用Hibernate Validator作為其具體的實現，可以輕松地與其他數據驗證框架一起工作。

Bean Validation 為Java應用程序提供了一種通過約束聲明和元數據進行驗證的通用方法。要使用它，只需要對POJO屬性進行注釋，然后由運行時強制執行這些約束。有內置的約束，你也可以定義自己的自定義約束。如下所示：

public class Person {


  @NotNull
  @Size(max=64)
  private String name;
  @Min(0)
  private int age;


}

Bean驗證驗證器然后根據聲明的約束驗證此類的實例。有關API的一般信息，請參見Bean驗證。有關特定約束，請參閱Hibernate驗證程序文檔。

配置Bean驗證提供程序

Spring提供了對Bean驗證API的全面支持，包括將Bean驗證提供者作為Spring Bean。這使你可以在應用程序中需要驗證的任何位置注入javax.validation.ValidatorFactory或javax.validation.Validator。

你可以使用LocalValidatorFactoryBean將默認驗證器配置為Spring Bean，如下例所示：

import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;


@Configuration
public class AppConfig {


  @Bean
  public LocalValidatorFactoryBean validator() {
    return new LocalValidatorFactoryBean();
  }


}

上面的示例中的基本配置使用默認引導機制觸發bean驗證進行初始化。Bean驗證提供程序（如Hibernate驗證程序）應該出現在類路徑中，并被自動檢測到。

2. 注入 Validator

@Service
public class PersonService {
  // inject javaee validator object
  @Resource
  private Validator validator ;
  // inject spring validator object
  @Resource
  private org.springframework.validation.Validator valid ;
}

簡單實例

接著上面的配置，我們只需要做驗證動作即可。

@Service
public class PersonService {


  @Resource
  private Validator validator ;
  @Resource
  private org.springframework.validation.Validator valid ;




  public void validator(Person person) {
    Set<ConstrAIntViolation<Person>> res = validator.validate(person) ;
    res.forEach(cv -> {
      System.out.println(cv.getMessage()) ;
    });
    System.out.println("----------------------") ;
    BindingResult errors = new MapBindingResult(new HashMap<String, Object>(), "person") ;
    valid.validate(person, errors) ;
    if (errors.hasErrors()) {
      errors.getAllErrors().forEach(oe -> {
        System.out.println(oe.getDefaultMessage()) ;
      });
    }
  }


}

測試

@SpringBootTest
class SpringBootValidationApplicationTests {


  @Resource
  private PersonService ps ;


  @Test
  public void testValidator() {
    Person person = new Person() ;
    person.setAge(-1);
    ps.validator(person) ;
  }


}

最小不能小于0
不能為null
----------------------
最小不能小于0
不能為null

3. 自定義注解驗證

每個Bean驗證約束由兩部分組成：

聲明約束及其可配置屬性的@Constraint注釋。
實現約束行為的javax.validation.ConstraintValidator接口的實現。

要將聲明與實現關聯，每個@Constraint注釋都會引用相應的ConstraintValidator實現類。在運行時，當域模型中遇到約束注釋時，ConstraintValidatorFactory將實例化引用的實現。下面的示例實現一個前綴匹配的驗證邏輯：

自定義注解

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PrefixConstraintValidator.class)
public @interface PrefixConstraint {


  String value() default "" ;
  // 這里的{validator.prefix.error}就是資源文件中定義的錯誤信息
  String message() default "{validator.prefix.error}";


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


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


}

以上的注解屬性都是必須的。

注意message屬性是我們將發生錯誤后錯誤信息定義在配置文件中，而該文件的basename必須是ValidationMessages，如果你需要國際化支持，那么就這樣命名：ValidationMessages_zh_CN.properties。

自定義驗證器

public class PrefixConstraintValidator implements ConstraintValidator<PrefixConstraint, CharSequence> {


  @Resource
  private DataService ds ;


  private String prefix ;


  @Override
  public boolean isValid(CharSequence value, ConstraintValidatorContext context) {
    ds.ak() ;
    if ( value == null ) {
      return false ;
    }
    return ((String) value).startsWith(prefix) ;
  }


  @Override
  public void initialize(PrefixConstraint pc) {
    prefix = pc.value() ;
  }

}

驗證器必須實現ConstraintValidator接口，該接口是泛型接口，第一個參數是該驗證器要用于在那個注解，第二個參數是該注解應用在什么數據類型上。注意：在自定義驗證器中我們是可以隨意地注入其它Bean對象，是不是很強大？

基于方法級的驗證

你可以通過MethodValidationPostProcessor Bean定義將Bean validation 1.1（以及Hibernate Validator 4.3的自定義擴展）支持的方法驗證功能集成到Spring上下文中：

@Bean
public MethodValidationPostProcessor validationPostProcessor() {
  return new MethodValidationPostProcessor();
}
@Service
@Validated
public class PersonService {


  @NotNull(message = "返回值不能為空")
  public Person findPerson(@NotEmpty(message = "ID 不能為空") String id) {
    return null ;
  }

}

注意：類上必須有@Validated注解；因為上面的BeanPostProcessor中定義的Advisor（DefaultPointcutAdvisor）使用的切入的Pointcut在類級別上過濾條件是必須有@Validated注解，而方法則是攔截所有的方法。