经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 软件/图像 » Maven » 查看文章
使用maven的profile构建不同环境配置的方法
来源：jb51　　时间：2021/1/25 15:12:26　　对本文有异议

最近使用到了maven的profile功能，发现这个功能的确很好用也很实用，这块的知识比较多也比较乱，其实真正理解了之后非常简单，为了巩固总结知识，有个更清晰的知识体系，本文诞生了，希望能让像我一样零基础的小白一看就懂，有请戏精，闪亮登场~~

1.背景

作为一名猿，在实际的项目开发中，通常会有很多配置环境，比如最基本的：开发、测试、生产；不同的环境，某些文件的配置是不一样的（如：数据库连接信息、properties文件的配置等），如果我们进行开发or测试时每次都得手动去修改配置文件，难免有些麻烦且容易出现问题（我反正是深有体会╥﹏╥），所以，当当当当~maven的profile功能就出现了。

2.Profile简介

简单说一下，maven的profile可以让我们定义一系列的配置信息，然后指定其激活条件。这样我们就可以定义多个profile，然后每个profile对应不同的激活条件和配置信息，从而达到不同环境使用不同配置信息的目的。

3.Profile在哪定义

一般来讲，有三种地方可以定义，不同的地方，作用范围不同，可配置项也不同；

  • 针对于特定项目的profile配置，我们可以定义在该项目的pom.xml中。
  • 针对于特定用户的profile配置，我们可以在用户的settings.xml文件中定义profile。该文件在用户目录下的“.m2”目录下。
  • 全局的profile配置。全局的profile是定义在Maven安装目录下的“conf/settings.xml”文件中的。

4.Profile使用实例

ps：前方将使用Eclipse来演示，主要以pom配置为主，重点涉及到了profile、filter、resource标签，工程源代码在文章最末尾。

过多的理论就不再说了，还是配合着实例代码来看更容易理解一些。另外，构建不同的环境配置主要有两种效果（或者叫实现方式）：
- 第一种，根据不同的环境生成不同的配置文件（profile+resources）；
- 第二种，根据不同的环境生成不同的配置内容，并替换原配置文件中的内容(profile+resources+filters)；

什么意思？可能比较抽象，别捉急，我们一个一个演示。哦对了，先放一张项目结构图尝尝鲜（为了结构更清晰，我把单元测试的包删了）：

这里写图片描述

4.1 生成不同配置文件

本实例达到的效果是：根据不同的环境，动态打包生成不同环境下的 db.properties 文件。

（1）在pom.xml中的project节点下配置profile

  1.  <profiles>
  2.   <!-- 开发 -->
  3.   <profile>
  4.    <!-- profile的id -->
  5.    <id>dev</id>
  6.    <properties>
  7.     <!-- 此处的jastar.env可以自定义，其他地方可以使用${jastar.env}来引用此属性 -->
  8.     <jastar.env>dev</jastar.env>
  9.    </properties>
  10.    <activation>
  11.     <!-- 默认激活此配置 -->
  12.     <activeByDefault>true</activeByDefault>
  13.    </activation>
  14.   </profile>
  15.   <!-- 测试 -->
  16.   <profile>
  17.    <id>test</id>
  18.    <properties>
  19.     <jastar.env>test</jastar.env>
  20.    </properties>
  21.   </profile>
  22.   <!-- 生产 -->
  23.   <profile>
  24.    <id>prd</id>
  25.    <properties>
  26.     <jastar.env>prd</jastar.env>
  27.    </properties>
  28.   </profile>
  29.  </profiles>

（2）建立三种环境的资源文件夹，如下：

  1. src/main/filters/dev
  2. src/main/filters/test
  3. src/main/filters/prd

并添加各自的db.properties文件：

这里写图片描述

注意：maven标准目录中，提供了一个filters目录用于存放资源过滤文件。推荐在filters目录下创建，而不是resources目录，因为resources目录中的文件默认情况下是不会被过滤的，还需在resources节点下额外的配置一些东西；这样的话结构也较清晰，resource目录存放公共资源文件，filters目录存放不同环境差异化资源文件。

（3）配置maven-resources-plugin插件

在构建WAR包的时候会经过资源文件处理阶段，maven-resources-plugin 则用来处理资源文件。在pom.xml中的build节点下配置如下：

  1. <plugins>
  2.  <!-- 编译插件，此处用来设置jdk的版本，否则默认的版本很低 -->
  3.  <plugin>
  4.   <artifactId>maven-compiler-plugin</artifactId>
  5.   <configuration>
  6.    <source>1.7</source>
  7.    <target>1.7</target>
  8.    <encoding>UTF-8</encoding>
  9.   </configuration>
  10.  </plugin>
  11.  <!-- 资源文件处理插件，必须配置 -->
  12.  <plugin>
  13.   <groupId>org.apache.maven.plugins</groupId>
  14.   <artifactId>maven-resources-plugin</artifactId>
  15.   <configuration>
  16.    <encoding>UTF-8</encoding>
  17.   </configuration>
  18.  </plugin>
  19. </plugins>

（4）配置resources节点

在pom.xml中的build节点下配置如下：

  1. <!-- 最后生成的资源文件 -->
  2. <resources>
  3.  <!-- 所有公共资源文件 -->
  4.  <resource>
  5.   <directory>src/main/resources</directory>
  6.  </resource>
  7.  <!-- 不同环境的资源文件 -->
  8.  <resource>
  9.   <directory>src/main/filters/${jastar.env}</directory>
  10.  </resource>
  11. </resources>

（5）打包测试

至此，配置已经完成了，细心的童鞋会发现，我们maven update 项目之后，资源目录会出现以下现象：

这里写图片描述 

没错，这说明我们的配置生效了，因为默认的profile是dev，所以Eclipse会智能的把该目录显示在这里。

好，接下来打包测试一下是否达到了我们的预期效果。右键项目Run AS，如下：

这里写图片描述 

填写maven命令后run：

这里写图片描述 

运行完成刷新项目可以看到，target目录下生成了“demo-maven-profile.war”文件，打开文件可以看到生成的属性文件如下：

这里写图片描述 

查看db.properties文件内容，perfect~当然，你们也可以试试指定其他profile，在此不再演示。

这里写图片描述

4.2 注入不同的配置内容

本实例达到的效果是：根据不同的环境，将 src/main/resources/log4j.properties中的部分内容替换为src/main/filters/dev、test、prd/log4j.properties中的内容。

（1）依然是先配置profile，上面已经配置过了，同上。
（2）新建src/main/resources/log4j.properties文件如下：

这里写图片描述 

（3）新建src/main/filters/dev、test、prd/log4j.properties文件如下：

这里写图片描述 

（4）重点来了，在pom.xml的build节点下配置filters节点和resources节点，如下（注意注释部分）：

  1. <!-- 此处定义变量配置文件地址 -->
  2. <filters>
  3.  <!-- 注意如果配置了多个filter，并且他们包含有相同的key，则以后面的value为最终值 -->
  4.  <filter>src/main/filters/${jastar.env}/log4j.properties</filter>
  5. </filters>
  6. <resources>
  7.  <resource>
  8.   <directory>src/main/resources</directory>
  9.   <!-- 这句配置是关键，表示该资源文件夹下要进行过滤操作 -->
  10.   <filtering>true</filtering>
  11.  </resource>
  12.  <resource>
  13.   <directory>src/main/filters/${jastar.env}</directory>
  14.  </resource>
  15. </resources>

（5）打包测试

配置完成，接下来同样以上面的方式打包，这里我的profile填写test，运行完成，打开war包，查看log4j.properties文件如下，可以看到log4j的部分内容被替换了，实验成功！

这里写图片描述

5.扩展

5.1 Profile的激活方式

1. 使用 activeByDefault 设置激活

在以上的实例中，我们使用了以下方式设置了默认激活：

  1. <activation> 
  2.  <activeByDefault>true</activeByDefault> 
  3. </activation>

2. 在 settings.xml 中使用 activeProfiles 指定激活

profile配置如下：

  1. <profiles> 
  2.  <profile> 
  3.   <id>profile1</id> 
  4.   <properties> 
  5.    <hello>lilei</hello> 
  6.   </properties> 
  7.  </profile> 
  8.  
  9.  <profile> 
  10.   <id>profile2</id> 
  11.   <properties> 
  12.    <hello>hanmeimei</hello> 
  13.   </properties> 
  14.  </profile> 
  15. </profiles>

激活如下（支持多个）：

  1. <activeProfiles> 
  2.  <activeProfile>profile1</activeProfile> 
  3. </activeProfiles>

3. 在maven命令中使用参数显示激活

Eclipse窗口式运行帮我们隐藏了很多东西，其实原始的 maven 命令应该是这样写的：

  1. mvn clean package –Pprofile1

当然，也可以取消激活：

  1. mvn clean package –P!profile1

还有激活多个：

  1. mvn clean package -Pprofile1,profile2,!profile3

4. 根据环境来激活

