Maven profile整合Spring profile

小灰灰 2022-03-08 11:24 207阅读 0赞

在Maven和Spring中，都有profile这个概念。profile是用于区分各种环境的，例如开发环境、测试环境、正式环境等。Maven的profile用于在打包时根据指定环境替换不同环境的配置文件配置，如数据库配置。Spring的Profile可以用于在不同的环境下加载不同的bean，例如`@Profile`注解。两者一个是Maven编译和打包时生效，另一个是运行时生效，默认是没有关联的，本文会分别介绍非Spring Boot项目和Spring Boot项目整合Maven profile。

## Maven profile配置 ##

在`pom.xml`中，可以配置`test`和`product`两个profile，分别对应测试环境和正式环境。这里也可以根据具体情况自定义。

<profiles>
      <profile>
        <id>test</id>
        ...
      </profile>
      <profile>
        <id>product</id>
        ...
      </profile>
    </profiles>

此时，运行`mvn package -Ptest`就会使用id为test的profile内的配置打包，`mvn package -Pproduct`就是用来打正式环境包的命令。

## Spring Framework（非Spring Boot）整合Maven profile ##

### Spring Framework如何启用一个profile ###

Spring启用某个profile有多种方式（摘自官方文档：[https://docs.spring.io/spring...][https_docs.spring.io_spring...] ）：

> Activating a profile can be done in several ways, but the most straightforward is to do it programmatically against the Environment API which is available through an ApplicationContext.  
> In addition, you can also declaratively activate profiles through the spring.profiles.active property, which may be specified through system environment variables, JVM system properties, servlet context parameters in web.xml, or even as an entry in JNDI.

总结一下有以下几种方式：

*  通过代码设置：`ApplicationContext.getEnvironment().setActiveProfiles("yourProfile")`
 *  通过系统环境变量`spring.profiles.active`值来设置
 *  通过JVM系统属性`spring.profiles.active`值来设置
 *  通过`web.xml`中的`context-param`来设置

为了便于跟Maven整合，我们使用`web.xml`来设置Spring profile，如下：

<context-param>
        <param-name>spring.profiles.active</param-name>
        <param-value>product</param-value>
    </context-param>

以上配置会启用Spring的`product` profile，即正式环境。

### Spring Framework profile整合Maven profile ###

如果想要整合Maven profile和Spring Framework profile，需要在Maven打包时对`web.xml`中的`spring.profiles.active`值进行替换，可以在`web.xml`中配置一个占位符`${activeProfile}`：

<context-param>
        <param-name>spring.profiles.active</param-name>
        <param-value>${activeProfile}</param-value>
    </context-param>

在`pom.xml`配置`maven-war-plugin`：

<build>
      <plugin>
        <artifactId>maven-war-plugin</artifactId>
        <version>3.2.2</version>
        <configuration>
          <filteringDeploymentDescriptors>true</filteringDeploymentDescriptors>
        </configuration>
      </plugin>
    </build>
    
    
    <properties>
      <activeProfile>dev</activeProfile>
    </properties>
    
    <profiles>
      <profile>
        <id>test</id>
        <properties>
          <activeProfile>test</activeProfile>
        </properties>
      </profile>
      <profile>
        <id>product</id>
        <properties>
          <activeProfile>product</activeProfile>
        </properties>
      </profile>
    </profiles>

`<filteringDeploymentDescriptors>`为`true`表示过滤`Deployment Descriptor`并将文件中的占位符替换为`pom.xml`中对应的`<properties>`值，`Deployment Descriptor`即部署描述符，指的就是web.xml （参考维基百科：[https://zh.wikipedia.org/wiki...][https_zh.wikipedia.org_wiki...] ）。

以上配置完成后，再通过`mvn package -Ptest`或`mvn package -Pproduct`打包后，再解压war包，可以看到`web.xml`中原有的

<context-param>
        <param-name>spring.profiles.active</param-name>
        <param-value>${activeProfile}</param-value>
    </context-param>

被替换为了Maven中对应的profile，例如`mvn package -Pproduct`打包后`web.xml`内容：

<context-param>
        <param-name>spring.profiles.active</param-name>
        <param-value>product</param-value>
    </context-param>

以上就完成了Maven profile和Spring profile的整合。

### 兼容jetty-maven-plugin ###

如果恰好在项目中使用到`jetty-maven-plugin`用于开发环境调试，那么在`web.xml`配置占位符`${activeProfile}`后，通过`mvn jetty:run`启动应用时会Spring框架会报错：

Could not resolve placeholder 'activeProfile' in string value "${activeProfile}"

这是因为运行`mvn jetty:run`命令时插件并没有打war包，而是直接使用源码中的`web.xml`，此时占位符`${activeProfile}`未被`maven-war-plugin`替换，所以Spring框架会报错。

参考文档：[https://www.eclipse.org/jetty...][https_www.eclipse.org_jetty...]

#### 解决方法一 ####

使用`mvn jetty:run-war`或`mvn jetty:run-exploded`命令替代`mvn jetty:run`，这两个命令会先用`maven-war-plugin`打好war包后再运行，此时占位符`${activeProfile}`已被替换为Maven的profile。

但是这种方案会带来一个问题：由于这种方式需要先打war包再运行，开发时项目中资源（例如html、jsp）修改后就不会实时生效，而是需要重新打包启动，不便于调试。

#### 解决方法二（推荐） ####

这种方案还是使用`mvn jetty:run`命令，只需要给`jetty-maven-plugin`插件添加一个名为`activeProfile`的系统属性，让Spring框架来解析`web.xml`中的`${activeProfile}`：

<plugin>
      <groupId>org.eclipse.jetty</groupId>
      <artifactId>jetty-maven-plugin</artifactId>
      <version>9.2.10.v20150310</version>
      <configuration>
        <webApp>
          <contextPath>/</contextPath>
        </webApp>
        <systemProperties>
          <systemProperty>
            <name>activeProfile</name>
            <value>${activeProfile}</value>
          </systemProperty>
        </systemProperties>
      </configuration>
    </plugin>

参考文档：[https://www.eclipse.org/jetty...][https_www.eclipse.org_jetty... 1]

## Spring Boot整合Maven profile ##

如果项目采用的框架是Spring Boot而不是直接使用Spring Framework，那么Spring Boot的profile可以在resources目录下的`application.properties`或`application.yml`文件中指定，以`application.properties`为例：

spring.profiles.active=product

要想整合Maven profile只需要改为`@activeProfile@`占位符即可：

spring.profiles.active=@activeProfile@

仅需要这一行配置就完成了Spring Boot profile整合Maven profile，非常方便。此时可以尝试`mvn package -Ptest`或`mvn package -Pproduct`命令打包，安装包内的文件中`@activeProfile@`占位符已被替换。

### Spring Boot整合Maven profile原理 ###

Spring Boot项目中一般都会加上`spring-boot-starter-parent`：

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>${spring.boot.version}</version>
    </parent>

可以查看`spring-boot-starter-parent`的pom.xml文件，里面包含`maven-resources-plugin`：

<plugin>
        <artifactId>maven-resources-plugin</artifactId>
        <configuration>
            <delimiters>
                <delimiter>${resource.delimiter}</delimiter>
            </delimiters>
            <useDefaultDelimiters>false</useDefaultDelimiters>
        </configuration>
    </plugin>

`${resource.delimiter}`定义的值是`@`：

<resource.delimiter>@</resource.delimiter>

这样`maven-resources-plugin`插件会将`application.properties`或`application.yml`文件中的`@activeProfile@`替换为`pom.xml`中对应profile的值。

至于为什么Spring Boot要使用`@..@`而不是Maven默认的`${..}`作为占位符的符号，官方文档也给出了解释，以下摘自：[https://docs.spring.io/spring...][https_docs.spring.io_spring... 1]

> Note that, since the application.properties and application.yml files accept Spring style placeholders ($\{…\}), the Maven filtering is changed to use @..@ placeholders. (You can override that by setting a Maven property called resource.delimiter.)

因为Spring Boot框架本身也用`${..}`作为占位符，Maven插件`maven-resources-plugin`如果还使用相同的占位符，那么可能会导致一些冲突，所以`spring-boot-starter-parent`将`maven-resources-plugin`的占位符改为`@..@`。

## 参考文档 ##

*  [Spring Framework: Activating a Profile][https_docs.spring.io_spring...]
 *  [Spring Boot: Maven][https_docs.spring.io_spring... 1]
 *  [Jetty Maven Plugin][]
 *  [维基百科：部署描述符（Deployment Descriptor）][https_zh.wikipedia.org_wiki...]

[https_docs.spring.io_spring...]: https://docs.spring.io/spring/docs/5.1.5.RELEASE/spring-framework-reference/core.html#beans-definition-profiles-enable
[https_zh.wikipedia.org_wiki...]: https://zh.wikipedia.org/wiki/%E9%83%A8%E7%BD%B2%E6%8F%8F%E8%BF%B0%E7%AC%A6
[https_www.eclipse.org_jetty...]: https://www.eclipse.org/jetty/documentation/9.4.x/jetty-maven-plugin.html#jetty-run-goal
[https_www.eclipse.org_jetty... 1]: https://www.eclipse.org/jetty/documentation/9.4.x/jetty-maven-plugin.html#setting-system-properties
[https_docs.spring.io_spring... 1]: https://docs.spring.io/spring-boot/docs/2.0.4.RELEASE/reference/htmlsingle/#using-boot-maven
[Jetty Maven Plugin]: https://www.eclipse.org/jetty/documentation/9.4.x/jetty-maven-plugin.html