詳解關(guān)于SpringBoot的外部化配置使用記錄
更新: 工作中突然想起來，關(guān)于Yaml的使用，并不屬于Spring的范疇，是org.yaml.snakeyaml處理的。所以yaml的使用應該參考官方，不過貌似打不開。。。
Spring利用snakeyaml將配置解析成PropertySource，然后寫入到Environment，就能使用了
記錄下使用SpringBoot配置時遇到的一些麻煩，雖然這種麻煩是因為知識匱乏導致的。
記錄下避免一段時間后自己又給忘記了，以防萬一。
如果放到博客里能幫助到遇到同樣問題的同志，自是極好！
SpringBoot的外部化配置，主要就是指平時用到的一些配置文件，這些配置由于不是硬編碼，放在了配置文件中，所以相對來說是一個外部化的配置Externalized Configuration
SpringBoot官方外部化配置的在線文檔Externalized Configuration
初級用法#
SpringBoot對配置提供了極大的便利，僅僅需要編寫一個Yaml文件或者Properties文件，按照其規(guī)定的格式，書寫好我們的配置信息，然后編寫一個相應的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中使用我們的配置了。
以上這些在開發(fā)中基本上也就滿足需要了，大部分我們的配置都很簡單，通常都是數(shù)值型的和字符串。
但是，凡事不能絕對。
高級用法#
以下配置參考這位
Array/List#
假如有如下需求，應用僅對幾個有限的IP開放訪問，然后我們想把這幾個獲得許可的IP地址寫在配置文件中。
這個時候如果配置解析僅僅支持字符串和數(shù)值型的話，就需要我們自己獲取到配置值以后，再去進行一些后續(xù)的處理，比如轉(zhuǎn)換成數(shù)組或者列表。
好在，優(yōu)秀的框架，總能滿足大部分的需求，SpringBoot是直接配置直接到數(shù)組或者列表的映射到
使用方式
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#
如果數(shù)組或者列表不滿足需求，需要key-vlaue型的，沒問題，SpringBoot也是支持的。
假設(shè)一個對接方不同的業(yè)務，使用了不同的AES密鑰，那么在配置的時候，就要根據(jù)業(yè)務類型作為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#
枚舉？那必須支持
不過實際意義不怎么大，如果配置的值要可以轉(zhuǎn)換成枚舉值的話，配置的值必須和枚舉值的name一致，大小寫都不能差，因為SpringBoot實現(xiàn)的配置到枚舉的轉(zhuǎn)換，使用的是
/* 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);
}
關(guān)于這段代碼的理解，可以參考另外一片文章深入理解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的數(shù)組或者List，或者作為Map的value，會發(fā)現(xiàn)綁定不上去。
原因在于，綁定默認是基于Setter方法，進行單個字段的綁定，賦值，而這里要的是一個JavaBean，需要創(chuàng)建一個JavaBean對象，再去做屬性綁定賦值。
如果按照這兩步走，也可以做到成功綁定到一個作為元素的JavaBean對象。
只是SpringBoot并沒有那么做，而是提供了一個@ConstructorBinding注解，讓我們使用構(gòu)造器綁定數(shù)據(jù)。
復雜配置#
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
}
然后啟動，走起，立馬會發(fā)現(xiàn)熟悉又可氣的NPE
原因很簡單，SpringBoot沒能從配置文件讀取相應的配置數(shù)據(jù)并且實例化一個Map，因為
它現(xiàn)在面對的情況比以前復雜了，現(xiàn)在的JavaBean是一個Map的value值
解決方法就是使用構(gòu)造器綁定的方式，并且需要在構(gòu)造器使用此注解@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
我并不知道是否有別的方式也可以做到，比如繼續(xù)使用Setter方法來進行數(shù)據(jù)綁定
瘦身計劃#
上面的這些配置，如果都有的話，全部寫到application.yml或者application.properties文件中，會導致配置文件內(nèi)容太多，而且各種配置混合在一起，不便于管理和維護。
如果需要改動某個配置，就要改動整個文件，存在一定的風險導致其他配置被誤改。
所以應該一類配置，放到一起去管理。
同樣的，一類配置通常對應一個功能，如果其中一項配置的改動，那么相應的測試，也能保證同一個配置文件的修改不會引發(fā)其他問題。
所以有必要將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方法
}
問題來了，死活沒法將數(shù)據(jù)綁定到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配置更有優(yōu)勢一些，所以如果想繼續(xù)使用yaml的話，也不是不可以
@PropertySource支持自定義文件格式#
// 這里繼承了DefaultPropertySourceFactory，也可以直接實現(xiàn)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中構(gòu)建一個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配置文件，使用默認實現(xiàn)
return super.createPropertySource(name, resource);
}
}
使用時，@PropertySource(factory=YamlPropertySourceFactory.class)即可。
使用@Value#
@Value是Spring Framework的注解，不屬于SpringBoot，其典型使用場景就是注入外部化配置屬性，官方文檔@Values介紹
@Value使用Spring內(nèi)建的轉(zhuǎn)化器SimpleTypeConverter，這個支持Integer，String，和逗號分割的字符串數(shù)組。
如果覺得支持不夠，還是可以自定義轉(zhuǎn)換支持，自定義一個Converter，然后加入到ConverterService這個Bean中，因為后面的BeanPostProcessor依賴的就是ConverterService來處理轉(zhuǎn)換的
所以如果有一些復雜的配置，最好還是使用SpringBoot的方式。
@Value的優(yōu)勢在于，它支持SpEL，而且可以使用在任意一個Bean的方法參數(shù)或者字段上
所以這是兩種不同的使用場景，看情況自己選擇。
不過總體個人傾向于前面一種，因為如果在其他的Bean中直接使用@Value，萬一我們要改配置的名字了，結(jié)果因為使用了@Value，遍布的到處都是，改起來很麻煩，所以從管理維護的角度來說，@Value太野了。
順便說一下對@Value的處理位置org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#populateBean，當然這里也是處理@Inject @Autowired @Resource的地方
后記#
從配置文件到程序中使用到配置的值，一共經(jīng)歷兩大步
- 讀取配置內(nèi)容到Environment中，無論任何形式的配置，最后都是一個Property Source
- 通過BeanPostProcessor來進行配置值綁定注入
如果不滿足properties或者yaml格式的配置，可以自定義PropertySourceLoader，可以參考
org.springframework.boot.env.YamlPropertySourceLoader 和org.springframework.boot.env.PropertiesPropertySourceLoader
補充更新#
在使用@ConfigurationProperties時，可以不用有對應的字段定義，如果需要對注入的配置值，在Setter方法中轉(zhuǎn)換成其他類型時。
因為這種綁定方式直接通過Setter方法來做的（其實@Value也可以注解在方法上），并不會檢查是否存在這個字段的定義。
JavaConfig#
@Configuration
@ConfigurationProperties("config")
public class Config{
Map<BizType, Metadata> bizMetaMap = new ConcurrentHashMap<>(5);
public void setMetadatas(List<Metadata> metas){
for(Metadata meta: metas){
bizMetaMap.put(BizType.forCode(),meta);
}
}
}
yaml配置#
config:
metadatas:
-
name: xxx
age: xxx
這樣就可以了，不需要實際有對應的字段存在與之對應，能找到對應的Setter方法即可！
到此這篇關(guān)于詳解關(guān)于SpringBoot的外部化配置使用記錄的文章就介紹到這了,更多相關(guān)SpringBoot外部化配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Java設(shè)計模式之GOF23全面講解,本篇文章通過簡要的案例,講解了該項技術(shù)的了解與使用,以下就是詳細內(nèi)容,需要的朋友可以參考下2021-07-07
Java開發(fā)之手把手教你搭建企業(yè)級工程SSM框架
這篇文章主要為大家介紹Java教程中搭建企業(yè)級工程SSM框架，手把手的過程操作，有需要的朋友可以借鑒參考下，希望能夠有所幫助2021-09-09
這篇文章主要介紹了如何創(chuàng)建SpringBoot項目，幫助大家更好的學習和使用springboot框架，感興趣的朋友可以了解下2021-01-01
這篇文章主要介紹了淺談Spring自定義注解從入門到精通，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-09-09
Spring Security使用單點登錄的權(quán)限功能
本文主要介紹了Spring Security使用單點登錄的權(quán)限功能，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-04-04
隱式轉(zhuǎn)換是在Scala編譯器進行類型匹配時，如果找不到合適的類型，那么隱式轉(zhuǎn)換會讓編譯器在作用范圍內(nèi)自動推導出來合適的類型。本文通過代碼示例介紹了Scala的隱式轉(zhuǎn)換，感興趣的小伙伴可以參考閱讀2023-04-04
這篇文章主要介紹了Java常用的八種排序算法及代碼實現(xiàn),在Java的時候，對于排序的應用需要熟練的掌握，這樣才能夠確保Java學習時候能夠有扎實的基礎(chǔ)能力。那Java有哪些排序算法呢？本文小編就來詳細說說Java經(jīng)典的8種排序算法,需要的朋友可以參考一下2021-12-12
Java 實現(xiàn)加密數(shù)據(jù)庫連接的步驟
這篇文章主要介紹了Java 實現(xiàn)加密數(shù)據(jù)庫連接的步驟，幫助大家更好的理解和使用Java處理數(shù)據(jù)庫，感興趣的朋友可以了解下2020-11-11
Java利用Sping框架編寫RPC遠程過程調(diào)用服務的教程
這篇文章主要介紹了Java利用Sping框架編寫RPC遠程過程調(diào)用服務的教程,包括項目管理工具Maven的搭配使用方法,需要的朋友可以參考下2016-06-06
Java 枚舉類和自定義枚舉類和enum聲明及實現(xiàn)接口的操作
這篇文章主要介紹了Java 枚舉類和自定義枚舉類和enum聲明及實現(xiàn)接口的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02