生成配置文件是一组可以用来设置或覆盖Maven构建配置值的默认值。使用生成配置文件,你可以自定义构建针对不同的环境,如生产V / S开发环境。
配置文件中指定在pom.xml文件利用其积极的配置文件/配置文件元素和多种方式被触发。配置文件修改POM,在编译的时候,是用来给不同的目标环境参数(例如,数据库服务器的路径的开发,测试和生产环境)。
建立配置文件文件的主要有三种类型
类型 | 哪里定义 |
---|---|
Per Project | Defined in the project POM file, pom.xml |
Per User | Defined in Maven settings xml file (%USER_HOME%/.m2/settings.xml) |
Global | Defined in Maven global settings xml file (%M2_HOME%/conf/settings.xml) |
Maven构建配置文件文件,可以以各种方式激活。
明确使用命令控制台输入。
通过Maven的设置。
基于环境变量(用户/系统变量)。
OS设置(例如,Windows系列)。
呈现/丢失的文件。
让我们假设你的项目如下的目录结构:
现在下src/main/resources 有三个特定的文件:
文件名称 | 描述 |
---|---|
env.properties | default configuration used if no profile is mentioned. |
env.test.properties | test configuration when test profile is used. |
env.prod.properties | production configuration when prod profile is used. |
在下面的例子中,我们会附上maven-antrun-plugin:run插件:运行测试阶段的目标。这将使我们能够为不同的配置文件文件呼应文本消息。我们将使用pom.xml中定义不同的配置文件,在命令控制台使用maven命令将启动配置文件。
假设,我们建立如下的pom.xml在C:/MVN/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:/MVN/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测试正常。
更新任务部分呼应env.properties和将env.properties复制到目标目录
再次重复上述三个步骤,更新ID以刺激和任务部分env.prod.properties
这就是全部。现在你准备建立配置文件文件(正常/测试/产品)。
现在,打开命令控制台,进入到该文件夹包含的pom.xml和执行以下mvn命令。通过配置文件名作为参数使用-P选项。
C:/MVN/project>mvn test -Pnormal
C:/MVN/project>mvn test -Pprod
建立检查输出看到其中的差别。
打开Maven的settings.xml文件可在%USER_HOME%/.m2目录%USER_HOME%表示用户的主目录。 settings.xml文件如果不存在,那么创建一个新的。
作为活性配置文件文件中添加测试配置文件文件,如下面的例子使用activeProfiles节点
<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:/MVN/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:/MVN/project>mvn test
激活元件包括操作系统的细节,如下所示。该测试配置文件文件时,将触发的系统是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:/MVN/project>mvn test
载入激活元件包括操作系统的细节,如下所示。测试配置文件将触发缺少target/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:/MVN/project>mvn test