目的

在實(shí)際的項(xiàng)目上，一般會(huì)分三種環(huán)境dev、test、prod來(lái)方便我們的開(kāi)發(fā)和部署，要求我們?cè)陂_(kāi)發(fā)的時(shí)候可以方便地進(jìn)行環(huán)境的切換，又要滿(mǎn)足在發(fā)布版本的時(shí)候可以盡可能減少測(cè)試人員的配置。

Spring Profile

多環(huán)境

為了實(shí)現(xiàn)多環(huán)境配置，我們可以在本地開(kāi)發(fā)的時(shí)候在Resource文件夾下新建不同環(huán)境的配置文件，如下圖所示：

image

這時(shí)候我們只需要在主配置文件application.yml文件使用spring.profiles.active = dev/test/prod來(lái)進(jìn)行不同環(huán)境的切換

spring:
  profiles:
    active: dev #加載dev配置文件

經(jīng)過(guò)上述步驟，我們即可在本地開(kāi)發(fā)時(shí)根據(jù)不同的環(huán)境進(jìn)行測(cè)試。

主配置文件與不同環(huán)境的配置文件

Spring Profile有一個(gè)特性即可以在application.yml配置通用的內(nèi)容，在application-dev.yml文件中配置不同文件的差異化配置，這樣可以精簡(jiǎn)我們的配置文件。配置如下：

# 主配置文件主要用來(lái)存放公共設(shè)置，不受環(huán)境配置影響
server:
  port: 8082 # 指定端口號(hào)
  context-path: /server # 指定訪問(wèn)資源的根路徑
spring:
  profiles:
    active: dev 

dev配置文件

# 主要用來(lái)存放不同環(huán)境差異化配置，包括ftp地址、數(shù)據(jù)庫(kù)連接等
spring:
  datasource:
    username: xxx
    password: xxx
    url: xxx
    driver-class-name: oracle.jdbc.driver.OracleDriver

上述解決方案雖然可以解決我們的環(huán)境問(wèn)題，但是不夠優(yōu)雅，還有一些值得優(yōu)化的地方，比如打包出的配置文件有四個(gè)、每次需要手動(dòng)修改主配置文件的環(huán)境信息等。

Maven Profile

Profile配置

Maven 也提供了 Profile 支持，它允許我們?cè)?pom.xml 中定義多個(gè) Profile ，每個(gè) profile 可以指定自己的一些配置、依賴(lài)、觸發(fā)條件等。例如：

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <profile.active>dev</profile.active>
        </properties>
    </profile>
    <profile>
        <id>prod</id>
        <properties>
            <profile.active>prod</profile.active>
        </properties>
    </profile>
</profiles>

按照上述的配置，我們配置了dev/test/prod三種配置并默認(rèn)選擇dev環(huán)境。

資源過(guò)濾

在進(jìn)行打包的時(shí)候，我們并不需要把dev或者test等配置文件打包進(jìn)行，所有我們?cè)诖虬臅r(shí)候進(jìn)行如下配置

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <!--先排除所有的配置文件-->
                <excludes>
                    <exclude>application*.yml</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <!--引入所需環(huán)境的配置文件-->
                <filtering>true</filtering>
                <includes>
                    <include>application.yml</include>
                    <include>application-${profile.active}.yml</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <classifier>exec</classifier>
                </configuration>
            </plugin>
        </plugins>
    </build>

主要是分為兩個(gè)步驟：

1. 先排除所有的配置文件
2. 引入我們所需要的配置文件，根據(jù)${profile.active}來(lái)動(dòng)態(tài)指定

熟悉idea的同學(xué)都知道，這里的${profile.active}我們?cè)趇dea的maven的配置處進(jìn)行快速的切換。

image

從上面的配置文件可以看出，我們引入了兩個(gè)配置文件，一個(gè)是主配置文件(application.yml)，一個(gè)是實(shí)際環(huán)境(application-dev.yml)的配置文件,但是到這里還沒(méi)有結(jié)束。我們知道主配置文件的dev/test/prod在沒(méi)有使用Maven Profile的時(shí)候，我們是需要手動(dòng)修改的，但是使用Maven Profile之后，我們可以把這個(gè)工作交給maven去做。

在application.yml進(jìn)行下面的修改：

spring:
  profiles:
    active: @profile.active@ #此處由maven的環(huán)境選擇決定

這樣我們就可以完全把配置文件的指定和生成交給maven。

Spring Profile與Maven Profile具體使用

配置如下：

# 主配置文件主要用來(lái)存放公共設(shè)置，不受環(huán)境配置影響
server:
  port: 8082 # 指定端口號(hào)
  context-path: /server # 指定訪問(wèn)資源的根路徑
spring:
  profiles:
    active: @profile.active@ #此處由maven的環(huán)境選擇決定

參考：Maven Profile 與 Spring Profile 管理多環(huán)境打包