java編程——Spring Boot乾貨系列：配置文件解析

前言

張星、以前在一線名企工做多年，級別P8, 是企業的核心技術開發人員，目前有十三年的開發經驗。從事於Java後端開發，對分佈式架構、spring微服務、MySQL、框架、Netty、JVM、性能優化、等技術都有較深的研究30K的薪資，有人說這隻能是大企業或者互聯網企業工程師才能拿到。是的，小公司或者非互聯網企業30K的不太多是碼農了。

正文

Spring Boot使用了一個全局的配置文件application.properties，放在src/main/resources目錄下或者類路徑的/config下。Sping Boot的全局配置文件的做用是對一些默認配置的配置值進行修改。

接下來，讓咱們一塊兒來解開配置文件的面紗。

注:若是你工程沒有這個application.properties，那就在src/main/java/resources目錄下新建一個。

自定義屬性

application.properties提供自定義屬性的支持，這樣咱們就能夠把一些常量配置在這裏：

1 com.dudu.name="嘟嘟MD"

2 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祝你們雞年大吉吧」。

有時候屬性太多了，一個個綁定到屬性字段上太累，官方提倡綁定一個對象的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();

}

}

參數間引用

在application.properties中的各個參數之間也能夠直接引用來使用，就像下面的設置：

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版本後就沒有這個屬性了，找了半天發現添加@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]}

外部配置-命令行參數配置

Spring Boot是基於jar包運行的，打成jar包的程序能夠直接經過下面命令運行：

java -jar xx.jar

能夠如下命令修改tomcat端口號：

java -jar xx.jar --server.port=9090

能夠看出，命令行中連續的兩個減號--就是對application.properties中的屬性值進行賦值的標識。

因此java -jar xx.jar --server.port=9090等價於在application.properties中添加屬性server.port=9090。

若是你怕命令行有風險，可使用SpringApplication.setAddCommandLineProperties(false)禁用它。

實際上，Spring Boot應用程序有多種設置途徑，Spring Boot能從多重屬性源得到屬性，包括以下幾種：

• 根目錄下的開發工具全局設置屬性(當開發工具激活時爲~/.spring-boot-devtools.properties)。
• 測試中的@TestPropertySource註解。
• 測試中的@SpringBootTest#properties註解特性。
• 命令行參數
• SPRING_APPLICATION_JSON中的屬性(環境變量或系統屬性中的內聯JSON嵌入)。
• ServletConfig初始化參數。
• ServletContext初始化參數。
• java:comp/env裏的JNDI屬性
• JVM系統屬性
• 操做系統環境變量
• 隨機生成的帶random.* 前綴的屬性（在設置其餘屬性時，能夠應用他們，好比${random.long}）
• 應用程序之外的application.properties或者appliaction.yml文件
• 打包在應用程序內的application.properties或者appliaction.yml文件
• 經過@PropertySource標註的屬性源
• 默認屬性(經過SpringApplication.setDefaultProperties指定).

這裏列表按組優先級排序，也就是說，任何在高優先級屬性源裏設置的屬性都會覆蓋低優先級的相同屬性，列如咱們上面提到的命令行屬性就覆蓋了application.properties的屬性。

配置文件的優先級

application.properties和application.yml文件能夠放在如下四個位置：

• 外置，在相對於應用程序運行目錄的/congfig子目錄裏。
• 外置，在應用程序運行的目錄裏
• 內置，在config包內
• 內置，在Classpath根目錄

一樣，這個列表按照優先級排序，也就是說，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屬性來設置，值對應上面提到的{profile}，這裏就是指dev、prod這2個。

固然你也能夠用命令行啓動的時候帶上參數：

java -jar xxx.jar --spring.profiles.active=dev

我給不一樣的環境添加不一樣的端口屬性server.port，而後根據指定不一樣的spring.profiles.active來切換使用。各位能夠本身試試。這裏就不貼代碼了。

除了能夠用profile的配置文件來分區配置咱們的環境變量，在代碼裏，咱們還能夠直接用@Profile註解來進行配置，例如數據庫配置，這裏咱們先定義一個接口

public interface DBConnector { public void configure(); }

分別定義倆個實現類來實現它

/**

* 測試數據庫

*/

@Component

@Profile("testdb")

public class TestDBConnector implements DBConnector {

@Override

public void configure() {

System.out.println("testdb");

}

}

/**

* 生產數據庫

*/

@Component

@Profile("devdb")

public class DevDBConnector implements DBConnector {

@Override

public void configure() {

System.out.println("devdb");

}

}

經過在配置文件激活具體使用哪一個實現類

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

總結

此次對Spring Boot中application.properties配置文件作的整理總結但願對你們有所幫助，最後貼上Spring Boot中經常使用的配置屬性，須要的時候可打開查找。