第4章 零XML配置的Spring Boot Application

第4章 零XML配置的Spring Boot Application

Spring Boot 提供了一種統(tǒng)一的方式來(lái)管理應(yīng)用的配置，允許開(kāi)發(fā)人員使用屬性properties文件、YAML 文件、環(huán)境變量和命令行參數(shù)來(lái)定義優(yōu)先級(jí)不同的配置值。零XML配置的Spring Boot Application，是基于Spring JavaConfig。

application.properties配置文件使用

我們?cè)谏弦徽轮校J(rèn)的服務(wù)端口是8080，如果我們想自定義端口號(hào)，在SpringBoot中怎么搞?

OK，很簡(jiǎn)單。SpringBootApplication有個(gè)系統(tǒng)級(jí)的配置文件application.properties

我們只需要在里面加一行配置即可：

server.port=5678

啟動(dòng)應(yīng)用，你講看到：

2017-04-04 23:31:21.673  INFO 90250 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2017-04-04 23:31:21.774  INFO 90250 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 5678 (http)
2017-04-04 23:31:21.780  INFO 90250 --- [           main] com.example.DemoApplication              : Started DemoApplication in 4.712 seconds (JVM running for 5.511)

TomcatEmbeddedServletContainer已經(jīng)在5678端口監(jiān)聽(tīng)請(qǐng)求了。

瀏覽器訪問(wèn)：http://localhost:5678/hello
你會(huì)看到成功輸出：

Hello World! Tue Apr 04 23:32:38 CST 2017

application.properties是Spring Boot約定的配置文件。Spring Boot基于這個(gè)配置文件的配置機(jī)制充分體現(xiàn)了Spring Boot遵循的“約定優(yōu)于配置”的原則。

Spring Boot幾乎所有的配置項(xiàng)都可以在這個(gè)文件中配置，如果不配置，則使用默認(rèn)項(xiàng)。Spring Boot會(huì)檢測(cè)配置項(xiàng)的key，啟動(dòng)相應(yīng)的自動(dòng)配置模塊。

下面具體介紹一些在application.properties配置中的特性和使用方法。

1.數(shù)據(jù)源datasource配置

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

當(dāng)Spring Boot一旦檢測(cè)到數(shù)據(jù)庫(kù)配置相關(guān)的配置項(xiàng)（spring.datasoure.*），Spring Boot會(huì)自動(dòng)根據(jù)相應(yīng)的配置項(xiàng)，建立數(shù)據(jù)庫(kù)連接池。

這個(gè)application.properties里面到底有哪些key是可配置的呢？在SpringBoot官網(wǎng)文檔給出了詳盡的配置以及說(shuō)明。在Appendix A. Common application properties中： http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#common-application-properties

不完全統(tǒng)計(jì)，這個(gè)完整的application properties文件，有1183行。其中，屬性key有950個(gè)。當(dāng)你看到如此龐大的配置，你一定會(huì)被嚇到。不過(guò)，在實(shí)際項(xiàng)目中，我們?nèi)绻裱璖pring Boot的約定，通常不需要我們單獨(dú)指定太多配置。

雖然是零XML配置，但是“有些配置的事情”，還是必須要做的。這里SpringBoot的實(shí)現(xiàn)方案，充分體現(xiàn)了Spring框架的“約定優(yōu)于配置”理念。通過(guò)約定俗成的規(guī)范，很多問(wèn)題的解決講得到大大的簡(jiǎn)化。

2.在application.properties自定義屬性與加載

我們可以將自己自定義的屬性配置在application.properties中（注意不要和Spring Boot的默認(rèn)配置的key重復(fù)），然后在java類(lèi)中通過(guò)@Value("${屬性名}")注解來(lái)加載對(duì)應(yīng)的配置屬性，例如：application.properties文件中有如下自定義配置項(xiàng)：

com.easy.springboot.h5perf.app.name = H5性能測(cè)試平臺(tái)

則在java中有如下應(yīng)用：

@Component
public class TestProperties {

    @Value("${com.easy.springboot.h5perf.app.name }")
    private String appName;
}

3.配置項(xiàng)值的引用

在application.properties中的各個(gè)參數(shù)之間可以直接通過(guò)“${keyname}”引用來(lái)使用。

在application.properties中也可以通過(guò)“@keyname@”來(lái)引用pom文件中的元素節(jié)點(diǎn)值，例如：

pom文件中有如下定義：

<properties>
    <project.name >easy-springboot-demo </ project.name >
    <project.version>1.0</ project.version >
</properties>

