Springboot與Maven多環(huán)境配置的解決方案

更新時(shí)間：2021年06月25日 15:41:39 作者：海向

多環(huán)境配置的解決方案有很多，我看到不少項(xiàng)目的多環(huán)境配置都是使用Maven來(lái)實(shí)現(xiàn)的，本文就實(shí)現(xiàn)Springboot與Maven多環(huán)境配置，感興趣的可以了解下

Profile用法

我們?cè)赼pplication.yml中為jdbc.username賦予一個(gè)值，這個(gè)值為一個(gè)變量

jdbc:
  username: ${jdbc.username}

Maven中的profiles可以設(shè)置多個(gè)環(huán)境，當(dāng)我們選擇a環(huán)境后，<jdbc.username>內(nèi)的值將替換上述配置文件中的變量

 </profiles>
        <profile>
            <id>a</id>
            <properties>
                <jdbc.username>root</jdbc.username>
            </properties>
            <!-- 默認(rèn)使用此環(huán)境 -->
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
    </profiles>

我們查看編譯后的application.yml文件,果然變量已經(jīng)被賦值。我們猜想是否可以利用Profile的這一特性設(shè)置開發(fā)、測(cè)試、生產(chǎn)環(huán)境，選擇不同環(huán)境時(shí)使用不同變量，配合Resources和Filter來(lái)指定打包內(nèi)容以及替換變量。

jdbc:
  username: root

resources

用來(lái)操作編譯文件

filters

過(guò)濾器，設(shè)置過(guò)濾器的資源將會(huì)對(duì)同名變量進(jìn)行賦值（被賦值的資源文件需要設(shè)置filtering為true）

多環(huán)境配置解決方案

網(wǎng)上大多數(shù)都是分為application-dev.xml、application-test.xml、application-prod.xml三個(gè)文件，可是我們?cè)谡鎸?shí)項(xiàng)目開發(fā)中，將會(huì)用到很多各式各樣的文件（例如log4j的配置文件），它們?cè)诓煌h(huán)境中應(yīng)該也是不同的配置，不能在測(cè)試和生產(chǎn)環(huán)境使用同一個(gè)配置文件。所以我們將分為三個(gè)文件夾分別代表開發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境，他們里面的配置文件種類一致但是內(nèi)容不一樣。選擇完當(dāng)前環(huán)境后，打的jar包只包含當(dāng)前環(huán)境文件夾下的配置文件。

├─main
│  ├─java
│  │  └─......
│  └─resources
│      ├─dev
│      │   └─config
│      │   │   └─mq.yml
│      │   │   └─redis.yml
│      │   └─application-dev.yml
│      ├─prod
│      │  └─config
│      │  │    └─mq.yml
│      │  │    └─redis.yml
│      │  └─application-prod.yml
│      └─test
│      │  └─config
│      │  │    └─mq.yml
│      │  │    └─redis.yml
│      │  └─application-test.yml
│    └─application.yml
│    └─a.xml
└─test
    └─java
        └─......

dev下的config下的mq.yml

mq: mq-dev

dev下的config下的redis.yml

redis: redis-dev

dev下的application-dev.yml

profiles.active:
  dev
port: dev-port
application.yml

spring:
  profiles:
    active: ${profiles.active}
 
port: ${port}

查看編譯后的結(jié)果

其中application.yml中變量已經(jīng)被替換為

spring:
  profiles:
    active: dev
port: dev-port

完整的pom.xml

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.1.0</version>
                <!--使用默認(rèn)的變量分割符即${}-->
                <configuration>
                    <useDefaultDelimiters>true</useDefaultDelimiters>
                </configuration>
            </plugin>
        </plugins>

        <!-- 測(cè)試文件的編譯路徑設(shè)置 -->
        <testResources>
            <testResource>
                <!--這里是關(guān)鍵！ 根據(jù)不同的環(huán)境，把對(duì)應(yīng)文件夾里的配置文件打包-->
                <directory>src/main/resources</directory>
                <includes>
                    <include>application.yml</include>
                </includes>
                <filtering>true</filtering>
            </testResource>

            <testResource>
                <!--這里是關(guān)鍵！ 根據(jù)不同的環(huán)境，把對(duì)應(yīng)文件夾里的配置文件打包-->
                <directory>src/main/resources/${profiles.active}</directory>
                <includes>
                    <include>**/*.yml</include>
                </includes>
                <filtering>false</filtering>
            </testResource>
        </testResources>

        <resources>
            <resource>
                <!--打包該目錄下的 application.yml -->
                <directory>src/main/resources</directory>
                <includes>
                    <include>application.yml</include>
                </includes>
                <!-- 啟用過(guò)濾 即該資源中的變量將會(huì)被過(guò)濾器中的值替換 -->
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <!-- ${profiles.active}由profile提供 -->
                <directory>src/main/resources/${profiles.active}</directory>
                <includes>
                    <include>**/*.yml</include>
                </includes>
                <filtering>false</filtering>
            </resource>

        </resources>

        <!-- 定義 filter,即該資源中的值將會(huì)用來(lái)替換同名屬性（設(shè)置 filtering 為 true 的資源中的屬性）-->
        <filters>
          <filter>
              src/main/resources/${profiles.active}/application-${profiles.active}.yml
          </filter>
        </filters>
    </build>

    <profiles>
        <profile>
            <!-- 本地開發(fā)環(huán)境 -->
            <id>dev</id>
            <properties>
                <profiles.active>dev</profiles.active>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>

        </profile>

        <profile>
            <!-- 測(cè)試環(huán)境 -->
            <id>test</id>
            <properties>
                <profiles.active>test</profiles.active>
            </properties>
        </profile>

        <profile>
            <!-- 生產(chǎn)環(huán)境 -->
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
        </profile>
    </profiles>

到此這篇關(guān)于Springboot與Maven多環(huán)境配置的解決方案的文章就介紹到這了,更多相關(guān)Springboot Maven多環(huán)境配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: