前言
上一篇介紹了Spring Boot的入門眯牧,知道了Spring Boot使用“習慣優(yōu)于配置”(項目中存在大量的配置好乐,此外還內(nèi)置了一個習慣性的配置瘾蛋,讓你無需手動進行配置)的理念讓你的項目快速運行起來搁拙。所以掺炭,我們要想把Spring Boot玩的溜辫诅,就要懂得如何開啟各個功能模塊的默認配置,這就需要了解Spring Boot的配置文件application.properties涧狮。
正文
Spring Boot使用了一個全局的配置文件application.properties炕矮,放在src/main/resources目錄下或者類路徑的/config下。Sping Boot的全局配置文件的作用是對一些默認配置的配置值進行修改者冤。
接下來肤视,讓我們一起來解開配置文件的面紗。
注:如果你工程沒有這個application.properties涉枫,那就在src/main/java/resources目錄下新建一個邢滑。
自定義屬性
application.properties提供自定義屬性的支持,這樣我們就可以把一些常量配置在這里:
com.dudu.name="嘟嘟MD"
com.dudu.want="祝大家雞年大吉吧"
然后直接在要使用的地方通過注解@Value(value="${config.name}")就可以綁定到你想要的屬性上面
@RestController
public class UserController {
@Value("${com.dudu.name}")
private String name;
@Value("${com.dudu.want}")
private String want;
@RequestMapping("/")
public String hexo(){
return name+","+want;
}
}
我們啟動工程輸入http://localhost:8080 就可以看到打印了"嘟嘟MD祝大家雞年大吉吧"愿汰。
有時候?qū)傩蕴嗔死Ш螅粋€個綁定到屬性字段上太累乐纸,官方提倡綁定一個對象的bean,這里我們建一個ConfigBean.java類摇予,頂部需要使用注解@ConfigurationProperties(prefix = "com.dudu")來指明使用哪個
@ConfigurationProperties(prefix = "com.dudu")
public class ConfigBean {
private String name;
private String want;
// 省略getter和setter
}
這里配置完還需要在spring Boot入口類加上@EnableConfigurationProperties并指明要加載哪個bean锯仪,如果不寫ConfigBean.class,在bean類那邊添加
@SpringBootApplication
@EnableConfigurationProperties({ConfigBean.class})
public class Chapter2Application {
public static void main(String[] args) {
SpringApplication.run(Chapter2Application.class, args);
}
}
最后在Controller中引入ConfigBean使用即可趾盐,如下:
@RestController
public class UserController {
@Autowired
ConfigBean configBean;
@RequestMapping("/")
public String hexo(){
return configBean.getName()+configBean.getWant();
}
}
參數(shù)間引用
在application.properties中的各個參數(shù)之間也可以直接引用來使用庶喜,就像下面的設置:
com.dudu.name="嘟嘟MD"
com.dudu.want="祝大家雞年大吉吧"
com.dudu.yearhope=${com.dudu.name}在此${com.dudu.want}
這樣我們就可以只是用yearhope這個屬性就好
使用自定義配置文件
有時候我們不希望把所有配置都放在application.properties里面,這時候我們可以另外定義一個救鲤,這里我明取名為test.properties,路徑跟也放在src/main/resources下面久窟。
com.md.name="喲西~"
com.md.want="祝大家雞年,大吉吧"
我們新建一個bean類,如下:
@Configuration
@ConfigurationProperties(prefix = "com.md")
@PropertySource("classpath:test.properties")
public class ConfigTestBean {
private String name;
private String want;
// 省略getter和setter
}
這里要注意哦,有一個問題本缠,如果你使用的是1.5以前的版本斥扛,那么可以通過locations指定properties文件的位置,這樣:
@ConfigurationProperties(prefix = "config2",locations="classpath:test.properties")
但是1.5版本后就沒有這個屬性了丹锹,找了半天發(fā)現(xiàn)添加@Configuration和@PropertySource("classpath:test.properties")后才可以讀取稀颁。
隨機值配置
配置文件中${random} 可以用來生成各種不同類型的隨機值,從而簡化了代碼生成的麻煩楣黍,例如 生成 int 值匾灶、long 值或者 string 字符串。
dudu.secret=${random.value}
dudu.number=${random.int}
dudu.bignumber=${random.long}
dudu.uuid=${random.uuid}
dudu.number.less.than.ten=${random.int(10)}
dudu.number.in.range=${random.int[1024,65536]}
外部配置-命令行參數(shù)配置
Spring Boot是基于jar包運行的租漂,打成jar包的程序可以直接通過下面命令運行:
java -jar xx.jar
可以以下命令修改tomcat端口號:
java -jar xx.jar --server.port=9090
可以看出阶女,命令行中連續(xù)的兩個減號--
就是對application.properties
中的屬性值進行賦值的標識。
所以java -jar xx.jar --server.port=9090
等價于在application.properties
中添加屬性server.port=9090
哩治。
如果你怕命令行有風險秃踩,可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。
實際上业筏,Spring Boot應用程序有多種設置途徑憔杨,Spring Boot能從多重屬性源獲得屬性,包括如下幾種:
- 根目錄下的開發(fā)工具全局設置屬性(當開發(fā)工具激活時為
~/.spring-boot-devtools.properties
)蒜胖。 - 測試中的@TestPropertySource注解消别。
- 測試中的@SpringBootTest#properties注解特性。
- 命令行參數(shù)
-
SPRING_APPLICATION_JSON
中的屬性(環(huán)境變量或系統(tǒng)屬性中的內(nèi)聯(lián)JSON嵌入)翠勉。 -
ServletConfig
初始化參數(shù)妖啥。 -
ServletContext
初始化參數(shù)霉颠。 - java:comp/env里的JNDI屬性
- JVM系統(tǒng)屬性
- 操作系統(tǒng)環(huán)境變量
- 隨機生成的帶random.* 前綴的屬性(在設置其他屬性時对碌,可以應用他們,比如${random.long})
- 應用程序以外的application.properties或者appliaction.yml文件
- 打包在應用程序內(nèi)的application.properties或者appliaction.yml文件
- 通過@PropertySource標注的屬性源
- 默認屬性(通過
SpringApplication.setDefaultProperties
指定).
這里列表按組優(yōu)先級排序蒿偎,也就是說朽们,任何在高優(yōu)先級屬性源里設置的屬性都會覆蓋低優(yōu)先級的相同屬性怀读,列如我們上面提到的命令行屬性就覆蓋了application.properties的屬性。
配置文件的優(yōu)先級
application.properties和application.yml文件可以放在一下四個位置:
- 外置骑脱,在相對于應用程序運行目錄的/congfig子目錄里菜枷。
- 外置,在應用程序運行的目錄里
- 內(nèi)置叁丧,在config包內(nèi)
- 內(nèi)置啤誊,在Classpath根目錄
同樣,這個列表按照優(yōu)先級排序拥娄,也就是說蚊锹,src/main/resources/config下application.properties覆蓋src/main/resources下application.properties中相同的屬性,如圖:
此外稚瘾,如果你在相同優(yōu)先級位置同時有application.properties和application.yml牡昆,那么application.yml里面的屬性就會覆蓋application.properties里的屬性。
Profile-多環(huán)境配置
當應用程序需要部署到不同運行環(huán)境時摊欠,一些配置細節(jié)通常會有所不同丢烘,最簡單的比如日志,生產(chǎn)日志會將日志級別設置為WARN或更高級別些椒,并將日志寫入日志文件播瞳,而開發(fā)的時候需要日志級別為DEBUG,日志輸出到控制臺即可免糕。
如果按照以前的做法狐史,就是每次發(fā)布的時候替換掉配置文件,這樣太麻煩了说墨,Spring Boot的Profile就給我們提供了解決方案骏全,命令帶上參數(shù)就搞定。
這里我們來模擬一下尼斧,只是簡單的修改端口來測試
在Spring Boot中多環(huán)境配置文件名需要滿足application-{profile}.properties
的格式姜贡,其中{profile}
對應你的環(huán)境標識,比如:
- application-dev.properties:開發(fā)環(huán)境
- application-prod.properties:生產(chǎn)環(huán)境
想要使用對應的環(huán)境棺棵,只需要在application.properties中使用spring.profiles.active屬性來設置楼咳,值對應上面提到的{profile},這里就是指dev烛恤、prod這2個母怜。
當然你也可以用命令行啟動的時候帶上參數(shù):
java -jar xxx.jar --spring.profiles.active=dev
我給不同的環(huán)境添加不同的端口屬性server.port,然后根據(jù)指定不同的spring.profiles.active來切換使用缚柏。各位可以自己試試苹熏。這里就不貼代碼了。
除了可以用profile的配置文件來分區(qū)配置我們的環(huán)境變量,在代碼里轨域,我們還可以直接用@Profile注解來進行配置袱耽,例如數(shù)據(jù)庫配置,這里我們先定義一個接口
public interface DBConnector { public void configure(); }
分別定義倆個實現(xiàn)類來實現(xiàn)它
/**
* 測試數(shù)據(jù)庫
*/
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
@Override
public void configure() {
System.out.println("testdb");
}
}
/**
* 生產(chǎn)數(shù)據(jù)庫
*/
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
@Override
public void configure() {
System.out.println("devdb");
}
}
通過在配置文件激活具體使用哪個實現(xiàn)類
spring.profiles.active=testdb
然后就可以這么用了
@RestController
@RequestMapping("/task")
public class TaskController {
@Autowired DBConnector connector ;
@RequestMapping(value = {"/",""})
public String hellTask(){
connector.configure(); //最終打印testdb
return "hello task !! myage is " + myage;
}
}
除了spring.profiles.active來激活一個或者多個profile之外干发,還可以用spring.profiles.include來疊加profile
spring.profiles.active: testdb
spring.profiles.include: proddb,prodmq
總結(jié)
這次對Spring Boot中application.properties配置文件做的整理總結(jié)希望對大家有所幫助朱巨,最后貼上Spring Boot中常用的配置屬性,需要的時候可打開查找枉长。
( ̄︶ ̄)↗Spring Boot干貨系列:常用應用程序?qū)傩?/a>
想要查看更多Spring Boot干貨教程,可前往:Spring Boot干貨系列總綱
參考
Spring Boot屬性配置文件詳解
spring boot 使用profile來分區(qū)配置
Spring Boot實戰(zhàn)
JavaEE開發(fā)的顛覆者Spring Boot實戰(zhàn)
源碼下載
( ̄︶ ̄)↗[相關(guān)示例完整代碼]
一直覺得自己寫的不是技術(shù)冀续,而是情懷,一篇篇文章是自己這一路走來的痕跡必峰×ぱ簦靠專業(yè)技能的成功是最具可復制性的,希望我的這條路能讓你少走彎路自点,希望我能幫你抹去知識的蒙塵桐罕,希望我能幫你理清知識的脈絡,希望未來技術(shù)之巔上有你也有我,希望大爺你看完打賞點零花錢給我桂敛。