在 Spring Boot 中，配置文件有兩種不同的格式，一個是 properties ，另一個是 yaml 。

雖然 properties 文件比較常見，但是相對于 properties 而言，yaml 更加簡潔明了，而且使用的場景也更多，很多開源項目都是使用 yaml 進(jìn)行配置（例如 Hexo）。除了簡潔，yaml 還有另外一個特點(diǎn)，就是 yaml 中的數(shù)據(jù)是有序的，properties 中的數(shù)據(jù)是無序的，在一些需要路徑匹配的配置中，順序就顯得尤為重要（例如我們在 Spring Cloud Zuul 中的配置），此時我們一般采用 yaml。

本文主要來看看 properties 的問題。

位置問題

首先，當(dāng)我們創(chuàng)建一個 Spring Boot 工程時，默認(rèn) resources 目錄下就有一個 application.properties 文件，可以在 application.properties 文件中進(jìn)行項目配置，但是這個文件并非唯一的配置文件，在 Spring Boot 中，一共有 4 個地方可以存放 application.properties 文件。

• 當(dāng)前項目根目錄下的 config 目錄下
• 當(dāng)前項目的根目錄下
• resources 目錄下的 config 目錄下
• resources 目錄下

按如上順序，四個配置文件的優(yōu)先級依次降低。如下：

這四個位置是默認(rèn)位置，即 Spring Boot 啟動，默認(rèn)會從這四個位置按順序去查找相關(guān)屬性并加載。但是，這也不是絕對的，我們也可以在項目啟動時自定義配置文件位置。

例如，現(xiàn)在在 resources 目錄下創(chuàng)建一個 javaboy 目錄，目錄中存放一個 application.properties 文件，那么正常情況下，當(dāng)我們啟動 Spring Boot 項目時，這個配置文件是不會被自動加載的。我們可以通過 spring.config.location 屬性來手動的指定配置文件位置，指定完成后，系統(tǒng)就會自動去指定目錄下查找 application.properties 文件。

此時啟動項目，就會發(fā)現(xiàn)，項目以 classpath:/javaboy/application.propertie 配置文件啟動。

這是在開發(fā)工具中配置了啟動位置，如果項目已經(jīng)打包成 jar ，在啟動命令中加入位置參數(shù)即可：

java -jar properties-0.0.1-SNAPSHOT.jar --spring.config.location=classpath:/javaboy/

文件名問題

對于 application.properties 而言，它不一定非要叫 application ，但是項目默認(rèn)是去加載名為 application 的配置文件，如果我們的配置文件不叫 application ，也是可以的，但是，需要明確指定配置文件的文件名。

方式和指定路徑一致，只不過此時的 key 是 spring.config.name 。

首先我們在 resources 目錄下創(chuàng)建一個 app.properties 文件，然后在 IDEA 中指定配置文件的文件名：

指定完配置文件名之后，再次啟動項目，此時系統(tǒng)會自動去默認(rèn)的四個位置下面分別查找名為 app.properties 的配置文件。當(dāng)然，允許自定義文件名的配置文件不放在四個默認(rèn)位置，而是放在自定義目錄下，此時就需要明確指定 spring.config.location 。

配置文件位置和文件名稱可以同時自定義。

普通的屬性注入

由于 Spring Boot 源自 Spring ，所以 Spring 中存在的屬性注入，在 Spring Boot 中一樣也存在。由于 Spring Boot 中，默認(rèn)會自動加載 application.properties 文件，所以簡單的屬性注入可以直接在這個配置文件中寫。

例如，現(xiàn)在定義一個 Book 類：

public class Book {
 private Long id;
 private String name;
 private String author;
 //省略 getter/setter
}

然后，在 application.properties 文件中定義屬性：

book.name=三國演義
book.author=羅貫中
book.id=1

按照傳統(tǒng)的方式（Spring中的方式），可以直接通過 @Value 注解將這些屬性注入到 Book 對象中：

@Component
public class Book {
 @Value("${book.id}")
 private Long id;
 @Value("${book.name}")
 private String name;
 @Value("${book.author}")
 private String author;
 //省略getter/setter
}

注意

Book 對象本身也要交給 Spring 容器去管理，如果 Book 沒有交給 Spring 容器，那么 Book 中的屬性也無法從 Spring 容器中獲取到值。

配置完成后，在 Controller 或者單元測試中注入 Book 對象，啟動項目，就可以看到屬性已經(jīng)注入到對象中了。

一般來說，我們在 application.properties 文件中主要存放系統(tǒng)配置，這種自定義配置不建議放在該文件中，可以自定義 properties 文件來存在自定義配置。

例如在 resources 目錄下，自定義 book.properties 文件，內(nèi)容如下：

book.name=三國演義
book.author=羅貫中
book.id=1

此時，項目啟動并不會自動的加載該配置文件，如果是在 XML 配置中，可以通過如下方式引用該 properties 文件：

<context:property-placeholder location="classpath:book.properties"/>

如果是在 Java 配置中，可以通過 @PropertySource 來引入配置：

@Component
@PropertySource("classpath:book.properties")
public class Book {
 @Value("${book.id}")
 private Long id;
 @Value("${book.name}")
 private String name;
 @Value("${book.author}")
 private String author;
 //getter/setter
}

這樣，當(dāng)項目啟動時，就會自動加載 book.properties 文件。

這只是 Spring 中屬性注入的一個簡單用法，和 Spring Boot 沒有任何關(guān)系。

類型安全的屬性注入

Spring Boot 引入了類型安全的屬性注入，如果采用 Spring 中的配置方式，當(dāng)配置的屬性非常多的時候，工作量就很大了，而且容易出錯。

使用類型安全的屬性注入，可以有效的解決這個問題。

@Component
@PropertySource("classpath:book.properties")
@ConfigurationProperties(prefix = "book")
public class Book {
 private Long id;
 private String name;
 private String author;
 //省略getter/setter
}

這里，主要是引入 @ConfigurationProperties(prefix = “book”) 注解，并且配置了屬性的前綴，此時會自動將 Spring 容器中對應(yīng)的數(shù)據(jù)注入到對象對應(yīng)的屬性中，就不用通過 @Value 注解挨個注入了，減少工作量并且避免出錯。

總結(jié)
application.properties 是 Spring Boot 中配置的一個重要載體，很多組件的屬性都可以在這里定制。

最新評論