則在application.properties文件中可以通過(guò)如下方式引用：

# 項(xiàng)目名稱
com.easy.springboot.project.name = @project.name@
# 項(xiàng)目版本
com.easy.springboot.project.version = @project.version@

4.隨機(jī)數(shù)屬性value

在一些情況下，有些參數(shù)我們需要希望它不是一個(gè)固定的值，Spring Boot的屬性配置文件中可以通過(guò)${random}來(lái)產(chǎn)生int值、long值或者string字符串，來(lái)支持屬性的隨機(jī)值。

例如：

# 隨機(jī)字符串
com.easy.springboot.string=${random.value} 
# 隨機(jī)int
com.easy.springboot.number=${random.int} 
# 隨機(jī)long
com.easy.springboot.bignumber=${random.long} 
# 100以內(nèi)的隨機(jī)數(shù)
com.easy.springboot.range1=${random.int(100)} 
# 100-200的隨機(jī)數(shù)
com.easy.springboot.range2=${random.int[100,200]}

屬性配置文件的位置

spring會(huì)從classpath下的/config目錄或者classpath的根目錄查找application.properties或application.yml。

/config優(yōu)先于classpath根目錄。

Spring Boot 配置的管理

一般在一個(gè)項(xiàng)目中，總是會(huì)有好多個(gè)環(huán)境。比如：

開(kāi)發(fā)環(huán)境 -> 測(cè)試環(huán)境 -> 預(yù)發(fā)布環(huán)境 -> 生產(chǎn)環(huán)境

在應(yīng)用中管理配置是一個(gè)重要的問(wèn)題，尤其是在應(yīng)用需要部署到多個(gè)環(huán)境中時(shí)。通常會(huì)需要為每個(gè)環(huán)境提供一個(gè)對(duì)應(yīng)的屬性文件，用來(lái)配置各自的數(shù)據(jù)庫(kù)連接信息、服務(wù)器信息和第三方服務(wù)賬號(hào)等。通常的應(yīng)用部署會(huì)包含開(kāi)發(fā)、測(cè)試和生產(chǎn)等若干個(gè)環(huán)境。

常規(guī)情況下，我們都知道Spring Boot的配置會(huì)從application.properties中讀取。實(shí)際上，從resource目錄下的application.properties文件讀取是Spring Boot配置鏈中的一環(huán)而已。

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

Spring Boot提供了一種優(yōu)先級(jí)配置讀取的機(jī)制來(lái)幫助我們從這種困境中走出來(lái)。

Spring Boot 所提供的配置優(yōu)先級(jí)順序比較復(fù)雜。按照優(yōu)先級(jí)從高到低的順序，具體的列表（從高到低）如下所示。

1.命令行參數(shù)（優(yōu)先級(jí)最高）。
2.通過(guò) System.getProperties() 獲取的 Java 系統(tǒng)參數(shù)。
3.操作系統(tǒng)環(huán)境變量。
4.從 java:comp/env 得到的 JNDI 屬性。
5.通過(guò) RandomValuePropertySource 生成的random.*屬性。
6.jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置文件，通過(guò)spring.config.location參數(shù)指定
7.jar包內(nèi)部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
8.jar包外部的application.properties或application.yml(不帶spring.profile)配置文件
9.jar包內(nèi)部的application.properties或application.yml(不帶spring.profile)配置文件
10.應(yīng)用 Java配置類(lèi)，包含@Configuration注解的 Java 類(lèi)，通過(guò)@PropertySource注解聲明的屬性文件。
11.通過(guò)SpringApplication.setDefaultProperties聲明的默認(rèn)屬性。

如果Spring Boot在優(yōu)先級(jí)更高的位置找到了配置，那么它就會(huì)忽略優(yōu)先級(jí)低的配置。下面我們簡(jiǎn)單講講這些優(yōu)先級(jí)。

命令行參數(shù)配置

Spring Boot 的這個(gè)配置優(yōu)先級(jí)看似復(fù)雜，其實(shí)是很合理的。命令行參數(shù)的優(yōu)先級(jí)之所以被設(shè)置為最高，是因?yàn)榭梢苑奖阄覀冊(cè)跍y(cè)試或生產(chǎn)環(huán)境中快速地修改配置參數(shù)值，而不需要重新打包和部署應(yīng)用。

SpringApplication 類(lèi)默認(rèn)會(huì)把以“--”開(kāi)頭的命令行參數(shù)轉(zhuǎn)化成應(yīng)用中可以使用的配置參數(shù)，如 “--name=Alex” 會(huì)設(shè)置配置參數(shù) “name” 的值為 “Alex”。

