maven profile多环境配置

时间:2021-10-08 23:07:49

在我们实际web开发中,开发和正式环境 所用的许多参数会不一样,比如 数据库连接,比如 日志存放路径。为了方便我们快速便捷的切换,maven的profile可以帮助我们解决这个问题。

在这个环境中,resources存放我们的资源文件,这里面dev和product就是我们不同的环境用不同的配置文件,还有一个mapper目录,是mybatis的sql映射文件。

maven profile多环境配置

在pom.xml文件中,我们先启用profile:

<profiles>
<profile>
<id>product</id>
<properties> <logback.root>/home/remote/logs/api</logback.root> <package.environment>product</package.environment>
</properties>
</profile>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<logback.root>e:/logs</logback.root>
<package.environment>dev</package.environment>
</properties>
</profile>
</profiles>

profile标签下的id代表不同的配置环境,我们分配了三个配置环境,分别为dev,product。activeByDefault表示默认激活其中一个环境,我们发现每个配置环境都有logback.root 和 package.environment,这就是不同环境差异化的地方,但是这些又在哪里用上呢?我们得看一下logback-spring.xml文件里的内容,这里不全部贴出来,只贴跟profile有关的内容。

<appender name="accessLog"
class="ch.qos.logback.core.rolling.RollingFileAppender">

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 按天回滚 daily -->
<!--<fileNamePattern>E:\CentOS\qymp-%d{yyyy-MM-dd}.log-->
<fileNamePattern>@logback.root@\oak0825-access-%d{yyyy-MM-dd}.log
</fileNamePattern>
<!-- 日志最大的历史 60天 -->
<maxHistory>180</maxHistory>
</rollingPolicy>
<encoder>
<pattern>
[%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>

是不是发现一个 @logback.root@ ,这跟profile里每个环境配置的logback.root名字一模一样?在maven进行打包时,他会在配置文件里找logback.root,如果找到了则会替换成我们标签里预先配置好的内容,比如我们用dev环境的话,最终的内容会被替换成下面这样

<fileNamePattern>e:/logs\oak0825-access-%d{yyyy-MM-dd}.log</fileNamePattern>

这里要注意,在spring boot 中用的是 “@..@”这种形式 才能替换,老的spring 用的是 “${…}”,这点要注意。

我们写了profile不代表它会自动帮我们完成替换的工作,我们还需要写 build标签:

 <build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>product/*</exclude>
<exclude>dev/*</exclude>
</excludes>
</resource>
<resource>
<filtering>true</filtering> <directory>src/main/resources/${package.environment}</directory>
</resource>

</resources>
</build>

build 下面的resource表示 对资源文件的打包我们可以有自己的规则,比如第一个

            <resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>product/*</exclude>
<exclude>dev/*</exclude>
</excludes>
</resource>

表示先不处理dev,product目录下的文件(因为exclude标签),filtering表示 替不替换profile里配置的变量,比如 之前的logback.root,那这段 resource 就只会打包 mapper文件夹里的文件(因为dev和product已经被排除了),再看第二个resource

<resource>
<filtering>true</filtering> <directory>src/main/resources/${package.environment}</directory>
</resource>

如果我们用maven选择dev环境的话 ,${package.environment}会被替换成dev,说明这个resource将只处理dev文件夹里的文件,而且因为filtering为true,所以logback-spring.xml里的@logback.root@会被替换成e:/logs,如果为false,maven将不会做任何 关于 资源文件的处理,只是简单进行一个打包。

最后在我们执行maven命令时,选择自己需要的环境打包即可,-P设置的是profile的id,这样maven就帮助我们打包不同环境下的配置文件,而我们仅仅只需要执行一行命令就可以了。

mvn -Dmaven.test.skip=true -Pproduct  clean package