一、為什麼需要構建配置檔案

在開發過程中，我們經常會根據不同的環境配置不同的引數，如資料來源的ip，username，password、url、祕鑰等都會不同，傳統方式是在一個配置檔案中通過修改properties檔案中的引數值或者通過註釋解註釋來達到目的，這樣不僅容易出錯，還浪費不必要的時間，更重要的是把程式碼釋出到測試環境或者生產環境還容易忘記改。為解決這種問題，maven提供了一種解決方案，就是profile。

下圖為傳統方式，需要來回的註釋和解註釋 

二、什麼是構建配置檔案？

構建配置檔案是一組配置的集合，用來設定或者覆蓋 Maven 構建的預設配置。使用構建配置檔案，可以為不同的環境定製構建過程，例如 Producation 和 Development 環境。

Profile 在 pom.xml 中使用 activeProfiles / profiles 元素指定，並且可以用很多方式觸發。Profile 在構建時修改 POM，並且為變數設定不同的目標環境（例如，在開發、測試和產品環境中的資料庫伺服器路徑）。

三、Profile 型別

Profile 主要有三種類型。

四、配置檔案啟用

Maven的構建配置檔案可以通過多種方式啟用。

• 使用命令控制檯輸入顯式啟用。
• 通過 maven 設定。
• 基於環境變數（使用者或者系統變數）。
• 作業系統設定（比如說，Windows系列）。
• 檔案的存在或者缺失。

五、實現方式

1、filter方式實現

第一步：分別定義application-dev.properties、application-test.properties、application-pro.properties三個檔案

application-dev.properties

env.jdbc.username=dev
env.jdbc.password=123456
 

application-test.properties

env.jdbc.username=test
env.jdbc.password=888888

application-pro.properties

env.jdbc.username=root
env.jdbc.password=666666

第二步：定義總的屬性檔案application.properties，該檔案中的值去引用application-<env>.properties中的key

// 引用application-<env>中的key
jdbc.username=${env.jdbc.username}
jdbc.password=${env.jdbc.password}

# 公共配置
salt=123456789

第三步：配置profile

<profiles>
 <profile>
 <!-- 開發環境 -->
 <id>dev</id>
 <properties>
 <env>dev</env>
 </properties>
 <activation>
 <!-- 設定預設啟用這個配置 -->
 <activeByDefault>true</activeByDefault>
 </activation>
 </profile>
 <profile>
 <!-- 測試環境 -->
 <id>test</id>
 <properties>
 <env>test</env>
 </properties>
 </profile>
 <profile>
 <!-- 釋出環境 -->
 <id>pro</id>
 <properties>
 <env>pro</env>
 </properties>
 </profile>
 </profiles>

第四步：配置filter和resource

${env}就是在mvn package -P <env>的名字，這樣就告訴application.properties中應用的key是那個屬性檔案的key了

<build>
 <finalName>profile-app</finalName>
 <!-- 定義了變數配置檔案的地址 -->
 <filters>
 <filter>src/main/resources/config/application/application-${env}.properties</filter>
 </filters>

 <resources>
 <resource>
 <directory>src/main/resources</directory>
 <filtering>true</filtering>
 </resource>
 </resources>

 <plugins>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-war-plugin</artifactId>
 </plugin>
 </plugins>
 </build>

打包執行

// 如果不指定環境，預設是activeByDefault=true的環境，當前是指開發環境
mvn package

// 打包指定的環境通過-P 引數，注意p是大寫的
mvn package -P <env>

從mvn packege -P test執行的結果中可以看到生成的target目錄下classes/application.perperties中的jdbc.username和jdbc.password 就是application-test.properties中配置的env.jdbc.username和env.jdbc.password的值。

在spring中如果要使用屬性配置檔案，直接引入這個總的配置檔案即可，其他的環境配置檔案的使命已經結束了。 <context:property-placeholder location="classpath:application.properties"/>

實現原理： 

在pom.xml中為每個不同的環境定義不同的profile，每個profile都有一個環境名稱，然後為不同環境定義不同的配置檔案(如application-<env>.properties), 再定義一個總的屬性檔案(如application.properties), 然後讓application.properties的value去引用application-<env>.properties中對應的key，在打包時指定要打包的環境的名稱即可，這樣application.properties中的key的值就是相對應環境application-<env>.properties對應的值了。

2.多resource實現方式

步驟

第一步：在src/main/resource建立一個env目錄，再建立各個環境的子目錄，再再各個環境子目錄下建立名為config.properties的檔案，每個鍵相同，值不同。 env/dev/config.properties

jdbc.username=dev
jdbc.password=123456

env/test/config.properties

jdbc.username=test
jdbc.password=888888

env/pro/config.properties

jdbc.username=root
jdbc.password=666666

第二步：建立一個與環境無關的application.properties

# 公共配置
salt=123456789

第三步：配置profiles

<profiles>
 <profile>
 <!-- 開發環境 -->
 <id>dev</id>
 <properties>
 <env>dev</env>
 </properties>
 <activation>
 <!-- 設定預設啟用這個配置 -->
 <activeByDefault>true</activeByDefault>
 </activation>
 </profile>
 <profile>
 <!-- 測試環境 -->
 <id>test</id>
 <properties>
 <env>test</env>
 </properties>
 </profile>
 <profile>
 <!-- 釋出環境 -->
 <id>pro</id>
 <properties>
 <env>pro</env>
 </properties>
 </profile>
</profiles>

第四步：配置resource

<build>
 <finalName>profile-app</finalName>
 <!-- 定義了變數配置檔案的地址 -->
 <resources>
 <resource>
 <directory>src/main/resources</directory>
 <excludes>
 <exclude>env/dev/*</exclude>
 <exclude>env/test/*</exclude>
 <exclude>env/pro/*</exclude>
 </excludes>
 <filtering>true</filtering>
 </resource>
 <resource>
 <directory>src/main/resources/env/${env}</directory>
 <includes>
 <include>*.*</include>
 <include>**/*.xml</include>
 <include>**/*.properties</include>
 </includes>
 <filtering>true</filtering>
 </resource>
 </resources>

 <plugins>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-war-plugin</artifactId>
 </plugin>
 </plugins>
</build>

第五步：執行 mvn package -P test 

3.兩種方式比較

filter方式會把所有的application-dev.properties、application-test.properties、application-pro.properties檔案都會打包進去，而且此種方式只能針對屬性檔案，如果有其他檔案(如.xml)也根據不同的環境有不同的配置，這種方式是不好處理。

多resource方式在打包時只打包指定環境的配置檔案，可以將各種檔案放到各自的環境資料夾中，在打包的時候會將整個資料夾都打包進去。推薦此種方式