前言

Spring Boot使用“習(xí)慣優(yōu)于配置”（項(xiàng)目中存在大量的配置，此外還內(nèi)置了一個(gè)習(xí)慣性的配置，讓你無(wú)需手動(dòng)進(jìn)行配置）的理念讓你的項(xiàng)目快速運(yùn)行起來(lái)。所以，我們要想把Spring Boot玩的溜，就要懂得如何開(kāi)啟各個(gè)功能模塊的默認(rèn)配置，這就需要了解Spring Boot的配置文件application.properties。

正文

Spring Boot使用了一個(gè)全局的配置文件application.properties，放在src/main/resources目錄下或者類(lèi)路徑的/config下。Sping Boot的全局配置文件的作用是對(duì)一些默認(rèn)配置的配置值進(jìn)行修改。

接下來(lái)，讓我們一起來(lái)解開(kāi)配置文件的面紗。

注:如果你工程沒(méi)有這個(gè)application.properties，那就在src/main/java/resources目錄下新建一個(gè)。

自定義屬性

application.properties提供自定義屬性的支持，這樣我們就可以把一些常量配置在這里：

com.dudu.name="嘟嘟MD"
com.dudu.want="祝大家雞年大吉吧"

然后直接在要使用的地方通過(guò)注解@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;
    }
}

我們啟動(dòng)工程輸入http://localhost:8080 就可以看到打印了"嘟嘟MD祝大家雞年大吉吧"。

有時(shí)候?qū)傩蕴嗔?，一個(gè)個(gè)綁定到屬性字段上太累，官方提倡綁定一個(gè)對(duì)象的bean，這里我們建一個(gè)ConfigBean.java類(lèi)，頂部需要使用注解@ConfigurationProperties(prefix = "com.dudu")來(lái)指明使用哪個(gè)

@ConfigurationProperties(prefix = "com.dudu")
public class ConfigBean {
    private String name;
    private String want;

    // 省略getter和setter
}

這里配置完還需要在spring Boot入口類(lèi)加上@EnableConfigurationProperties并指明要加載哪個(gè)bean，如果不寫(xiě)ConfigBean.class，在bean類(lèi)那邊添加

@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中的各個(gè)參數(shù)之間也可以直接引用來(lái)使用，就像下面的設(shè)置：

com.dudu.name="嘟嘟MD"
com.dudu.want="祝大家雞年大吉吧"
com.dudu.yearhope=${com.dudu.name}在此${com.dudu.want}

這樣我們就可以只是用yearhope這個(gè)屬性就好

使用自定義配置文件

有時(shí)候我們不希望把所有配置都放在application.properties里面，這時(shí)候我們可以另外定義一個(gè)，這里我明取名為test.properties,路徑跟也放在src/main/resources下面。

com.md.name="喲西~"
com.md.want="祝大家雞年,大吉吧"

我們新建一個(gè)bean類(lèi),如下：

@Configuration
@ConfigurationProperties(prefix = "com.md") 
@PropertySource("classpath:test.properties")
public class ConfigTestBean {
    private String name;
    private String want;
    // 省略getter和setter
}

這里要注意哦，有一個(gè)問(wèn)題，如果你使用的是1.5以前的版本，那么可以通過(guò)locations指定properties文件的位置，這樣：

@ConfigurationProperties(prefix = "com.md",locations="classpath:test.properties")
但是1.5版本后就沒(méi)有這個(gè)屬性了，找了半天發(fā)現(xiàn)添加@Configuration和@PropertySource("classpath:test.properties")后才可以讀取。

隨機(jī)值配置

配置文件中${random} 可以用來(lái)生成各種不同類(lèi)型的隨機(jī)值，從而簡(jiǎn)化了代碼生成的麻煩，例如 生成 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包運(yùn)行的，打成jar包的程序可以直接通過(guò)下面命令運(yùn)行：

java -jar xx.jar

可以以下命令修改tomcat端口號(hào)：

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

可以看出，命令行中連續(xù)的兩個(gè)減號(hào)--就是對(duì)application.properties中的屬性值進(jìn)行賦值的標(biāo)識(shí)。
所以java -jar xx.jar --server.port=9090等價(jià)于在application.properties中添加屬性server.port=9090。
如果你怕命令行有風(fēng)險(xiǎn)，可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

實(shí)際上，Spring Boot應(yīng)用程序有多種設(shè)置途徑，Spring Boot能從多重屬性源獲得屬性，包括如下幾種：

