詳解Spring獲取配置的三種方式
更新時間：2022年03月08日 08:30:50 作者：cartoon
這篇文章主要為大家詳細介紹了Spring獲取配置的三種方式：@Value方式動態(tài)獲取單個配置、@ConfigurationProperties+前綴方式批量獲取配置以及Environment動態(tài)獲取單個配置，感興趣的可以了解一下
前言
最近在寫框架時遇到需要根據(jù)特定配置（可能不存在）加載 bean 的需求，所以就學習了下 Spring 中如何獲取配置的幾種方式。
Spring 中獲取配置的三種方式
- 通過 @Value 方式動態(tài)獲取單個配置
- 通過 @ConfigurationProperties + 前綴方式批量獲取配置
- 通過 Environment 動態(tài)獲取單個配置
通過 @Value 動態(tài)獲取單個配置
1.作用
可修飾到任一變量獲取，使用較靈活
2.優(yōu)點
使用簡單，且使用關聯(lián)的鏈路較短
3.缺點
- 配置名不能被有效枚舉到
- 每一個配置的使用都需重新定義，使用較為麻煩
- 項目強依賴配置的定義，配置不存在則會導致項目無法啟動
4.使用場景
- 項目強依賴該配置的加載，想要從源頭避免因配置缺失導致的未知問題
- 只想使用少數(shù)幾個配置
5.代碼示例
@Configuration
public class ConfigByValueAnnotation {
@Value("${server.port}")
private String serverPort;
public String getServerPort() {
return serverPort;
}
}6.測試代碼
@DisplayName("multipart get config")
@SpringBootTest
public class MultipartGetConfigTest {
private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);
@Autowired
private ConfigByValueAnnotation configByValueAnnotation;
@Test
public void getByValueAnnotation(){
log.info("get by @Value, value: {}", configByValueAnnotation.getServerPort());
}
}7.測試結果
org.spring.demo.MultipartGetConfigTest : get by @Value, value: 7100
通過@ConfigurationProperties+前綴方式批量獲取
1.作用
用于配置類的修飾或批量配置的獲取
2.優(yōu)點
- 使用配置只需確定 key 的前綴即能使用，有利于批量獲取場景的使用
- 因采用前綴匹配，所以在使用新的相同前綴 key 的配置時無需改動代碼
3.缺點
- 使用復雜，需定義配置類或者手動創(chuàng)建 bean 后引入使用
- 增加新的前綴相同 key 時可能會引入不穩(wěn)定因素
4.使用場景
- 需要同時使用多前綴相同 key 的配置
- 期望增加新配置但不修改代碼的 properties 注入
5.代碼示例
@Component
@ConfigurationProperties(prefix = "server", ignoreInvalidFields = true)
public class ConfigByConfigurationProperties {
private Integer port;
public Integer getPort() {
return port;
}
public ConfigByConfigurationProperties setPort(Integer port) {
this.port = port;
return this;
}
}@Configuration
public class ConfigByConfigurationPropertiesV2 {
@Bean("configByValueAnnotationV2")
@ConfigurationProperties(prefix = "server2")
public Properties properties(){
return new Properties();
}
}6.測試代碼
@DisplayName("multipart get config")
@SpringBootTest
public class MultipartGetConfigTest {
private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);
@Autowired
private ConfigByConfigurationProperties configByConfigurationProperties;
@Autowired
@Qualifier("configByValueAnnotationV2")
private Properties properties;
@Test
public void getByConfigurationProperties(){
log.info("get by @ConfigurationProperties, value: {}", configByConfigurationProperties.getPort());
log.info("get by @ConfigurationProperties and manual create bean, value: {}", properties.getProperty("port"));
}
}7.測試結果
org.spring.demo.MultipartGetConfigTest : get by @ConfigurationProperties, value: 7100
org.spring.demo.MultipartGetConfigTest : get by @ConfigurationProperties and manual create bean, value: 7100
通過 Environment 動態(tài)獲取單個配置
1.作用
用于動態(tài)在程序代碼中獲取配置，而配置 key 不需提前定義
2.優(yōu)點
- 獲取的配置的 key 可不提前定義，程序靈活性高
- 配置 key 可使用枚舉統(tǒng)一放置與管理
3.缺點
- 使用較復雜，需繼承 Environment 接口形成工具類進行獲取
- 獲取 key 對應的枚舉與 key 定義分離，value 獲取鏈路較長
4.使用場景
- 只需使用少量的配置
- 獲取配置的 key 無提前定義，需要根據(jù)對配置的有無進行靈活使用
5.代碼示例
@Component
public class ConfigByEnvironment implements EnvironmentAware {
private static final Logger log = LoggerFactory.getLogger(ConfigByEnvironment.class);
private Environment environment;
public Optional<String> get(String configKey){
String config = environment.getProperty(configKey);
return Objects.isNull(config) ? Optional.empty() : Optional.of(config);
}
public void get(String configKey, Consumer<String> consumer){
Optional<String> config = get(configKey);
if(!config.isPresent()){
log.warn("application config, get config by key fail, key: {}", configKey);
}
config.ifPresent(consumer);
}
@Override
public void setEnvironment(@NonNull Environment environment) {
this.environment = environment;
}
}
public enum ConfigByEnvironmentKey {
SERVER_PORT("server.port", "server port");
private String key;
private String description;
ConfigByEnvironmentKey(String key, String description) {
this.key = key;
this.description = description;
}
public String getKey() {
return key;
}
public String getDescription() {
return description;
}
}6.測試代碼
@DisplayName("multipart get config")
@SpringBootTest
public class MultipartGetConfigTest {
private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);
@Autowired
private ConfigByEnvironment configByEnvironment;
@Test
public void getByEnvironment(){
configByEnvironment.get(ConfigByEnvironmentKey.SERVER_PORT.getKey()).ifPresent(value -> log.info("get by environment, value: {}", value));
}
}7.測試結果
org.spring.demo.MultipartGetConfigTest : get by environment, value: 7100
總結
| 獲取配置方式 | 優(yōu)點 | 缺點 | 使用場景 |
|---|---|---|---|
| 通過 @Value 動態(tài)獲取單個配置 | 使用簡單，且使用關聯(lián)的鏈路較短 | 1. 配置名不能被有效枚舉到 2. 每一個配置的使用都需重新定義，使用較為麻煩 3. 項目強依賴配置的定義，配置不存在則會導致項目無法啟動 | 1. 項目強依賴該配置的加載，想要從源頭避免因配置缺失導致的未知問題 2. 只想使用少數(shù)幾個配置 |
| 通過 @ConfigurationProperties + 前綴方式批量獲取 | 1. 使用配置只需確定 key 的前綴即能使用，有利于批量獲取場景的使用 2. 因采用前綴匹配，所以在使用新的相同前綴 key 的配置時無需改動代碼 | 1. 使用復雜，需定義配置類或者手動創(chuàng)建 bean 后引入使用 2. 增加新的前綴相同 key 時可能會引入不穩(wěn)定因素 | 1. 需要同時使用多前綴相同 key 的配置 2. 期望增加新配置但不修改代碼的 properties 注入 |
| 通過 Environment 動態(tài)獲取單個配置 | 1. 獲取的配置的 key 可不提前定義，程序靈活性高 2. 配置 key 可使用枚舉統(tǒng)一放置與管理 | 1. 使用較復雜，需繼承 Environment 接口形成工具類進行獲取 2. 獲取 key 對應的枚舉與 key 定義分離，value 獲取鏈路較長 | 1. 只需使用少量的配置 2. 獲取配置的 key 無提前定義，需要根據(jù)對配置的有無進行靈活使用 |
以上就是詳解Spring獲取配置的三種方式的詳細內(nèi)容，更多關于Spring 獲取配置的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了Java后端長時間無操作自動退出的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-01-01
這篇文章主要給大家介紹了關于Java多線程中wait/notify通信模式的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
一行命令同時修改maven項目中多個module的版本號的方法
這篇文章主要介紹了一行命令同時修改maven項目中多個module的版本號的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-06-06
這篇文章主要介紹了Java LCN框架分布式事務，分布式事務是指事務的參與者、支持事務的服務器、資源服務器以及事務管理器分別位于不同的分布式系統(tǒng)的不同節(jié)點之上2022-07-07
Fork/Join框架是Java7提供用于并行執(zhí)行任務的框架，是一個把大任務分割成若干個小任務，今天通過本文給大家分享java中fork join原理，感興趣的朋友一起看看吧2021-04-04
這篇文章主要介紹了java將word轉pdf的相關資料,文中講解了使用Aspose-Words工具將Word文檔轉換為PDF的優(yōu)劣,并提供了一種在Java項目中使用Aspose-Words進行Word轉PDF的示例方法,需要的朋友可以參考下2025-01-01
SpringBoot中@Transiactional注解沒有效果的解決
這篇文章主要介紹了SpringBoot中@Transiactional注解沒有效果的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
這篇文章主要介紹了Java注解簡單使用實例解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-06-06
SpringBoot+MybatisPlus實現(xiàn)sharding-jdbc分庫分表的示例代碼
本文主要介紹了SpringBoot+MybatisPlus實現(xiàn)sharding-jdbc分庫分表的示例代碼,以分庫,分表,分庫分表三種方式來實現(xiàn),具有一定的參考價值,感興趣的可以了解一下2024-03-03
這篇文章主要介紹了Java讀取文件的簡單實現(xiàn)方法,通過一個讀取txt格式的log文件為例,詳細的講述了Java讀取文件的方法及原理,需要的朋友可以參考下2014-09-09