构建配置文件是一组配置值,可用于设置或覆盖Maven构建的默认值.使用构建配置文件,您可以为不同的环境(例如Production v/s开发环境)自定义构建.
使用其activeProfiles/profiles元素在pom.xml文件中指定配置文件并在各种方式.配置文件在构建时修改POM,用于为不同的目标环境提供参数(例如,开发,测试和生产环境中的数据库服务器的路径).
构建配置文件主要有三种类型.
Type | 定义的地方 |
---|---|
每个项目 | 在项目POM文件中定义,pom.xml |
每位用户 | 在Maven设置xml文件中定义(%USER_HOME%/.m2/settings. xml) |
全局 | 在Maven全局设置xml文件中定义(%M2_HOME %/conf/settings.xml) |
Maven可以通过各种方式激活构建配置文件.
明确使用命令控制台输入.
通过maven设置.
基于环境变量(用户/系统变量).
操作系统设置(例如,Windows系列).
存在/丢失文件.
让我们假设项目的以下目录结构 :
现在,在 src/main/resources 下,有三个特定于环境的文件 :
Sr.No. | 文件名&说明 |
---|---|
1 | env.properties 如果没有提到个人资料,则使用默认配置. |
2 | env.test.properties 在使用测试配置文件时测试配置. |
3 | env.prod.属性 使用prod配置文件时的生产配置. |
在下面的示例中,我们将附加maven-antrun-plugin:run goal来测试阶段.这将允许我们回显不同配置文件的文本消息.我们将使用pom.xml定义不同的配置文件,并使用maven命令在命令控制台上激活配置文件.
假设我们在C:\ MVVN中创建了以下pom.xml \ project文件夹.
<project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.companyname.projectgroup</groupId> <artifactId>project</artifactId> <version>1.0</version> <profiles> <profile> <id>test</id> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-antrun-plugin</artifactId> <version>1.1</version> <executions> <execution> <phase>test</phase> <goals> <goal>run</goal> </goals> <configuration> <tasks> <echo>Using env.test.properties</echo> <copy file="src/main/resources/env.test.properties" tofile="${project.build.outputDirectory} /env.properties"/> </tasks> </configuration> </execution> </executions> </plugin> </plugins> </build> </profile> </profiles> </project>
现在打开命令控制台,转到包含pom.xml的文件夹并执行以下 mvn 命令.使用-P选项将配置文件名称作为参数传递.
C:\ MVNN \ project> mvn test -Ptest
Maven将开始处理并显示测试构建配置文件的结果.
[INFO] Scanning for projects... [INFO] ------------------------------------------------------------------ [INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0 [INFO] task-segment: [test] [INFO] ------------------------------------------------------------------ [INFO] [resources:resources {execution: default-resources}] [WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] Copying 3 resources [INFO] [compiler:compile {execution: default-compile}] [INFO] Nothing to compile - all classes are up to date [INFO] [resources:testResources {execution: default-testResources}] [WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] skip non existing resourceDirectory C:\MVN\project\src\test\resources [INFO] [compiler:testCompile {execution: default-testCompile}] [INFO] Nothing to compile - all classes are up to date [INFO] [surefire:test {execution: default-test}] [INFO] Surefire report directory: C:\MVN\project\target\surefire-reports ------------------------------------------------------- T E S T S ------------------------------------------------------- There are no tests to run. Results : Tests run: 0, Failures: 0, Errors: 0, Skipped: 0 [INFO] [antrun:run {execution: default}] [INFO] Executing tasks [echo] Using env.test.properties [INFO] Executed tasks [INFO] ------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------ [INFO] Total time: 1 second [INFO] Finished at: Sun Jul 08 14:55:41 IST 2012 [INFO] Final Memory: 8M/64M [INFO] ------------------------------------------------------------------
现在作为练习,你可以执行以下步骤 :
将另一个配置文件元素添加到pom.xml的profiles元素中(复制现有的配置文件元素并将其粘贴到配置文件元素结束的位置).
将此配置文件元素的id从test更新为正常.
更新任务部分以回显env.properti将env.properties复制到目标目录.
再次重复上述三个步骤,将id更新为prod,将任务部分更新为env.prod.properties./p>
这就是全部.现在你已准备好三个构建配置文件(正常/测试/产品).
现在打开命令控制台,转到包含的文件夹pom.xml并执行以下 mvn 命令.使用-P选项将配置文件名称作为参数传递.
C:\ MVNn \ project> mvn test -Pnormal C:\ MVNn \ project> mvn test -Pprod
检查构建的输出以查看差异.
在%USER_HOME%/.m2目录中打开Maven settings.xml 文件,其中%USER_HOME %表示用户主目录.如果不存在settings.xml文件,则创建一个新文件.
使用活动的"个人档案"节点将测试个人档案添加为活动的个人档案,如下例所示.
<settings xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <mirrors> <mirror> <id>maven.dev.snaponglobal.com</id> <name>Internal Artifactory Maven repository</name> <url>http://repo1.maven.org/maven2/</url> <mirrorOf>*</mirrorOf> </mirror> </mirrors> <activeProfiles> <activeProfile>test</activeProfile> </activeProfiles> </settings>
现在打开命令控制台,转到包含pom.xml的文件夹并执行以下 mvn 命令.不要使用-P选项传递配置文件名称. Maven将显示测试配置文件的结果为活动配置文件.
C:\ MVNn \ project> mvn test
现在从maven settings.xml中删除活动配置文件并更新pom.xml中提到的测试配置文件.将激活元素添加到profile元素,如下所示.
当使用值"test"指定系统属性"env"时,将触发测试配置文件.创建一个环境变量"env"并将其值设置为"test".
<profile> <id>test</id> <activation> <property> <name>env</name> <value>test</value> </property> </activation> </profile>
让我们打开命令控制台,转到包含pom.xml的文件夹并执行以下 mvn 命令.
C:\ MVNn \ project> mvn test
激活元素包含os详细信息,如下所示.当系统是Windows XP时,将触发此测试配置文件.
<profile> <id>test</id> <activation> <os> <name>Windows XP</name> <family>Windows</family> <arch>x86</arch> <version>5.1.2600</version> </os> </activation> </profile>
现在打开命令控制台,转到包含pom.xml的文件夹并执行以下 mvn 命令.不要使用-P选项传递配置文件名称. Maven将显示测试配置文件的结果为活动配置文件.
C:\ MVNn \ project> mvn test
现在激活元素包含操作系统详细信息,如下所示.当目标/generated-sources/axistools/wsdl2java/com/companyname/group 缺失时,将触发测试配置文件.
<profile> <id>test</id> <activation> <file> <missing>target/generated-sources/axistools/wsdl2java/ com/companyname/group</missing> </file> </activation> </profile>
现在打开命令控制台,转到包含pom.xml的文件夹并执行以下 mvn 命令.不要使用-P选项传递配置文件名称. Maven将显示测试配置文件的结果为活动配置文件.
C:\ MVNn \ project> mvn test