深入理解Spring Boot屬性配置文件
前言
相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強大功能,還能實現快速開發(fā)的便捷。我們在Spring Boot使用過程中,最直觀的感受就是沒有了原來自己整合Spring應用時繁多的XML配置內容,替代它的是在pom.xml
中引入模塊化的Starter POMs
,其中各個模塊都有自己的默認配置,所以如果不是特殊應用場景,就只需要在application.properties
中完成一些屬性配置就能開啟各模塊的應用。
在之前的各篇文章中都有提及關于application.properties
的使用,主要用來配置數據庫連接、日志相關配置等。除了這些配置內容之外,本文將具體介紹一些在application.properties
配置中的其他特性和使用方法。
自定義屬性與加載
我們在使用Spring Boot的時候,通常也需要定義一些自己使用的屬性,我們可以如下方式直接定義:
com.didispace.blog.name=程序猿DD com.didispace.blog.title=Spring Boot教程
然后通過@Value("${屬性名}")
注解來加載對應的配置屬性,具體如下:
@Component public class BlogProperties { @Value("${com.didispace.blog.name}") private String name; @Value("${com.didispace.blog.title}") private String title; // 省略getter和setter }
按照慣例,通過單元測試來驗證BlogProperties中的屬性是否已經根據配置文件加載了。
@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(Application.class) public class ApplicationTests { @Autowired private BlogProperties blogProperties; @Test public void getHello() throws Exception { Assert.assertEquals(blogProperties.getName(), "程序猿DD"); Assert.assertEquals(blogProperties.getTitle(), "Spring Boot教程"); } }
參數間的引用
在application.properties
中的各個參數之間也可以直接引用來使用,就像下面的設置:
com.didispace.blog.name=程序猿DD com.didispace.blog.title=Spring Boot教程 com.didispace.blog.desc=${com.didispace.blog.name}正在努力寫《${com.didispace.blog.title}》
com.didispace.blog.desc
參數引用了上文中定義的name
和title
屬性,最后該屬性的值就是程序猿DD正在努力寫《Spring Boot教程》
。
使用隨機數
在一些情況下,有些參數我們需要希望它不是一個固定的值,比如密鑰、服務端口等。Spring Boot的屬性配置文件中可以通過${random}
來產生int值、long值或者string字符串,來支持屬性的隨機值。
# 隨機字符串 com.didispace.blog.value=${random.value} # 隨機int com.didispace.blog.number=${random.int} # 隨機long com.didispace.blog.bignumber=${random.long} # 10以內的隨機數 com.didispace.blog.test1=${random.int(10)} # 10-20的隨機數 com.didispace.blog.test2=${random.int[10,20]}
通過命令行設置屬性值
相信使用過一段時間Spring Boot的用戶,一定知道這條命令:java -jar xxx.jar --server.port=8888
,通過使用–server.port
屬性來設置xxx.jar應用的端口為8888。
在命令行運行時,連續(xù)的兩個減號--就是對application.properties
中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888
命令,等價于我們在application.properties
中添加屬性server.port=8888
,該設置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設置該值來驗證。
通過命令行來修改屬性值固然提供了不錯的便利性,但是通過命令行就能更改應用運行的參數,那豈不是很不安全?是的,所以Spring Boot也貼心的提供了屏蔽命令行訪問屬性的設置,只需要這句設置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)
。
多環(huán)境配置
我們在開發(fā)Spring Boot應用時,通常同一套程序會被應用和安裝到幾個不同的環(huán)境,比如:開發(fā)、測試、生產等。其中每個環(huán)境的數據庫地址、服務器端口等等配置都會不同,如果在為不同環(huán)境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發(fā)生錯誤的事。
對于多環(huán)境的配置,各種項目構建工具或是框架的基本思路是一致的,通過配置多份不同環(huán)境的配置文件,再通過打包命令指定需要打包的內容之后進行區(qū)分打包,Spring Boot也不例外,或者說更加簡單。
在Spring Boot中多環(huán)境配置文件名需要滿足application-{profile}.properties
的格式,其中{profile}
對應你的環(huán)境標識,比如:
application-dev.properties
:開發(fā)環(huán)境application-test.properties
:測試環(huán)境application-prod.properties
:生產環(huán)境
至于哪個具體的配置文件會被加載,需要在application.properties
文件中通過spring.profiles.active
屬性來設置,其值對應{profile}
值。
如:spring.profiles.active=test
就會加載application-test.properties配置文件內容
下面,以不同環(huán)境配置不同的服務端口為例,進行樣例實驗。
- 針對各環(huán)境新建不同的配置文件
application-dev.properties
、application-test.properties
、application-prod.properties
- 在這三個文件均都設置不同的
server.port
屬性,如:dev環(huán)境設置為1111,test環(huán)境設置為2222,prod環(huán)境設置為3333 application.properties
中設置spring.profiles.active=dev
,就是說默認以dev環(huán)境設置- 測試不同配置的加載
執(zhí)行java -jar xxx.jar
,可以觀察到服務端口被設置為1111,也就是默認的開發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test
,可以觀察到服務端口被設置為2222,也就是測試環(huán)境的配置(test)
執(zhí)行java -jar xxx.jar --spring.profiles.active=prod
,可以觀察到服務端口被設置為3333,也就是生產環(huán)境的配置(prod)
按照上面的實驗,可以如下總結多環(huán)境的配置思路:
application.properties
中配置通用內容,并設置spring.profiles.active=dev
,以開發(fā)環(huán)境為默認配置application-{profile}.properties
中配置各個環(huán)境不同的內容- 通過命令行方式去激活不同環(huán)境的配置
示例代碼:chapter2-1-1
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作能帶來一定的幫助,如果有疑問大家可以留言交流。
相關文章
SpringBoot配置logback.xml 多環(huán)境的操作步驟
最近在研究springboot的日志,所以記錄一下,做一下總結,今天重點給大家介紹SpringBoot配置logback.xml 多環(huán)境的操作步驟,要實現多環(huán)境的配置,主要是依賴于springboot的application.yml文件去實現,感興趣的朋友跟隨小編一起看看吧2021-05-05Springboot+Spring Security實現前后端分離登錄認證及權限控制的示例代碼
本文主要介紹了Springboot+Spring Security實現前后端分離登錄認證及權限控制的示例代碼,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-11-11Spring Boot中的@ConfigurationProperties注解解讀
在SpringBoot框架中,@ConfigurationProperties注解是處理外部配置的強大工具,它允許開發(fā)者將配置文件中的屬性自動映射到Java類的字段上,實現配置的集中管理和類型安全,通過定義配置類并指定前綴,可以將配置文件中的屬性綁定到Java對象2024-10-10Spring + mybatis + mysql使用事物的幾種方法總結
這篇文章主要給大家總結介紹了關于Spring + mybatis + mysql使用事物的幾種方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2018-05-05