profile一个非常重要的特性就是它可以根据不同的环境来激活，比如根据jdk的版本：

  1. <!-- 如果jdk的版本为1.8则激活该profile -->
  2. <profiles>
  3.  <profile>
  4.   <id>profile1</id>
  5.   <activation>
  6.    <jdk>1.8</jdk>
  7.   </activation>
  8.  </profile>
  9. </profiles>

根据操作系统：

  1. <profiles>
  2.  <profile>
  3.   <id>profile1</id>
  4.   <activation>
  5.    <os>
  6.     <!-- 不必指定所有信息 -->
  7.     <name>linux</name>
  8.     <family>unix</family>
  9.     <arch>amd64</arch>
  10.     <version>3.19.0-30-generic</version>
  11.    </os>
  12.   </activation>
  13.  </profile>
  14. </profiles>

根据环境变量：

  1. <profiles>
  2.  <profile>
  3.   <id>profile1</id>
  4.   <activation>
  5.    <property>
  6.     <name>debug</name>
  7.     <value>true</value>
  8.    </property>
  9.   </activation>
  10.  </profile>
  11. </profiles>

根据文件是否存在来激活：

  1. <profiles>
  2.  <profile>
  3.   <id>profile1</id>
  4.   <activation>
  5.    <file>
  6.     <missing>/path/to/missing/file</missing>
  7.     <exists>/path/to/exists/file</exists>
  8.    </file>
  9.   </activation>
  10.  </profile>
  11. </profiles>

不同类型的激活方式可以组合使用，但是只有但两个条件都匹配时才能激活。

5.2 关于Filter

Filter 是 maven 的 resource插件提供的功能，作用是用环境变量、pom文件里定义的属性和指定配置文件里的属性替换属性(*.properties)文件里的占位符(${jdbc.url})。

在src/main/resources目录有个配置文件jdbc.properties，内容如下：

  1. jdbc.url=${pom.jdbc.url}
  2. jdbc.username=${pom.jdbc.username}
  3. jdbc.passworkd=${pom.jdbc.password}

配置 resource 插件，启用filtering功能并添加属性到pom：

  1. <project>
  2.  ...
  3.  <!-- 用pom里定义的属性做替换 -->
  4.  <properties>
  5.   <pom.jdbc.url>jdbc:mysql://127.0.0.1:3306/dev</pom.jdbc.url>
  6.   <pom.jdbc.username>root</pom.jdbc.username>
  7.   <pom.jdbc.password>123456</pom.jdbc.password>
  8.  </properties>
  9.  <build>
  10.   ...
  11.   <!-- 可以把属性写到文件里,用属性文件里定义的属性做替换 -->
  12.   <filters>
  13.    <filter>src/main/filters.properties</filter>
  14.   </filters>
  15.   <resources>
  16.    <resource>
  17.     <directory>src/main/resources</directory>
  18.     <filtering>true</filtering>
  19.    </resource>
  20.   </resources>
  21.   ...
  22.  </build>
  23.  ...
  24. </project>

编译包后 target 目录下的 jdbc.properties :

  1. jdbc.url=jdbc:mysql://127.0.0.1:3306/dev
  2. jdbc.username=root
  3. jdbc.passworkd=123456

文章到这里就差不多了，最后，为各位小伙伴默默奉上源代码：传送门

到此这篇关于使用maven的profile构建不同环境配置的方法的文章就介绍到这了,更多相关maven profile构建不同环境配置内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue！

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Maven热门文章

  • 使用maven如何将项目中的test代码打包进jar中
  • Maven多模块及version修改的实现方法
  • 详细docker-maven-plugin使用方法
  • 解决maven打包失败:程序包xxxx不存在问题
  • spring-boot-maven-plugin引入出现爆红(已解决)
  • maven系列：deploy项目发布和上传repo仓库
  • 解决maven没有打包xml文件的问题
  • springboot实现maven多模块和打包部署
  • 如何修改maven默认的JDK版本
  • maven-compiler-plugin版本指定方式

    • Maven推荐文章

  • Maven 整理
  • 从零开始搭建Springboot开发环境(Java8+Git+Maven+MySQL+Idea)之一步到位
  • 研发提效必备技能：手把手教你基于Docker搭建Maven私服仓库
  • 从0开始用Maven
  • 这次弄一下maven 多模块项目，用vscode新建一下，便于管理项目
  • Java Maven Settings配置参考
  • [Maven] maven插件系列之maven-shade-plugin
  • 一键搞定发布自己Jar到Maven中央仓库
  • Maven进阶学习指南
  • Maven依赖冲突解决总结

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号