springboot 多环境配置 springboot 多环境配置 yml文件版的实现方法

时间:2021-04-22 人气:0

关于 dev、sit、uat、prod多环境切换的配置

最近小伙伴跟杨洋我聊到了多环境配置的问题，网上的大部分教程都是copy的，很多文章根本就没法用，小伙伴很苦恼啊，于是心（yu）地（shu）善（lin）良（feng）的杨洋回去写了个demo给了小伙，那么这边文章呢，正好给大家讲解下关于springboot 的多环境配置

科普时间：

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

首先给刚接触的小伙伴们科普下含义

dev--本地开发环境；
sit--测试环境；
uat--准生产环境；
prod--生产环境；

什么是多环境配置切换呢，为什么要实现呢？

这个呢，你快速搭建一个springboot项目，只有一个环境--开发环境（DEV），那你代码写好了，推送到SVN或者GIT上，你们项目组的准生产环境（UAT）的mysql的库跟sit环境肯定不是一个库，不可能直接修改配置文件吧（当然你真的直接修改当我没说..）
所以，现在小伙伴们就想，我应该如何实现本地开发配置跟准生产配置的自动切换呢？

先准备多环境配置文件

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

然后呢，你想实现不同环境切换，那你得有对应环境的配置文件，复制application.yml 四份

，分别对应不同的环境，实现如下

注意：请小伙伴一定要看清楚是-sit 不是_sit ,你这文件不行的，必须是 -xxx结尾 这边需要说明的是，你 公共部分的配置 ，请放在application.yml中，如果是各个不同的配置（比如不同的mysql配置），分别放在对应的文件中（比如你sit的mysql用户有增删查看权限，你uat用户只有查看权限）这边呢，就是把配置部分的基本整理好了，如果这时候小伙伴启动项目，怎么启动都是执行的application.yml

那如何切换呢？

这边需要修改pom.xml来实现切换配置文件，引入如下：

1. 配置profiles节点

<!-- 多环境配置方案 -->
  <profiles>
    <profile>
      <!-- 本地开发环境 -->
      <id>dev</id>
      <properties>
        <profileActive>dev</profileActive>
      </properties>
      <!-- 默认开启这个配置 -->
      <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. 开启过滤，用指定的参数替换directory下的文件中的参数，这是在< build >下的

<resources>
      <resource>
        <!--开启过滤，用指定的参数替换directory下的文件中的参数-->
        <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@ 中的数据对应的是你properties的数据

profiles:
  active: @profileActive@

5. 需要添加yaml的依赖，不然无法启动idea启动（还有另一种办法是下载idea支持的插件，这边不推荐）

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

验证多环境配置切换

1.idea启动验证

写了一个demo验证，每个yml文件添加一个自定义参数，以及对应的端口号都不相同，如下：

一个方法进行验证

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

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

  @GetMapping
  @RequestMapping("/getEnv")
  public String getEnv(){
    return "当前环境是："+envName;
  }
}

示例图

dev 测试

prod 测试

2.打成jar包验证使用命令clean package -P prod 进行打包

打包完成，进行检验

完成！

注意点：

如果出现 next token found character '@' that cannot start any token 说明你pom文件的解析插件没有添加
如果出现无法运行idea，说明你yaml的依赖没有添加

总结

加载全部内容