項(xiàng)目啟動(dòng)時(shí)怎樣校驗(yàn)SpringBoot配置參數(shù)

1. 概述

在項(xiàng)目實(shí)際開發(fā)過程中，為了更好的復(fù)用，我們參考Spring Boot Starters，封裝了許多企業(yè)內(nèi)部中間件的starter。這些中間件的接入都需要申請(qǐng)并在項(xiàng)目中配置一些特定的參數(shù)。我們通過@ConfigurationProperties注解，增加了在配置過程的體驗(yàn)，實(shí)現(xiàn)屬性提示。一些參數(shù)是在中間件使用過程中的必選參數(shù)，經(jīng)常發(fā)現(xiàn)項(xiàng)目啟動(dòng)了，調(diào)用中間件時(shí)拋出異常，提示某個(gè)參數(shù)沒有配置。

這樣的接入過程體驗(yàn)很不好。

有沒有一種方式在項(xiàng)目啟動(dòng)的時(shí)候就對(duì)配置的參數(shù)直接進(jìn)行校驗(yàn)，而不是等到實(shí)際使用的時(shí)候再拋出錯(cuò)誤提示呢？

很幸運(yùn)，Spring已經(jīng)為我們提供的Java Validation可以解決我們的問題。

2. 增加啟動(dòng)校驗(yàn)

在我們創(chuàng)建的Properties類中增加Validation相關(guān)配置：

/**
* ConfigProperties.
*
* @author Wang Jianchao(tinyking)
* <p>
* Created on 2020/8/20
*/
@Validated
@Data
@ConfigurationProperties(prefix = "config")
public class ConfigProperties {
   @NotEmpty
   private String name;
}

@Validated是Spring提供的校驗(yàn)注解，通過該注解告訴Spring這個(gè)類是需要進(jìn)行校驗(yàn)處理的。

@NotEmpty 是Java Validation API中提供的校驗(yàn)注解，表示name字段不能為空。不能為空是指不能是null，也不能是空字符串。

配置Bean

@Configuration
@EnableConfigurationProperties(ConfigProperties.class)
public class ValidationConfiguration {

   @Bean
   public ConfigProperties configProperties() {
       return new ConfigProperties();
   }
}

上面的配置就會(huì)校驗(yàn)我們?cè)?code>application.yml中有沒有配置config.name參數(shù)。如果在配置文件中沒有該配置，項(xiàng)目啟動(dòng)就會(huì)失敗，并拋出校驗(yàn)異常：

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'config' to io.github.tinyking.springvalidation.config.ConfigProperties failed:

   Property: config.name
   Value: null
   Reason: 不能為空

在application.yml中，我們?cè)黾?code>config.name等配置項(xiàng)，但是不給它設(shè)置內(nèi)容：

config:
name:

再次啟動(dòng)項(xiàng)目，發(fā)現(xiàn)錯(cuò)誤信息發(fā)生了變化：

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'config' to io.github.tinyking.springvalidation.config.ConfigProperties failed:

   Property: config.name
   Value:
   Origin: class path resource [application.yml]:2:8
   Reason: 不能為空


Action:

Update your application's configuration

3. 自定義校驗(yàn)

Spring還支持我們進(jìn)行自定義校驗(yàn)規(guī)則，通過自定義校驗(yàn)可以實(shí)現(xiàn)復(fù)雜的校驗(yàn)邏輯。

我們創(chuàng)建一個(gè)校驗(yàn)類，并實(shí)現(xiàn)Validator接口：

/**
* ConfigPropertiesValidator.
*
* @author Wang Jianchao(tinyking)
* <p>
* Created on 2020/8/20
*/
public class ConfigPropertiesValidator implements Validator {
   @Override
   public boolean supports(Class<?> aClass) {
       return ConfigProperties.class.isAssignableFrom(aClass);
   }

   @Override
   public void validate(Object target, Errors errors) {
       ConfigProperties config = (ConfigProperties) target;

       if (!StringUtils.isEmpty(config.getName()) && config.getName().length() < 5) {
           errors.rejectValue("name", "name.too.shot", "name is too shot");
       }
   }
}

需要注意的是，上面的Validator接口是Spring框架提供的，不是Java Validation API中的接口。

• supports(Class<?> aClass)方法用來判斷是否支持當(dāng)前正在進(jìn)行校驗(yàn)的實(shí)例
• validate(Object target, Errors errors)方法中寫實(shí)際的校驗(yàn)規(guī)則，并用     errors收集錯(cuò)誤信息

接下來就是如何在Spring Boot啟動(dòng)時(shí)，對(duì)Properties進(jìn)行校驗(yàn)了。這一步非常關(guān)鍵！

    @Bean
   public static ConfigPropertiesValidator configurationPropertiesValidator() {
       return new ConfigPropertiesValidator();
   }

其中有兩個(gè)注意點(diǎn)：

• 方法名必須為     configurationPropertiesValidator ，否則在啟動(dòng)的時(shí)候不會(huì)執(zhí)行該校驗(yàn)
• 方法必須聲明為     static, 告訴Spring，該Bean的創(chuàng)建要在所有的Configuration之前

我們修改在application.yml中config.name：

config:
name: a

這樣，name長(zhǎng)度就不能滿足我們自定義的校驗(yàn)規(guī)則，啟動(dòng)程序，查看結(jié)果：

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'config' to io.github.tinyking.springvalidation.config.ConfigProperties failed:

   Property: config.name
   Value: a
   Origin: class path resource [application.yml]:2:9
   Reason: name is too shot


Action:

Update your application's configuration

錯(cuò)誤信息即為我們自定義校驗(yàn)的結(jié)果。

通過配置Spring Boot啟動(dòng)校驗(yàn)功能，可以快速的識(shí)別參數(shù)配置的錯(cuò)誤，使我們?cè)陂_發(fā)過程中有更好starter集成體驗(yàn)。