導航:首頁 > 文件管理 > springboot能自動讀取配置文件

springboot能自動讀取配置文件

發布時間:2023-06-04 18:37:10

① 請教,如何spring boot里動態讀取配置文件

項目,需要訪問多個資料庫,而且需要在伺服器運行不重新啟動的情況下,動態的修改spring中配置的數據源datasource,在網上找了很多資料,最後找到了適合我的方法,下面總結一下。 spring的配置文件是在容器啟動的時候就載入到內存中的

② SpringBoot自動配置的原理及實現/SpringBoot之@Import註解正確使用方式

https://www.jianshu.com/p/6b2f672e2446
了解SpringBoot之@Import註解正確使用方式

SpringBoot 的核心就是自動配置,自動配置又是基於條件判斷來配置 Bean。關於自動配置的源碼在 spring-boot -autoconfigure-2.0.3.RELEASE.jar

在通常需要我們在 property 中配置信息時,通常使用 @ConfigurationProperties(pefix=「前綴」) 註解的方式從配置文件中獲取配置,如下:

application.yml 中配置信息

訪問 url 獲取配置信息返回的值
http://localhost:8080/msg

如果把 application.yml 中的配置信息注釋掉則默認使用 default 值,否則使用配置信息中的值,以上便是普通配置方式

SpringBoot 運行原理
先看 @SpringBootApplication

主要關注的幾個註解如下
@SpringBootConfiguration:標記當前類為配置類
@EnableAutoConfiguration:開啟自動配置
@ComponentScan:掃描主類所在的同級包以及下級包里的 Bean
關鍵是 @EnableAutoConfiguration

最關鍵的要屬 @Import(.class),藉助** **,@EnableAutoConfiguration 可以幫助 SpringBoot 應用將所有符合條件的 @Configuration 配置都載入到當前 SpringBoot 創建並使用的 IoC 容器: 通過 @Import(.class) 導入的配置功能,
中的方法 getCandidateConfigurations,得到待配置的 class 的類名集合, 這個集合就是所有需要進行自動配置的類,而是是否配置的關鍵在於 META-INF/spring.factories 文件中是否存在該配置信息

打開,如下圖可以看到所有需要配置的類全路徑都在文件中,每行一個配置,多個類名逗號分隔, 而 \ 表示忽略換行

整個流程如上圖所示

以 類來看其主要構成部分

都能看到各種各樣的條件判斷註解,滿足條件時就載入這個 Bean 並實例化
此類的條件註解是:@ConditionalOnProperty

@ConditionalOnBean:當容器里有指定 Bean 的條件下
@ConditionalOnClass:當類路徑下有指定的類的條件下
@ConditionalOnExpression:基於 SpEL 表達式為 true 的時候作為判斷條件才去實例化
@ConditionalOnjava:基於 JVM 版本作為判斷條件
@ConditionalOnJndi:在 JNDI 存在的條件下查找指定的位置
@ConditionalOnMissingBean:當容器里沒有指定 Bean 的情況下
@ConditionalOnMissingClass:當容器里沒有指定類的情況下
@ConditionalOnWebApplication:當前項目時 Web 項目的條件下
@:當前項目不是 Web 項目的條件下
@ConditionalOnProperty:指定的屬性是否有指定的值
@ConditionalOnResource:類路徑是否有指定的值
@:當指定 Bean 在容器中只有一個,或者有多個但是指定首選的 Bean
這些註解都組合了 @Conditional 註解,只是使用了不同的條件組合最後為 true 時才會去實例化需要實例化的類,否則忽略
這種 spring4.X 帶來的動態組合很容易後期配置,從而避免了硬編碼,使配置信息更加靈活多變,同時也避免了不必要的意外異常報錯。使用的人只要知道配置的條件即可也不用去閱讀源碼,方便快捷,這也是 sprignboot 快捷方式帶來的好處

參考 HttpEncodingAutoConfiguration 配置信息如下

案例擴展

項目

