maven 构建配置文件——迹忆客-ag捕鱼王app官网
什么是构建配置文件(build profile) ?
构建配置文件是一系列的配置项的值,可以用来设置或者覆盖 maven 构建默认值。
使用构建配置文件,你可以为不同的环境,比如说生产环境(production)和开发(development)环境,定制构建方式。
配置文件在 pom.xml 文件中使用 activeprofiles 或者 profiles 元素指定,并且可以通过各种方式触发。配置文件在构建时修改 pom,并且用来给参数设定不同的目标环境(比如说,开发(development)、测试(testing)和生产环境(production)中数据库服务器的地址)。
构建配置文件的类型
构建配置文件大体上有三种类型:
类型 | 在哪定义 |
---|---|
项目级(per project) | 定义在项目的pom文件pom.xml中 |
用户级 (per user) | 定义在maven的设置xml文件中 (%user_home%/.m2/settings.xml) |
全局(global) | 定义在 maven 全局的设置 xml 文件中 (%m2_home%/conf/settings.xml) |
激活配置文件
maven的构建配置文件可以通过多种方式激活。
- 使用命令控制台输入显式激活。
- 通过 maven 设置。
- 基于环境变量(用户或者系统变量)。
- 操作系统设置(比如说,windows系列)。
- 文件的存在或者缺失。
配置文件激活实例
假定项目结构如下:
其中在src/main/resources文件夹下有三个用于测试文件:
文件名 | 描述 |
---|---|
env.properties | 如果未指定配置文件时默认使用的配置。 |
env.test.properties | 当测试配置文件使用时的测试配置。 |
env.prod.properties | 当生产配置文件使用时的生产配置。 |
注意 :这三个配置文件并不是代表构建配置文件的功能,而是用于本次测试的目的;比如,我指定了构建配置文件为 prod 时,项目就使用 env.prod.properties文件。
注意 :下面的例子仍然是使用 antrun 插件,因为此插件能绑定 maven 生命周期阶段,并通过 ant 的标签不用编写一点代码即可输出信息、复制文件等,经此而已。其余的与本次构建配置文件无关。
显式配置文件激活
在下面的示例中,我们将添加 maven-antrun-plugin:run 目标来测试阶段。 这将允许我们为不同的配置文件回显文本消息。 我们将使用 pom.xml 定义不同的配置文件,并将使用 maven 命令在命令控制台激活配置文件。
pom.xml
4.0.0 com.companyname.projectgroup project 1.0 test org.apache.maven.plugins maven-antrun-plugin 1.1 test run using env.test.properties
现在打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。 使用 -p 选项将配置文件名称作为参数传递。
$ mvn test -ptest
maven 将开始处理并显示测试构建配置文件的结果。
[info] scanning for projects...
[info]
[info] ----------------< com.companyname.projectgroup:project >----------------
[info] building project 1.0
[info] --------------------------------[ jar ]---------------------------------
[info]
[info] --- maven-resources-plugin:2.6:resources (default-resources) @ project ---
[warning] using platform encoding (utf-8 actually) to copy filtered resources, i.e. build is platform dependent!
[info] copying 1 resource
[info]
[info] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---
[info] nothing to compile - all classes are up to date
[info]
[info] --- maven-resources-plugin:2.6:testresources (default-testresources) @ project ---
[warning] using platform encoding (utf-8 actually) to copy filtered resources, i.e. build is platform dependent!
[info] skip non existing resourcedirectory /users/liuhanzeng/workspace/java/hello_maven/src/test/resources
[info]
[info] --- maven-compiler-plugin:3.1:testcompile (default-testcompile) @ project ---
[info] nothing to compile - all classes are up to date
[info]
[info] --- maven-surefire-plugin:2.12.4:test (default-test) @ project ---
[info] no tests to run.
[info]
[info] --- maven-antrun-plugin:1.1:run (default) @ project ---
[info] executing tasks
[echo] using env.test.properties
[info] executed tasks
[info] ------------------------------------------------------------------------
[info] build success
[info] ------------------------------------------------------------------------
[info] total time: 0.645 s
[info] finished at: 2022-03-01t18:37:30 08:00
[info] ------------------------------------------------------------------------
现在作为练习,可以执行以下步骤
- 将另一个配置文件元素添加到 pom.xml 的配置文件元素(复制现有配置文件元素并将其粘贴到配置文件元素的结尾处)。
- 将此配置文件元素的 id 从 test 更新为 normal。
- 更新任务部分以回显 env.properties 并将 env.properties 复制到目标目录。
- 再次重复上述三个步骤,将 id 更新为 prod 和 env.prod.properties 的任务部分。
- 就这样。 现在您已经准备好三个构建配置文件(normal/test/prod)。
现在打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。 使用 -p 选项将配置文件名称作为参数传递。
$ mvn test -pnormal
$ mvn test -pprod
通过 maven 设置激活配置文件
打开 %user_home%/.m2
目录中的 maven settings.xml 文件,其中 %user_home% 代表用户主目录。 如果 settings.xml 文件不存在,则创建一个新文件。
使用活动配置文件节点将测试配置文件添加为活动配置文件,如下例所示。
maven.dev.snaponglobal.com
internal artifactory maven repository
http://repo1.maven.org/maven2/
*
test
现在打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。 不要使用 -p 选项传递配置文件名称。 maven 将显示测试配置文件是活动配置文件的结果。
$ mvn test
通过环境变量激活配置文件
现在从 maven settings.xml 中删除活动配置文件并更新 pom.xml 中提到的测试配置文件。 将激活元素添加到配置文件元素,如下所示。
当系统属性“env”被指定为“test”时,将触发测试配置文件。 创建一个环境变量“env”并将其值设置为“test”。
test
env
test
让我们打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。
$ mvn test
通过操作系统激活配置文件
激活元素包括操作系统详细信息,如下所示。 此测试配置文件将在系统为 windows xp 时触发。
test
windows xp
windows
x86
5.1.2600
现在打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。 不要使用 -p 选项传递配置文件名称。 maven 将显示测试配置文件是活动配置文件的结果。
$ mvn test
通过当前/缺失文件激活配置文件
现在激活元素包含操作系统详细信息,如下所示。 当缺少 target/generated-sources/axistools/wsdl2java/com/companyname/group 时,将触发测试配置文件。
test
target/generated-sources/axistools/wsdl2java/
com/companyname/group
现在打开命令控制台,转到包含 pom.xml 的文件夹并执行以下 mvn 命令。 不要使用 -p 选项传递配置文件名称。 maven 将显示测试配置文件是活动配置文件的结果。
$ mvn test