SpringBoot使用profile结合maven实现多环境配置

Posted 2022-03-24 泡^泡

我们在开发项目的时候，经常都会使用到多环境配置。springboot提供了非常方便的profile来做多环境配置。以下内容我们将使用2个环境配置：开发环境dev、生产环境prod。如果需要更多的环境配置依样画葫芦新增就好。

首先springboot的支持properties和yml两种形式的配置文件。我个人比较喜欢yml这种形式。相比properties有更好的层级关系，以及少些了很多内容，看起来也比较简洁。这里我将使用yml来配置。

我们在resources目录下新建springboot的配置文件application.yml，内容暂时放空。因为我们要建开发和生产2个环境的配置，所以我们在resources目录下再新建application-dev.yml和application-prod.yml两个文件。结构如下：

说明：

总结就是：x环境的配置就放到application-x.yml文件中去。

如果现在你直接启动的话，你会发现，springboot还是引用的公共环境的配置，我们新增的dev和prod配置并没有生效，这是为什么呢？因为你没有告诉springboot要使用哪个环境的配置，所以springboot自己也懵逼，于是他只加载了application.yml的配置文件。

为了解决这个问题。我们需要在启动的时候对需要加载的环境进行配置，这里有2种方法。

1、启动的时候增加–spring.profiles.active=dev参数指定使用dev环境。
命令行jar包执行

java -jar demo.jar --spring.profiles.active=dev

idea开发调试如红框所示

2、配置文件中指定
在application.yml中增加如下配置，指定使用dev环境配置。

spring:
  profiles:
    active: dev

到这里我们已经完成了springboot提供的profile实现多环境的配置，是不是非常方便。但是我还是觉得有点麻烦，考虑到maven也有一个profile配置，而且idea针对maven的配置提供可一个窗口用来切换，于是我就想把两个结合起来。

只需要勾选相应的选项即可切换到对应的环境。如何实现呢?我们只需要在项目的pom文件中增加。

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <env>dev</env>
        </properties>
    </profile>

    <profile>
        <id>prod</id>
        <properties>
            <env>prod</env>
        </properties>
    </profile>
</profiles>

然后对application.yml进行简单的修改。

spring:
  profiles:
    active: @env@

即可实现我们要的效果。
注：maven切换环境之后需要使用maven编译一下。

idea中maven的选项卡的lifecycle点一下compile就好了。

说一下原理：我们在maven的profile中指定了2个环境。一样是dev和prod。其中dev环境是默认激活的环境。并且针对不同的环境都指定了一个env的变量。dev下env变量值是dev，prod下env变量值是prod。

在application.yml中我们使用@env@代替了原来dev的位置。意思是maven在编译的时候，会将@env@替换成maven中profile配置的env变量的值。这也就是为啥切换环境的时候需要使用maven对项目进行一下编译的原因。

这样我们就实现了springboot的profile和maven的profile的结合，完成了项目多环境的配置。大家可以自己尝试一下。