如果不需要這個(gè)功能，可以通過(guò)

SpringApplication.setAddCommandLineProperties(false)

禁用解析命令行參數(shù)。

random.*屬性

RandomValuePropertySource 可以用來(lái)生成測(cè)試所需要的各種不同類(lèi)型的隨機(jī)值，從而免去了在代碼中生成的麻煩。RandomValuePropertySource 可以生成數(shù)字和字符串。數(shù)字的類(lèi)型包含 int 和 long，可以限定數(shù)字的大小范圍。以“random.”作為前綴的配置屬性名稱由 RandomValuePropertySource 來(lái)生成，代碼示例：

user.id=${random.value}
user.count=${random.int}
user.max=${random.long}
user.number=${random.int(100)}
user.range=${random.int[100, 1000]}

屬性文件配置

屬性文件是最常見(jiàn)的管理配置屬性的方式。Spring Boot 提供的 SpringApplication 類(lèi)會(huì)搜索并加載 application.properties 文件來(lái)獲取配置屬性值。SpringApplication 類(lèi)會(huì)在下面位置搜索該文件：

1.當(dāng)前目錄的/config子目錄
2.當(dāng)前目錄
3.classpath 中的/config包
4.classpath

上面的順序也表示了該位置上包含的屬性文件的優(yōu)先級(jí)。優(yōu)先級(jí)按照從高到低的順序排列。

可以通過(guò)spring.config.name這個(gè)key的配置屬性來(lái)指定不同的屬性文件名稱。也可以通過(guò)spring.config.location來(lái)添加額外的屬性文件的搜索路徑。

對(duì)于配置屬性，可以在代碼中通過(guò)“@Value”來(lái)使用，例如

@RestController
@EnableAutoConfiguration
public class Application {
 @Value("${name}")
 private String name;
 @RequestMapping("/")
 String home() {
 return String.format("Hello %s!", name);
 }
}

其中，@Value("${name}")注解的意思就是，變量 name 的值來(lái)自配置屬性中的name屬性。

YAML格式的配置文件

相對(duì)于屬性文件來(lái)說(shuō)，YAML 是一個(gè)更好的配置文件格式。
當(dāng)有前綴的情況下，使用.yml格式的配置文件更簡(jiǎn)單。

注意：使用.yml時(shí)，屬性名的值和冒號(hào)中間必須有空格，如name: SpringBoot正確，SpringBoot就是錯(cuò)的。

YAML 在 Ruby on Rails 中得到了很好的應(yīng)用。YAML是JSON的一個(gè)超集，也是一種方便的定義層次配置數(shù)據(jù)的格式。它的基本語(yǔ)法規(guī)則如下：

大小寫(xiě)敏感
使用縮進(jìn)表示層級(jí)關(guān)系
縮進(jìn)時(shí)不允許使用Tab鍵，只允許使用空格。
縮進(jìn)的空格數(shù)目不重要，只要相同層級(jí)的元素左側(cè)對(duì)齊即可
# 表示注釋?zhuān)瑥倪@個(gè)字符一直到行尾，都會(huì)被解析器忽略。

只要你將SnakeYAML 庫(kù)放到classpath下，SpringApplication就會(huì)自動(dòng)支持YAML，以作為properties的替換。當(dāng)然，我們通常不需要這么做，因?yàn)槲覀円话愣紩?huì)使用Starters，在spring-boot-starter里會(huì)自動(dòng)加載SnakeYAML。

Spring框架提供兩個(gè)便利的類(lèi)用于加載YAML文檔，YamlPropertiesFactoryBean會(huì)將YAML加載為Properties，YamlMapFactoryBean會(huì)將YAML加載為Map。

Spring Boot使用application.properties默認(rèn)了很多配置。但需要自己添加一些配置的時(shí)候，我們應(yīng)該怎么做呢。

例如，下面這段yml格式的配置

environments:
    dev:
        url: http://dev.easy.springboot.com
        name: Easy Spring Boot

會(huì)轉(zhuǎn)化為：

environments.url=http://dev.easy.springboot.com
environments.name=Easy Spring Boot

如果我們自定義了屬性key，在代碼中怎樣使用上面的配置信息呢？利用Spring DataBinder工具集，Spring Boot通過(guò)注解@ConfigurationProperties 和@EnableConfigurationProperties 來(lái)完成這件事情。

在代碼中對(duì)應(yīng)的Bean對(duì)象：

