第4章 零XML配置的Spring Boot Application

Spring Boot 提供了一種統一的方式來管理應用的配置，允許開發人員使用屬性properties文件、YAML 文件、環境變量和命令行參數來定義優先級不同的配置值。零XML配置的Spring Boot Application，是基于Spring JavaConfig。

application.properties配置文件使用

我們在上一章中，默認的服務端口是8080，如果我們想自定義端口號，在SpringBoot中怎么搞?

OK，很簡單。SpringBootApplication有個系統級的配置文件application.properties

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

server.port=5678

啟動應用，你講看到：

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已經在5678端口監聽請求了。

瀏覽器訪問：http://localhost:5678/hello
你會看到成功輸出：

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

application.properties是Spring Boot約定的配置文件。Spring Boot基于這個配置文件的配置機制充分體現了Spring Boot遵循的“約定優于配置”的原則。

Spring Boot幾乎所有的配置項都可以在這個文件中配置，如果不配置，則使用默認項。Spring Boot會檢測配置項的key，啟動相應的自動配置模塊。

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

1.數據源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

當Spring Boot一旦檢測到數據庫配置相關的配置項（spring.datasoure.*），Spring Boot會自動根據相應的配置項，建立數據庫連接池。

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

不完全統計，這個完整的application properties文件，有1183行。其中，屬性key有950個。當你看到如此龐大的配置，你一定會被嚇到。不過，在實際項目中，我們如果遵循Spring Boot的約定，通常不需要我們單獨指定太多配置。

雖然是零XML配置，但是“有些配置的事情”，還是必須要做的。這里SpringBoot的實現方案，充分體現了Spring框架的“約定優于配置”理念。通過約定俗成的規范，很多問題的解決講得到大大的簡化。

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

我們可以將自己自定義的屬性配置在application.properties中（注意不要和Spring Boot的默認配置的key重復），然后在java類中通過@Value("${屬性名}")注解來加載對應的配置屬性，例如：application.properties文件中有如下自定義配置項：

com.easy.springboot.h5perf.app.name = H5性能測試平臺

則在java中有如下應用：

