深入理解springboot中配置文件application.properties

前言

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 = “com.md”,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.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中常用的配置屬性，需要的時候可打開查找。

到此這篇關於深入理解springboot中配置文件application.properties 的文章就介紹到這瞭,更多相關springboot application.properties 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：

• SpringBoot框架配置文件路徑設置方式
• 解決spring-boot 打成jar包後 啟動時指定參數無效的問題
• 教你在SpringBoot中管理多環境配置文件
• 使用java -jar修改SpringBoot中application.properties的配置項
• Maven的porfile與SpringBoot的profile結合使用案例詳解