需要實例化的服務類

配置信息對應的屬性映射類, 需要 pom 中加入 spring-boot-starter 依賴

自動配置文件

在創建如下路徑文件 src/main/resources/META-INF/spring.factories

必須是自動配置類的全路徑

mvn install 該項目

創建一個 springboot-mvc 項目 pom 依賴上面的 jar

http://localhost:8080 / 則返回當前服務的默認值

在 applicaton.yml 中加, 重啟刷新則會更新為如下信息

SpringBoot 自動化配置關鍵組件關系圖
mybatis-spring-boot-starter、spring-boot-starter-web 等組件的 META-INF 文件下均含有 spring.factories 文件,自動配置模塊中,SpringFactoriesLoader 收集到文件中的類全名並返回一個類全名的數組,返回的類全名通過反射被實例化,就形成了具體的工廠實例,工廠實例來生成組件具體需要的 bean。

在 spring boot 中有時候需要控制配置類是否生效, 可以使用 @ConditionalOnProperty 註解來控制 @Configuration 是否生效.

③ Springboot打成JAR包後讀取外部配置文件

Springboot的application.properties配置文件的載入路徑優先殲念蔽級(從高到低):

當Springboot打成JAR包(不包含配置文件),讀取外部配高薯置文件application.properties時,氏州可以選擇:

④ SpringBoot 如何優雅讀取配置文件10分鍾教你搞定

很多時候我們需要將一些常用的配置信息比如阿里雲 oss 配置、發送簡訊的相關信息配置等等放到配置文件中。

下面我們來看一下 Spring 為我們提供了哪些方式幫助我們從配置文件中讀取這些配置信息。

application.yml 內容如下:

wuhan2020: 2020年初武漢爆發了新型冠狀病毒,疫情嚴重,但是,我相信一切都會過去!武漢加油!中國加油!my-profile:name: Guide哥email: [email protected]:location: 湖北武漢加油中國加油books:    -name: 天才基本法description: 二十二歲的林朝夕在父親確診阿爾茨海默病這天,得知自己暗戀多年的校園男神裴之即將出國深造的消息——對方考取的學校,恰是父親當年為她放棄的那所。    -name: 時間的秩序description: 為什麼我們記得過去,而非未來?時間「流逝」意味著什麼?是我們存在於時間之內,還是時間存在於我們之中?卡洛·羅韋利用詩意的文字,邀請我們思考這一亘古難題——時間的本質。    -name: 了不起的我description: 如何養成一個新習慣?如何讓心智變得更成熟?如何擁有高質量的關系? 如何走出人生的艱難時刻?

1.通過 @value 讀取比較簡單的配置信息

使用 @Value("${property}") 讀取比較簡單的配置信息:

@Value("${wuhan2020}")String wuhan2020;

需要注意的是 @value這種方式是不被推薦的,Spring 比較建議的是下面幾種讀取配置信息的方式。

2.通過@ConfigurationProperties讀取並與 bean 綁定

LibraryProperties 類上加了 @Component 註解,我們可以像使用普通 bean 一樣將其注入到類中使用。

importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.context.annotation.Configuration;importorg.springframework.stereotype.Component;importjava.util.List;@Component@ConfigurationProperties(prefix ="library")@Setter@Getter@{privateString location;privateList books;@Setter@Getter@ToStringstaticclassBook{        String name;        String description;    }}

這個時候你就可以像使用普通 bean 一樣,將其注入到類中使用:

packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;/** *@authorshuang.kou */@ntsInitializingBean{privatefinalLibraryProperties library;(LibraryProperties library){this.library = library;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(library.getLocation());        System.out.println(library.getBooks());    }}

控制台輸出:

湖北武漢加油中國加油[LibraryProperties.Book(name=天才基本法, description........]

3.通過@ConfigurationProperties讀取並校驗

我們先將application.yml修改為如下內容,明顯看出這不是一個正確的 email 格式:

my-profile:name: Guide哥email: koushuangbwcx@

ProfileProperties 類沒有加 @Component 註解。我們在我們要使用ProfileProperties 的地方使用@

EnableConfigurationProperties注冊我們的配置 bean:

importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.stereotype.Component;importorg.springframework.validation.annotation.Validated;importjavax.validation.constraints.Email;importjavax.validation.constraints.NotEmpty;/***@authorshuang.kou*/@Getter@Setter@ToString@ConfigurationProperties("my-profile")@{@NotEmptyprivateString name;@Email@NotEmptyprivateString email;//配置文件中沒有讀取到的話就用默認值privateBooleanhandsome =Boolean.TRUE;}

具體使用:

packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.boot.context.properties.EnableConfigurationProperties;/** *@authorshuang.kou */@SpringBootApplication@EnableConfigurationProperties(ProfileProperties.class){privatefinalProfileProperties profileProperties;(ProfileProperties profileProperties){this.profileProperties = profileProperties;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(profileProperties.toString());    }}

因為我們的郵箱格式不正確,所以程序運行的時候就報錯,根本運行不起來,保證了數據類型的安全性:

Binding to target org.springframework.boot.context.properties.bind.BindException:Failedtobindpropertiesunder'my-profile'to cn.javaguide.readconfigproperties.ProfileProperties failed:Property:my-profile.emailValue:koushuangbwcx@Origin:classpathresource[application.yml]:5:10Reason:mustbeawell-formedemailaddress

我們把郵箱測試改為正確的之後再運行,控制台就能成功列印出讀取到的信息:

ProfileProperties(name=Guide哥, [email protected], handsome=true)

4.@PropertySource讀取指定 properties 文件

importlombok.Getter;importlombok.Setter;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.PropertySource;importorg.springframework.stereotype.Component;@Component@PropertySource("classpath:website.properties")@Getter@SetterclassWebSite{@Value("${url}")privateString url;}

使用:

@Autowiredprivate WebSite webSite;System.out.println(webSite.getUrl());//https://javaguide.cn/

5.題外話:Spring 載入配置文件的優先順序

Spring 讀取配置文件也是有優先順序的,直接上圖:

原文鏈接:https://www.toutiao.com/a6791445278911103500/?log_from=7f5fb8f9b4b47_1640606437752

⑤ SpringBoot有幾種讀取配置的方式

常見的讀取配置的方式有三種:

第一、@Value註解,比較常用的一種方式。也支持與@propertySource註解何用,指定使用的配置文件

第二、@Configuration註解,讀取配置到類中,批量注入配置屬性

第三、Environment對象,獲取配置文件中所有的屬性的對象

如果你想掌握時下熱門微服務技術棧,跟上時代技術步伐,就去黑馬程序員官網視頻庫看免費視頻。

閱讀全文

與springboot能自動讀取配置文件相關的資料

熱點內容
ps下載完不是壓縮文件 瀏覽:362
電腦中的個人文件包括什麼 瀏覽:572
網路連接一般什麼密碼 瀏覽:199
java定時器quartz實例 瀏覽:259
稻殼excel文件太大怎麼弄 瀏覽:901
文件里的視頻如何保存到相冊 瀏覽:428
手機百度雲文件電腦 瀏覽:957
編程怎麼做到時鍾精準 瀏覽:912
錘子用過的壁紙在哪個文件里 瀏覽:468
qq網站安全性未知訪問不了怎麼辦 瀏覽:270
燕秀怎麼修改編程人名字 瀏覽:789
2012年天之眼導航升級 瀏覽:595
如何安裝視頻文件 瀏覽:315
紅米2A升級miui9 瀏覽:927
如何在表格中加入一行資料庫 瀏覽:421
dnf遠古二能升級85嗎 瀏覽:251
extjsbbar屬性 瀏覽:355
nodejs網頁 瀏覽:517
同城簡歷在哪個文件夾 瀏覽:661
mac上的文件總是出現未知錯誤代碼 瀏覽:374

友情鏈接