@Component
public class TestProperties {

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

3.配置項值的引用

在application.properties中的各個參數之間可以直接通過“${keyname}”引用來使用。

在application.properties中也可以通過“@keyname@”來引用pom文件中的元素節點值，例如：

pom文件中有如下定義：

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

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

# 項目名稱
com.easy.springboot.project.name = @project.name@
# 項目版本
com.easy.springboot.project.version = @project.version@

4.隨機數屬性value

在一些情況下，有些參數我們需要希望它不是一個固定的值，Spring Boot的屬性配置文件中可以通過${random}來產生int值、long值或者string字符串，來支持屬性的隨機值。

例如：

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

屬性配置文件的位置

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

/config優先于classpath根目錄。

Spring Boot 配置的管理

一般在一個項目中，總是會有好多個環境。比如：

開發環境 -> 測試環境 -> 預發布環境 -> 生產環境

在應用中管理配置是一個重要的問題，尤其是在應用需要部署到多個環境中時。通常會需要為每個環境提供一個對應的屬性文件，用來配置各自的數據庫連接信息、服務器信息和第三方服務賬號等。通常的應用部署會包含開發、測試和生產等若干個環境。

常規情況下，我們都知道Spring Boot的配置會從application.properties中讀取。實際上，從resource目錄下的application.properties文件讀取是Spring Boot配置鏈中的一環而已。

配置的優先級

Spring Boot提供了一種優先級配置讀取的機制來幫助我們從這種困境中走出來。

Spring Boot 所提供的配置優先級順序比較復雜。按照優先級從高到低的順序，具體的列表（從高到低）如下所示。

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

如果Spring Boot在優先級更高的位置找到了配置，那么它就會忽略優先級低的配置。下面我們簡單講講這些優先級。

命令行參數配置

Spring Boot 的這個配置優先級看似復雜，其實是很合理的。命令行參數的優先級之所以被設置為最高，是因為可以方便我們在測試或生產環境中快速地修改配置參數值，而不需要重新打包和部署應用。

SpringApplication 類默認會把以“--”開頭的命令行參數轉化成應用中可以使用的配置參數，如 “--name=Alex” 會設置配置參數 “name” 的值為 “Alex”。

如果不需要這個功能，可以通過

SpringApplication.setAddCommandLineProperties(false)

禁用解析命令行參數。

random.*屬性

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

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

屬性文件配置

屬性文件是最常見的管理配置屬性的方式。Spring Boot 提供的 SpringApplication 類會搜索并加載 application.properties 文件來獲取配置屬性值。SpringApplication 類會在下面位置搜索該文件：

1.當前目錄的/config子目錄
2.當前目錄
3.classpath 中的/config包
4.classpath

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

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

對于配置屬性，可以在代碼中通過“@Value”來使用，例如

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

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

YAML格式的配置文件

相對于屬性文件來說，YAML 是一個更好的配置文件格式。
當有前綴的情況下，使用.yml格式的配置文件更簡單。

注意：使用.yml時，屬性名的值和冒號中間必須有空格，如name: SpringBoot正確，SpringBoot就是錯的。

YAML 在 Ruby on Rails 中得到了很好的應用。YAML是JSON的一個超集，也是一種方便的定義層次配置數據的格式。它的基本語法規則如下：

大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tab鍵，只允許使用空格。
縮進的空格數目不重要，只要相同層級的元素左側對齊即可
# 表示注釋，從這個字符一直到行尾，都會被解析器忽略。

只要你將SnakeYAML 庫放到classpath下，SpringApplication就會自動支持YAML，以作為properties的替換。當然，我們通常不需要這么做，因為我們一般都會使用Starters，在spring-boot-starter里會自動加載SnakeYAML。

Spring框架提供兩個便利的類用于加載YAML文檔，YamlPropertiesFactoryBean會將YAML加載為Properties，YamlMapFactoryBean會將YAML加載為Map。

Spring Boot使用application.properties默認了很多配置。但需要自己添加一些配置的時候，我們應該怎么做呢。

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

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

會轉化為：

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

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

在代碼中對應的Bean對象：

@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; } 

}

有些時候，我們還會配置類似下面這樣的列表的屬性

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

會轉化為：

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

使用@ConfigurationProperties這個注解來實現屬性Bean的綁定，需要在Bean里面添加一個java.util.List(或者Set)類型的屬性，然后寫好setter（setter也可以換成初始化一個對象），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;
    }    

}

因為YamlPropertySourceLoader類能夠將YAML作為PropertySource導出到Spring Environment。所以我們可以使用常用的@Value注解配合占位符語法訪問YAML屬性。

另外，當我們使用@ConfigurationProperties注解定義配置的Bean時，需要在SpringBoot Application啟動類上標注@EnableConfigurationProperties。

使用 Java配置類

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

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

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

    // ...

}

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

1.配置在application.properties中：

spring.profiles.active=production

2.或使用命令行開關：

--spring.profiles.active=production

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

使用CommandLineRunner

實際應用中，有時候我們在項目服務啟動的時候就去加載一些數據或做一些事情這樣的需求。 以前比較常見的做法是寫再static代碼塊中。

在Spring Boot中，它提供了一個CommandLineRunner接口，實現這個接口的類總是會被優先啟動，并優先執行CommandLineRunner接口中提供的run()方法。例如

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

如果有多個CommandLineRunner接口實現類，那么可以通過注解@Order
來規定所有實現類的運行順序。

小結

Spring Boot 它拋棄了Spring 中繁瑣的xml配置文件的方式，聲明式注解的方法為服務開發提供快速簡潔的配置方式。在Spring Boot 中，我們會發現，我們其實不用做一些基本的配置也能直接運行剛創建好的工程項目，因為它內嵌了很多基本的通用的配置組件而不需要我們自己來做一些重復的配置工作。

Spring Boot讓環境配置變得輕松很多。

參考資料：
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