Spring Boot乾貨系列：（二）配置檔案解析 | 掘金技術徵文

嘟嘟MD發表於2019-02-24
Spring Boot

原本地址：Spring Boot乾貨系列：（二）配置檔案解析
部落格地址：tengj.top/

前言

上一篇介紹了Spring Boot的入門，知道了Spring Boot使用“習慣優於配置”（專案中存在大量的配置，此外還內建了一個習慣性的配置，讓你無需手動進行配置）的理念讓你的專案快速執行起來。所以，我們要想把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祝大家雞年大吉吧”。

有時候屬性太多了，一個個繫結到屬性欄位上太累，官方提倡繫結一個物件的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中相同的屬性，如圖：

Spring Boot乾貨系列：（二）配置檔案解析 | 掘金技術徵文

此外，如果你在相同優先順序位置同時有application.properties和application.yml，那麼application.yml裡面的屬性就會覆蓋application.properties裡的屬性。

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中常用的配置屬性，需要的時候可開啟查詢。
(￣︶￣)↗Spring Boot乾貨系列：常用應用程式屬性
想要檢視更多Spring Boot乾貨教程,可前往：Spring Boot乾貨系列總綱

參考

Spring Boot屬性配置檔案詳解
spring boot 使用profile來分割槽配置
Spring Boot實戰
JavaEE開發的顛覆者Spring Boot實戰

原始碼下載

(￣︶￣)↗[相關示例完整程式碼]

一直覺得自己寫的不是技術，而是情懷，一篇篇文章是自己這一路走來的痕跡。靠專業技能的成功是最具可複製性的，希望我的這條路能讓你少走彎路，希望我能幫你抹去知識的蒙塵，希望我能幫你理清知識的脈絡，希望未來技術之巔上有你也有我,希望大爺你看完打賞點零花錢給我。

訂閱博主微信公眾號：嘟爺java超神學堂（javaLearn）三大好處：

  • 獲取最新博主部落格更新資訊，首發公眾號
  • 獲取大量視訊，電子書，精品破解軟體資源
  • 可以跟博主聊天，歡迎程式媛妹妹來撩我

我手裡有幾本Spring Boot的中文電子書資料，有需要的可以關注博主微信公眾號（點選頭像就能看博主公眾號），自行前往下載【開發工具->java電子書籍】

Spring Boot乾貨系列：（二）配置檔案解析 | 掘金技術徵文

掘金技術徵文第三期：聊聊你的最佳實踐

相關文章