前言
Spring Boot使用習慣優於配置
(項目中存在大量的配置,此外還內置了一個習慣性的配置,讓你無需手動進行配置)的理念讓你的項目快速運行起來。
正文
使用配置文件注入屬性
Spring Boot 默認的配置文件src/main/java/resources/application.properties
或者src/main/java/resources/application.yml
,在這裏我們可以配置一些常量。
首先我們使用配置文件給一個類注入相關的屬性:
com.wuwii.controller.pet.no=${random.uuid}
com.wuwii.controller.pet.name=Tom
通過註解@Value(value=”${config.name}”)
就可以綁定到你想要的屬性上面。
@RestController
@RequestMapping("/pet")
public class PetController {
@Value("${com.wuwii.controller.pet.no}")
private String no;
@Value("${com.wuwii.controller.pet.name}")
private String name;
@RequestMapping("/d")
public String detail() {
return "no: " + no + ", name: " + name;
}
}
啓動
一個個綁定數據還是很不方便,可以新建一個Bean,專門用來綁定注入的屬性使用註解@ConfigurationProperties(prefix = “prefix”),不過需要注意的是先要引入相關依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
通過使用spring-boot-configuration-processor jar, 你可以從被@ConfigurationProperties註解的節點輕鬆的產生自己的配置元數據文件。
這裏我新建一個PetBean用來注入屬性。
@ConfigurationProperties(prefix = "com.wuwii.controller.pet")
public class PetBean {
private String no;
private String name;
public String getNo() {
return no;
}
public void setNo(String no) {
this.no = no;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
注意在啓動類上加上註解
@EnableConfigurationProperties({PetBean.class}),
根據字面意思不難理解,就是開啓配置屬性。
新建一個controller,注入我們創建的PetBean,
@RestController
@RequestMapping("/v2/pet")
public class PetController1 {
@Autowired
private PetBean pet;
@RequestMapping("/d")
public String detail() {
return "no: " + pet.getNo() + ", name: " + pet.getName();
}
}
重啓Spring Boot,訪問新地址:
使用自定義的配置文件
我們在resouce目錄下面創建一個bean/pet.properties
,加入
com.wuwii.name=Tom
com.wuwii.no=123456
新建一個PetBean1.java:
@PropertySource
這個註解可以指定具體的屬性配置文件,優先級比較低。
@Configuration
@ConfigurationProperties(prefix = "com.wuwii")
@PropertySource("classpath:bean/pet.properties")
public class PetBean1 {
private String no;
private String name;
public String getNo() {
return no;
}
public void setNo(String no) {
this.no = no;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
在controller中加入PetBean1的注入
@Autowired
private PetBean1 pet1;
@RequestMapping("/d2")
public String detail2() {
return "no: " + pet1.getNo() + ", name: " + pet1.getName();
}
應用配置文件(.properties或.yml)
在配置文件中直接寫:
server.port=8080
.yml
格式的配置文件如:
server:
port: 8080
tips: .yml中冒號後面一定要加一個空格。
隨機數
配置文件中${random} 可以用來生成各種不同類型的隨機值,
my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.number.less.than.ten=${random.int(10)}
my.number.in.range=${random.int[1024,65536]}
屬性佔位符
app.name=MyApp
app.description=${app.name} is a Spring Boot application
可以在配置文件中引用前面配置過的屬性(優先級前面配置過的這裏都能用)。
通過如${app.name:默認名稱}方法還可以設置默認值,當找不到引用的屬性時,會使用默認的屬性。
屬性名匹配規則
例如有如下配置對象:
@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {
private String firstName;
}
firstName
可以使用的屬性名如下:
* person.firstName
,標準的駝峯式命名
* person.first-name
,虛線(-)分割方式,推薦在.properties和.yml配置文件中使用
* PERSON_FIRST_NAME
,大寫下劃線形式,建議在系統環境變量中使用
屬性驗證
可以使用JSR-303
註解進行驗證,例如:
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}
配置文件的優先級
Spring Boot 支持多種外部配置方式,這些方式優先級如下:
1. 命令行參數
2. 來自java:comp/env
的JNDI屬性
3. Java系統屬性(System.getProperties()
)
4. 操作系統環境變量
5. RandomValuePropertySource配置的random.*
屬性值
6. jar包外部的application-{profile}.properties
或application.yml(帶spring.profile)
配置文件
7. jar包內部的application-{profile}.properties
或application.yml(帶spring.profile)
配置文件
8. jar包外部的application.properties
或application.yml(不帶spring.profile)
配置文件
9. jar包內部的application.properties
或application.yml(不帶spring.profile)
配置文件
10. @Configuration
註解類上的@PropertySource
11. 通過SpringApplication.setDefaultProperties
指定的默認屬性
同樣,這個列表按照優先級排序,也就是說,src/main/resources/config下application.properties覆蓋src/main/resources下application.properties中相同的屬性,此外,如果你在相同優先級位置同時有application.properties和application.yml,那麼application.properties裏的屬性裏面的屬性就會覆蓋application.yml。
Profile-多環境配置
當應用程序需要部署到不同運行環境時,一些配置細節通常會有所不同,最簡單的比如日誌,生產日誌會將日誌級別設置爲WARN或更高級別,並將日誌寫入日誌文件,而開發的時候需要日誌級別爲DEBUG,日誌輸出到控制檯即可。
如果按照以前的做法,就是每次發佈的時候替換掉配置文件,這樣太麻煩了,Spring Boot的Profile就給我們提供瞭解決方案,命令帶上參數就搞定。
這裏我們來模擬一下,只是簡單的修改端口來測試
在Spring Boot中多環境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應你的環境標識,比如:
- application-dev.properties:開發環境
- application-prod.properties:生產環境
然後在application.properties中加入
spring.profiles.active=dev
或application.yml中加入
spring:
# 環境 dev|test|pro
profiles:
active: dev
或啓動命令:
java -jar xxx.jar --spring.profiles.active=dev
參數用–xxx=xxx的形式傳遞。意思就是表示在application.properties文件中配置了屬性。
可以通過SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。
附:Appendix A. Common application properties
Appendix A. Common application properties
參考文章
- 《SpringBoot揭祕 快速構建微服務體系》
- Spring Boot乾貨系列:(二)配置文件解析
- spring boot 讀取配置文件(application.yml)中的屬性值