關於SpringBoot的外部化配置使用記錄

早知今日發表於2020-05-16
Spring Boot

關於SpringBoot的外部化配置使用記錄

宣告: 若有任何紕漏、錯誤請不吝指出!

記錄下使用SpringBoot配置時遇到的一些麻煩，雖然這種麻煩是因為知識匱乏導致的。

記錄下避免一段時間後自己又給忘記了，以防萬一。

如果放到部落格裡能幫助到遇到同樣問題的同志，自是極好！

SpringBoot的外部化配置，主要就是指平時用到的一些配置檔案，這些配置由於不是硬編碼，放在了配置檔案中，所以相對來說是一個外部化的配置Externalized Configuration

SpringBoot官方外部化配置的線上文件Externalized Configuration

初級用法

SpringBoot對配置提供了極大的便利，僅僅需要編寫一個Yaml檔案或者Properties檔案，按照其規定的格式，書寫好我們的配置資訊，然後編寫一個相應的Java類，使用註解@ConfigurationProperties和@Configuration配合使用，或者@Configuration和@Value配合使用，即可將配置的值，對映到我們配置類或者JavaBean中。

有如下Java配置類

@Configuration
@ConfigurationProperties(prefix="spring.server")
public class AppConfig{
  private String name;
  private String port;
  public void setName(String name){
    this.name = name;
  }
  public void setPort(String port){
    this.port = port;
  }
}

如下配置檔案，

Yaml格式配置檔案

# application.yml
spring:
    server:
        name: spring-app
        port: 9527

Properties格式配置檔案

# application.properties
spring.server.name=spring-app
spring.server.port=9237

使用@ConfigurationProperties，必須要有Setter方法，繫結時是通過Setter方法繫結的

參見org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor#postProcessBeforeInitialization，這是一個BeanPostProcessor

這樣在SpringBoot中，我們就可以將AppConfig這個Bean注入到別的Bean中使用我們的配置了。

以上這些在開發中基本上也就滿足需要了，大部分我們的配置都很簡單，通常都是數值型的和字串。

但是，凡事不能絕對。

高階用法

以下配置參考這位

Array/List

假如有如下需求，應用僅對幾個有限的IP開放訪問，然後我們想把這幾個獲得許可的IP地址寫在配置檔案中。

這個時候如果配置解析僅僅支援字串和數值型的話，就需要我們自己獲取到配置值以後，再去進行一些後續的處理，比如轉換成陣列或者列表。

好在，優秀的框架，總能滿足大部分的需求，SpringBoot是直接配置直接到陣列或者列表的對映到

使用方式

Java配置類

@Configuration
@ConfigurationProperties(prefix="allows")
public class AllowedAccessConfig{
  private String[] ipList; // 欄位型別可以是 List<String>
  public void setPort(String[] port){
    this.ipList = ipList;
  }
}

配置檔案

# application.yml
allows:
      ipList: 
	  - 192.168.1.1
	  - 192.168.1.2
	  - 192.168.1.3
	  - 192.168.1.4
# or
allows:
     ipList: 192.168.1.1, 192.168.1.2, 192.168.1.3, 192.168.1.4

# application.properties
allows.ipList[0]=192.168.1.1
allows.ipList[1]=192.168.1.2
allows.ipList[2]=192.168.1.3
allows.ipList[3]=192.168.1.4
# or
allows.ipList= 192.168.1.1, 192.168.1.2, 192.168.1.3, 192.168.1.4

Map

如果陣列或者列表不滿足需求，需要key-vlaue型的，沒問題，SpringBoot也是支援的。

假設一個對接方不同的業務，使用了不同的AES金鑰，那麼在配置的時候，就要根據業務型別作為key，對應的金鑰作為value。

Java配置類

@Configuration
@ConfigurationProperties(prefix="aes.keys")
public class AesKeyConfig{
  private Map<String,String> keys;
  public void setKeys(Map<String,String> keys){
    this.keys = keys;
  }
}

配置檔案

# application.yml
aes:
    keys:
        order: 28jsaS2asf2fSA2
        pay: @ra@3safdsR5&sDa
# or
aes:
    keys[order]: 28jsaS2asf2fSA2
    keys[pay]: @ra@3safdsR5&sDa

# application.properties
aes.keys.order=28jsaS2asf2fSA2
aes.keys.pay=@ra@3safdsR5&sDa
# or
aes.keys[order]=28jsaS2asf2fSA2
aes.keys[pay]=@ra@3safdsR5&sDa