• 根目錄下的開(kāi)發(fā)工具全局設(shè)置屬性(當(dāng)開(kāi)發(fā)工具激活時(shí)為~/.spring-boot-devtools.properties)。
• 測(cè)試中的@TestPropertySource注解。
• 測(cè)試中的@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)境變量
• 隨機(jī)生成的帶random.* 前綴的屬性（在設(shè)置其他屬性時(shí)，可以應(yīng)用他們，比如${random.long}）
• 應(yīng)用程序以外的application.properties或者appliaction.yml文件
• 打包在應(yīng)用程序內(nèi)的application.properties或者appliaction.yml文件
• 通過(guò)@PropertySource標(biāo)注的屬性源
• 默認(rèn)屬性(通過(guò)SpringApplication.setDefaultProperties指定).

這里列表按組優(yōu)先級(jí)排序，也就是說(shuō)，任何在高優(yōu)先級(jí)屬性源里設(shè)置的屬性都會(huì)覆蓋低優(yōu)先級(jí)的相同屬性，列如我們上面提到的命令行屬性就覆蓋了application.properties的屬性。

配置文件的優(yōu)先級(jí)

application.properties和application.yml文件可以放在一下四個(gè)位置：

• 外置，在相對(duì)于應(yīng)用程序運(yùn)行目錄的/congfig子目錄里。
• 外置，在應(yīng)用程序運(yùn)行的目錄里
• 內(nèi)置，在config包內(nèi)
• 內(nèi)置，在Classpath根目錄

同樣，這個(gè)列表按照優(yōu)先級(jí)排序，也就是說(shuō)，src/main/resources/config下application.properties覆蓋src/main/resources下application.properties中相同的屬性，如圖：

此外，如果你在相同優(yōu)先級(jí)位置同時(shí)有application.properties和application.yml，那么application.yml里面的屬性就會(huì)覆蓋application.properties里的屬性。

Profile-多環(huán)境配置

當(dāng)應(yīng)用程序需要部署到不同運(yùn)行環(huán)境時(shí)，一些配置細(xì)節(jié)通常會(huì)有所不同，最簡(jiǎn)單的比如日志，生產(chǎn)日志會(huì)將日志級(jí)別設(shè)置為WARN或更高級(jí)別，并將日志寫(xiě)入日志文件，而開(kāi)發(fā)的時(shí)候需要日志級(jí)別為DEBUG，日志輸出到控制臺(tái)即可。
如果按照以前的做法，就是每次發(fā)布的時(shí)候替換掉配置文件，這樣太麻煩了，Spring Boot的Profile就給我們提供了解決方案，命令帶上參數(shù)就搞定。

這里我們來(lái)模擬一下，只是簡(jiǎn)單的修改端口來(lái)測(cè)試

在Spring Boot中多環(huán)境配置文件名需要滿(mǎn)足application-{profile}.properties的格式，其中{profile}對(duì)應(yīng)你的環(huán)境標(biāo)識(shí)，比如：

• application-dev.properties：開(kāi)發(fā)環(huán)境
• application-prod.properties：生產(chǎn)環(huán)境

想要使用對(duì)應(yīng)的環(huán)境，只需要在application.properties中使用spring.profiles.active屬性來(lái)設(shè)置，值對(duì)應(yīng)上面提到的{profile}，這里就是指dev、prod這2個(gè)。
當(dāng)然你也可以用命令行啟動(dòng)的時(shí)候帶上參數(shù)：

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

我給不同的環(huán)境添加不同的端口屬性server.port，然后根據(jù)指定不同的spring.profiles.active來(lái)切換使用。各位可以自己試試。這里就不貼代碼了。

除了可以用profile的配置文件來(lái)分區(qū)配置我們的環(huán)境變量，在代碼里，我們還可以直接用@Profile注解來(lái)進(jìn)行配置，例如數(shù)據(jù)庫(kù)配置，這里我們先定義一個(gè)接口

public  interface DBConnector { public  void  configure(); }

分別定義倆個(gè)實(shí)現(xiàn)類(lèi)來(lái)實(shí)現(xiàn)它

/**
  * 測(cè)試數(shù)據(jù)庫(kù)
  */
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("testdb");
    }
}
/**
 * 生產(chǎn)數(shù)據(jù)庫(kù)
 */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("devdb");
    }
}

通過(guò)在配置文件激活具體使用哪個(gè)實(shí)現(xiàn)類(lèi)

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來(lái)激活一個(gè)或者多個(gè)profile之外，還可以用spring.profiles.include來(lái)疊加profile

spring.profiles.active: testdb  
spring.profiles.include: proddb,prodmq

總結(jié)

這次對(duì)Spring Boot中application.properties配置文件做的整理總結(jié)希望對(duì)大家有所幫助，最后貼上Spring Boot中常用的配置屬性，需要的時(shí)候可打開(kāi)查找。

到此這篇關(guān)于深入理解springboot中配置文件application.properties 的文章就介紹到這了,更多相關(guān)springboot application.properties 內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論