關(guān)于 dev、sit、uat、prod多環(huán)境切換的配置

最近小伙伴跟楊洋我聊到了多環(huán)境配置的問題，網(wǎng)上的大部分教程都是copy的，很多文章根本就沒法用，小伙伴很苦惱啊，于是心（yu）地（shu）善（lin）良（feng）的楊洋回去寫了個demo給了小伙 ， 那么這邊文章呢，正好給大家講解下關(guān)于springboot 的多環(huán)境配置

科普時間：

 dev、sit、uat、prod是什么呢？

首先給剛接觸的小伙伴們科普下含義

• dev--本地開發(fā)環(huán)境；
• sit--測試環(huán)境；
• uat--準(zhǔn)生產(chǎn)環(huán)境；
• prod--生產(chǎn)環(huán)境；

 什么是多環(huán)境配置切換呢，為什么要實(shí)現(xiàn)呢？

• 這個呢，你快速搭建一個springboot項(xiàng)目，只有一個環(huán)境--開發(fā)環(huán)境（DEV），那你代碼寫好了，推送到SVN或者GIT上，你們項(xiàng)目組的準(zhǔn)生產(chǎn)環(huán)境（UAT）的mysql的庫跟sit環(huán)境肯定不是一個庫，不可能直接修改配置文件吧（當(dāng)然你真的直接修改當(dāng)我沒說..）
• 所以，現(xiàn)在小伙伴們就想，我應(yīng)該如何實(shí)現(xiàn)本地開發(fā)配置跟準(zhǔn)生產(chǎn)配置的自動切換呢？

先準(zhǔn)備多環(huán)境配置文件

首先呢，你得有一個 application.yml 文件

然后呢，你想實(shí)現(xiàn)不同環(huán)境切換，那你得有對應(yīng)環(huán)境的配置文件，復(fù)制application.yml 四份

，分別對應(yīng)不同的環(huán)境，實(shí)現(xiàn)如下

注意：請小伙伴一定要看清楚是-sit 不是_sit ,你這文件不行的，必須是 -xxx結(jié)尾 這邊需要說明的是，你 公共部分的配置 ，請放在application.yml中，如果是各個不同的配置（比如不同的mysql配置），分別放在對應(yīng)的文件中（比如你sit的mysql用戶有增刪查看權(quán)限，你uat用戶只有查看權(quán)限） 這邊呢，就是把配置部分的基本整理好了，如果這時候小伙伴啟動項(xiàng)目，怎么啟動都是執(zhí)行的application.yml

那如何切換呢？

這邊需要修改pom.xml來實(shí)現(xiàn)切換配置文件，引入如下：

1. 配置profiles節(jié)點(diǎn)

<!-- 多環(huán)境配置方案 -->
  <profiles>
    <profile>
      <!-- 本地開發(fā)環(huán)境 -->
      <id>dev</id>
      <properties>
        <profileActive>dev</profileActive>
      </properties>
      <!-- 默認(rèn)開啟這個配置 -->
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
    </profile>
    <profile>
      <id>sit</id>
      <properties>
        <profileActive>sit</profileActive>
      </properties>
    </profile>
    <profile>
      <id>uat</id>
      <properties>
        <profileActive>uat</profileActive>
      </properties>
    </profile>
    <profile>
      <id>prod</id>
      <properties>
        <profileActive>prod</profileActive>
      </properties>
    </profile>
  </profiles>

2. 開啟過濾，用指定的參數(shù)替換directory下的文件中的參數(shù)，這是在< build >下的

<resources>
      <resource>
        <!--開啟過濾，用指定的參數(shù)替換directory下的文件中的參數(shù)-->
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
      </resource>
    </resources>

3. 添加解析插件

<plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-resources-plugin</artifactId>
      <configuration>
        <delimiters>@</delimiters>
        <useDefaultDelimiters>false</useDefaultDelimiters>
      </configuration>
    </plugin>

4. 修改application.yml文件

注意：@profileActive@ 中的數(shù)據(jù)對應(yīng)的是你properties的數(shù)據(jù)

profiles:
  active: @profileActive@

5. 需要添加yaml的依賴，不然無法啟動idea啟動（還有另一種辦法是下載idea支持的插件，這邊不推薦）

<dependency>
	      <groupId>org.yaml</groupId>
	      <artifactId>snakeyaml</artifactId>
	</dependency>

驗(yàn)證多環(huán)境配置切換

1.idea啟動驗(yàn)證

寫了一個demo驗(yàn)證，每個yml文件添加一個自定義參數(shù)，以及對應(yīng)的端口號都不相同，如下：

一個方法進(jìn)行驗(yàn)證

/**
 - @author yanglei
 - @desc
 - @date 2020/6/28
 */
@RestController
public class DemoController {

  @Value("${envname}")
  private String envName;

  @GetMapping
  @RequestMapping("/getEnv")
  public String getEnv(){
    return "當(dāng)前環(huán)境是："+envName;
  }
}

示例圖

dev 測試

prod 測試

2.打成jar包驗(yàn)證 使用命令clean package -P prod 進(jìn)行打包

打包完成，進(jìn)行檢驗(yàn)

 完成！

注意點(diǎn)：

• 如果出現(xiàn) next token found character '@' that cannot start any token 說明你pom文件的解析插件沒有添加
• 如果出現(xiàn)無法運(yùn)行idea，說明你yaml的依賴沒有添加

總結(jié)

到此這篇關(guān)于springboot 多環(huán)境配置 yml文件版的實(shí)現(xiàn)方法的文章就介紹到這了,更多相關(guān)springboot 多環(huán)境配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論