Enum

列舉？那必須支援

不過實際意義不怎麼大，如果配置的值要可以轉換成列舉值的話，配置的值必須和列舉值的name一致，大小寫都不能差，因為SpringBoot實現的配置到列舉的轉換，使用的是

/* java.lang.Enum#valueOf */
public static <T extends Enum<T>> T valueOf(Class<T> enumType,
                                            String name) {
  // 這裡的name就是列舉值的字元表示，一般都是大寫的
  T result = enumType.enumConstantDirectory().get(name);
  if (result != null)
    return result;
  if (name == null)
    throw new NullPointerException("Name is null");
  throw new IllegalArgumentException(
    "No enum constant " + enumType.getCanonicalName() + "." + name);
}

關於這段程式碼的理解，可以參考另外一片文章深入理解Java列舉

如果列舉還有其他欄位的話，就沒辦法了

JavaBean

什麼？ 還是不能滿足？想要直接把配置繫結到一個JavaBean？

幹就完事了！

JavaBean

@Configuration
@ConfigurationProperties(prefix="upload")
public class UploadConfig{
  private String rootPath;
  private String fileType;
  private int fileSize;
	private boolean rename;
  // 省略 Setter方法
}

配置檔案

# application.yml
upload:
	root-path: /xx/xx/xx
	file-type: zip
	fileSize: 1M
	rename: false

# application.properties
upload.rootPath=/xx/xx/xx
upload.fileType=zip
upload.fileSize=1M
upload.rename=false

以上幾種用法，可以組合使用，非常的靈活

不過如果是JavaBean的陣列或者List，或者作為Map的value，會發現繫結不上去。

原因在於，繫結預設是基於Setter方法，進行單個欄位的繫結，賦值，而這裡要的是一個JavaBean，需要建立一個JavaBean物件，再去做屬性繫結賦值。

如果按照這兩步走，也可以做到成功繫結到一個作為元素的JavaBean物件。

只是SpringBoot並沒有那麼做，而是提供了一個@ConstructorBinding註解，讓我們使用構造器繫結資料。

複雜配置

JavBean

@Configuration
@ConfigurationProperties(prefix="app")
public class AppConfig{
  
  private Map<String, DataSourceMetadata> multiDataSourceMap;
  
  public void setMultiDataSourceMap(Map<String, DataSourceMetadata> multiDataSourceMap){
    this.multiDataSourceMap = multiDataSourceMap;
  }
}

public class DataSourceMetadata{
  private String url;
  private String driverClass;
  private String username;
  private String passowrd;
  // 省略Setter和Getter
}

配置檔案

app:
      multiDataSourceMap:
		ds1:
			url: jdbc://
			driver-class: com.mysql.cj.Driver
			username: xxx
			password: xxx
		ds2:
			url: jdbc://
			driver-class: com.mysql.cj.Driver
			username: 12sds
			password:	adfwqw
# or 
app:
      multiDataSourceMap:
		ds1: {
			url: jdbc://
			driver-class: com.mysql.cj.Driver
			username: xxx
			password: xxx
		}
			
		ds2: {
			url: jdbc://
			driver-class: com.mysql.cj.Driver
			username: 12sds
			password:	adfwqw
		}

然後啟動，走起，立馬會發現熟悉又可氣的NPE

原因很簡單，SpringBoot沒能從配置檔案讀取相應的配置資料並且例項化一個Map，因為

它現在面對的情況比以前複雜了，現在的JavaBean是一個Map的value值

解決方法就是使用構造器繫結的方式，並且需要在構造器使用此註解@ConstructorBinding

public class DataSourceMetadata{
  private String url;
  private String driverClass;
  private String username;
  private String passowrd;
  @ConstructorBinding
  public DataSourceMetadata(String url, String driverClass, String username, String passowrd){
    this.url = url;
    this.driverClass = driverClass;
    this.username = username;
    this.password = password;
  }
  // 省略Setter和Getter
}

只要這麼一搞就正常了，不會有煩人的NPE

我並不知道是否有別的方式也可以做到，比如繼續使用Setter方法來進行資料繫結

瘦身計劃

上面的這些配置，如果都有的話，全部寫到application.yml或者application.properties檔案中，會導致配置檔案內容太多，而且各種配置混合在一起，不便於管理和維護。

如果需要改動某個配置，就要改動整個檔案，存在一定的風險導致其他配置被誤改。

所以應該一類配置，放到一起去管理。

同樣的，一類配置通常對應一個功能，如果其中一項配置的改動，那麼相應的測試，也能保證同一個配置檔案的修改不會引發其他問題。

所以有必要將application.yml拆分了。

花了一番力氣，拆分了一個出來upload.yml，然後使用如下方式引入配置檔案

配置檔案預設是放在 resources目錄下(maven/gradle)，配置檔案在編譯打包後，會位於classes的根目錄下，也就是我們所謂的classpath

@Configuration
@PropertySource("classpath:upload.yml")
@ConfigurationProperties(prefix="upload")
public class UploadConfig{
  private String rootPath;
  private String fileType;
  private int fileSize;
	private boolean rename;
  // 省略 Setter方法
}

問題來了，死活沒法將資料繫結到JavaBean的屬性上。

Debug看原始碼，陷進去出不來。試著使用profile來解決，雖然可以解決，但是畢竟不是同一個使用場景，並不合適。

最後找人求救，告知@PropertySource不支援yaml檔案，僅支援properties，於是試了下，果然是的

SpringBoot版本是2.2.6，有個群友說他1.5的還是支援的，不過SpringBoot官方明確寫到不支援的

2.7.4. YAML Shortcomings

YAML files cannot be loaded by using the @PropertySource annotation. So, in the case that you need to load values that way, you need to use a properties file.

上面看到，其實yaml配置更有優勢一些，所以如果想繼續使用yaml的話，也不是不可以

@PropertySource支援自定義檔案格式

// 這裡繼承了DefaultPropertySourceFactory，也可以直接實現PropertySourceFactory
public class YamlPropertySourceFactory extends DefaultPropertySourceFactory {

    public YamlPropertySourceFactory () {
        super();
    }

    @Override
    public PropertySource<?> createPropertySource (String name, EncodedResource resource)
            throws IOException {
        // 這個判斷是有必要的，因為直接使用name是null，沒深究原因
        String nameToUse = name != null ? name : resource.getResource().getFilename();
        // yml檔案，使用YamlPropertiesFactoryBean來從yaml檔案Resource中構建一個Properties物件
        // 然後使用PropertiesPropertySource封裝成PropertySource物件，就能加入到Environment
        if (nameToUse.endsWith(".yml")) {
            YamlPropertiesFactoryBean factoryBean = new YamlPropertiesFactoryBean();
            factoryBean.setResources(resource.getResource());
            factoryBean.afterPropertiesSet();
            return new PropertiesPropertySource(nameToUse, factoryBean.getObject());
        }
        // 如果不是yml配置檔案，使用預設實現
        return super.createPropertySource(name, resource);
    }
}

使用時，@PropertySource(factory=YamlPropertySourceFactory.class)即可。

使用@Value

@Value是Spring Framework的註解，不屬於SpringBoot，其典型使用場景就是注入外部化配置屬性，官方文件@Values介紹

@Value使用Spring內建的轉化器SimpleTypeConverter，這個支援Integer，String，和逗號分割的字串陣列。

如果覺得支援不夠，還是可以自定義轉換支援，自定義一個Converter，然後加入到ConverterService這個Bean中，因為後面的BeanPostProcessor依賴的就是ConverterService來處理轉換的

所以如果有一些複雜的配置，最好還是使用SpringBoot的方式。

@Value的優勢在於，它支援SpEL，而且可以使用在任意一個Bean的方法引數或者欄位上

所以這是兩種不同的使用場景，看情況自己選擇。

不過總體個人傾向於前面一種，因為如果在其他的Bean中直接使用@Value，萬一我們要改配置的名字了，結果因為使用了@Value，遍佈的到處都是，改起來很麻煩，所以從管理維護的角度來說，@Value太野了。

順便說一下對@Value的處理位置org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#populateBean，當然這裡也是處理@Inject @Autowired @Resource的地方

後記

從配置檔案到程式中使用到配置的值，一共經歷兩大步

  1. 讀取配置內容到Environment中，無論任何形式的配置，最後都是一個Property Source
  2. 通過BeanPostProcessor來進行配置值繫結注入

如果不滿足properties或者yaml格式的配置，可以自定義PropertySourceLoader，可以參考

org.springframework.boot.env.YamlPropertySourceLoader 和org.springframework.boot.env.PropertiesPropertySourceLoader

相關文章