@ConfigurationProperties(prefix="environments")
public class EnvironmentsConfig { 
    private String url; 
    private String name;
     
    public String getUrl(){ return this.url; }  
    public void setUrl(String url){ this.url = url; }  
    public String getName(){ return this.name; } 
    public void setName(){ this.name = name; } 

}

有些時(shí)候，我們還會(huì)配置類(lèi)似下面這樣的列表的屬性

my:
   servers:
       - dev1.easy.com
       - dev2.easy.com

會(huì)轉(zhuǎn)化為：

my.servers[0]=dev1.easy.com
my.servers[1]=dev2.easy.com

使用@ConfigurationProperties這個(gè)注解來(lái)實(shí)現(xiàn)屬性Bean的綁定，需要在Bean里面添加一個(gè)java.util.List(或者Set)類(lèi)型的屬性，然后寫(xiě)好setter（setter也可以換成初始化一個(gè)對(duì)象），getter：

@ConfigurationProperties(prefix="my")
public class ServersConfig {
    private List<String> servers = new ArrayList<String>();//initialize it with a mutable value， equals a setter
    public List<String> getServers() {
        return this.servers;
    }    

}

因?yàn)閅amlPropertySourceLoader類(lèi)能夠?qū)AML作為PropertySource導(dǎo)出到Spring Environment。所以我們可以使用常用的@Value注解配合占位符語(yǔ)法訪問(wèn)YAML屬性。

另外，當(dāng)我們使用@ConfigurationProperties注解定義配置的Bean時(shí)，需要在SpringBoot Application啟動(dòng)類(lèi)上標(biāo)注@EnableConfigurationProperties。

使用 Java配置類(lèi)

Spring 框架本身提供了多種的方式來(lái)管理配置屬性文件。Spring 3.1 之前可以使用 PropertyPlaceholderConfigurer。Spring 3.1 引入了新的環(huán)境（Environment）和概要信息（Profile）API，是一種更加靈活的處理不同環(huán)境和配置文件的方式。

Spring Profiles提供了一種隔離應(yīng)用程序配置的方式，并讓這些配置只在特定的環(huán)境下生效。任何@Component或@Configuration都能注解@Profile，從而限制加載它的環(huán)境：


@Configuration
@Profile("production")
public class ProductionConfiguration {

    // ...

}

指定的屬性方式常用的有2種：

1.配置在application.properties中：

spring.profiles.active=production

2.或使用命令行開(kāi)關(guān)：

--spring.profiles.active=production

如果應(yīng)用中包含多個(gè) profile，可以為每個(gè) profile 定義各自的屬性文件，按照application-{profile}.properties(.yml)來(lái)命名。

使用CommandLineRunner

實(shí)際應(yīng)用中，有時(shí)候我們?cè)陧?xiàng)目服務(wù)啟動(dòng)的時(shí)候就去加載一些數(shù)據(jù)或做一些事情這樣的需求。 以前比較常見(jiàn)的做法是寫(xiě)再static代碼塊中。

在Spring Boot中，它提供了一個(gè)CommandLineRunner接口，實(shí)現(xiàn)這個(gè)接口的類(lèi)總是會(huì)被優(yōu)先啟動(dòng)，并優(yōu)先執(zhí)行CommandLineRunner接口中提供的run()方法。例如

public class ApplicationConfigure implements CommandLineRunner { 
    @Override 
    public void run(String... strings) throws Exception {
        //TODO : 比如說(shuō)，在這里預(yù)先加載的一些方法，類(lèi)，屬性等。
    }
}

如果有多個(gè)CommandLineRunner接口實(shí)現(xiàn)類(lèi)，那么可以通過(guò)注解@Order
來(lái)規(guī)定所有實(shí)現(xiàn)類(lèi)的運(yùn)行順序。

小結(jié)

Spring Boot 它拋棄了Spring 中繁瑣的xml配置文件的方式，聲明式注解的方法為服務(wù)開(kāi)發(fā)提供快速簡(jiǎn)潔的配置方式。在Spring Boot 中，我們會(huì)發(fā)現(xiàn)，我們其實(shí)不用做一些基本的配置也能直接運(yùn)行剛創(chuàng)建好的工程項(xiàng)目，因?yàn)樗鼉?nèi)嵌了很多基本的通用的配置組件而不需要我們自己來(lái)做一些重復(fù)的配置工作。

Spring Boot讓環(huán)境配置變得輕松很多。

參考資料：
1.https://www.ibm.com/developerworks/cn/java/j-lo-spring-boot/index.html
2.http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#common-application-properties

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容