Maven之pom.xml文件中的Build配置解析

目录

• 前言
• 正文
• mave的相关插件
• pom.xml中的build标签
• 1. pom.xml中的两种build
• 2. Profile Build和Project Build的共有元素
• 3. Project Build特有的<…Directory>
• 4. Project Build特有的
• Maven常用配置
• pom.xml基础配置
• 插件配置
• 编译插件
• 测试插件
• 测试报告插件
• eclipse插件
• war包插件
• tomcat插件
• 插件命令
• 总结

前言

在日常的开发中,我们经常使用maven来管理和构建我们的项目,即使现在使用了各种springboot等方便快捷的框架,jar包的引入也是通过maven来进行的,因此有必要了解pom.xml文件中的没一项配置.

正文

mave的相关插件

首先,关于maven我们要有一定的认识:

• maven能帮我们构建工程,管理jar包,编译代码,还能帮我们自动运行单元测试,生成报表,甚至部署项目.
• 使用maven构建的项目均可以直接使用maven build完成项目的编译测试打包,无需额外的配置.
• maven是通过pom.xml来执行任务的.其中的build标签描述了如何来编译打包项目,而具体的编译和打包工作是通过build中配置的plugin来完成的.

默认情况下,maven会绑定一下几个插件来完成基本操作

plugin	funcation	life cycle phase
maven-clean-plugin	清理上一次执行创建的目标文件	clean
maven-resources-plugin	处理源资源文件和测试资源文件	resources;testResources
maven-compiler-plugin	编译源文件和测试源文件	compile,testCompile
maven-surefire-plugin	执行测试文件	test
maven-jar-plugin	创建jar	jar
maven-install-plugin	安装jar,将创建生成的jar拷贝到.m2/repository下面	install
maven-deploy-plugin	发布jar	deploy

在没有配置的情况下,执行maven clean install时,maven会调用默认的plugin来完成编译打包操作,具体会执行以下plugin:

maven-clean-plugin:2.5:clean (default-clean)
maven-resources-plugin:2.6:resources (default-resources)
maven-compiler-plugin:3.1:compile (default-compile)
maven-resources-plugin:2.6:testResources (default-testResources)
maven-compiler-plugin:3.1:testCompile (default-testCompile)
maven-surefire-plugin:2.12.4:test (default-test)
maven-jar-plugin:2.4:jar (default-jar)
maven-install-plugin:2.4:install (default-install)

如果有需要可以针对各个plugin进行特殊的配置,需要在pom.xml文件中的标签中显示指定plugin和对应的属性配置.

在后面会有对每一个plugin配置的实例来供参考

pom.xml中的build标签

在Maven的pom.xml文件中,Build相关的配置包含两个部分:一个是,另一个是,这里只介绍.

1. pom.xml中的两种build

在Maven的pom.xml文件中,存在如下两种<build>:

<project>
    <build>...</build>

    <profiles>
     <profile>
            <build>...</build>
        </profile>
    </profiles>
</project>    

说明: 第一种被称为Project Build,即是<project>的直接子元素.另一种<build>被称为Profile Build,即是<profile>的直接子元素.

Profile Build包含了基本的build元素,而Project Build还包含两个特殊的元素,即各种和.

2. Profile Build和Project Build的共有元素

共用的基本build元素

<build>
    <defaultGoal>install</defaultGoal>
    <directory>${basedir}</directory>
    <finalName>${artifactId}-${version}</finalName>
</build>

• defaultGoal: 执行构建时默认的goal或phase,如jar或者package等
• directory: 构建的结果所在的路径,默认为${basedir}/target目录
• finalName: 构建的最终结果的名字,该名字可能在其他plugin中被改变

资源往往不是代码,无需编译,而是一些properties或XML配置文件,构建过程往往会将资源文件从源路径复制到指定的目标路径.

给出各个资源在Maven项目中的具体路径.示例如下:

说明:

• resource：build过程中涉及的资源文件
• targetPath：资源文件的目标路径
• filtering：构建过程中是否对资源进行过滤,默认false
• directory：资源文件的路径,默认位于${basedir}/src/main/resources目录下
• includes：一组文件名的匹配模式,被匹配的资源文件将被构建过程处理
• excludes：一组文件名的匹配模式,被匹配的资源文件将被构建过程忽略,同时被includes和excludes匹配的资源文件,将被忽略.
• filters：给出对资源文件进行过滤的属性文件的路径,默认位于${basedir}/src/main/filters/目录下.属性文件中定义若干键值对.在构建过程中,对于资源文件中出现的变量(键),将使用属性文件中该键对应的值替换.
• testResources：test过程中涉及的文件,默认位于${basedir}/src/test/resources/目录下,这里的资源文件不会被构建到目标构建中.

给出构建过程中所用到的插件.

说明:

• extensions：是否加载该插件的扩展,默认false
• inherited：该插件的configuration中的配置是否可以被继承,默认true
• configuration：该插件所需要的特殊配置,在父子项目之间可以进行覆盖或者合并
• dependencies：该插件所特有的依赖类库
• executions：该插件的某个goal(一个插件可能包含多个goal)的执行方式.一个execution有如下配置:
• id：唯一标识
• goals：要执行插件的goal,可以有多个,如<goal>run</goal>
• phase：插件的goal要嵌入到Maven的phase中执行,如verify
• inherited：该execution是否可以被子项目继承
• configuration：该execution的其他配置参数

在中,与并列,两者之间的关系类似于与之间的关系.中也配置,其配置参数与中的完全一致.只是,往往出现在父项目中,其中配置的往往通用于子项目.

子项目只要在中声明该插件,该插件的具体配置参数则继承自父项目中对该插件的配置,从而避免了在子项目中重复配置.

3. Project Build特有的<…Directory>

往往配置在父项目中,供所有父子项目使用.使用如下:

目录可以使用绝对路径,如果使用相对路径,则所有的相对路径都是在${basedir}目录下.

4. Project Build特有的

是执行构建过程中可能用到的其他工具,在执行构建的过程中被加入到classpath中.也可以通过激活构建插件,从而改变构建的过程.具体使用如下:

Maven默认的输入和输出目录

在构建Maven项目的时候,如果没有进行特殊配置,Maven会按照标准的目录结构查找和处理各种类型文件.

• src/main/java和src/test/java

这两个目录中的所有*.java文件会分别在comile和test-comiple阶段被编译,编译结果分别被放到了target/classes和target/test-classes目录中,但是这两个目录中的其他文件会被忽略掉.

• src/main/resources和src/text/resources

这两个目录中的文件也会分别被复制到target/classes和target/test-classes目录中.

当项目是web项目时,会在target目录下生成myProject目录,myProject是你的项目名

• src/main/webapps

这个目录中的文件会被复制到target/myProject目录中.

• target/classes

默认会把这个目录中的所有内容复制到target/myProject/WEB-INF/calssess中

• Dependency

默认会将项目的依赖复制到target/myProject/WEB-INF/lib

Maven常用配置

pom.xml基础配置

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring.framework.version>3.0.5.RELEASE</spring.framework.version>
        <cxf.version>2.3.2</cxf.version>
        <tiles.version>2.2.2</tiles.version>
    </properties>

我需要让整个项目统一字符集编码，就需要设定**<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**；

如果我需要让spring统一版本号，可以设置这么个变量**<spring.framework.version>3.0.5.RELEASE</spring.framework.version>**，

当然，maven不会那么乖乖的自动识别这些配置。

当然，**<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**默认还是可以识别的！

插件配置

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.4.3</version>
        <configuration>
            <encoding>${project.build.sourceEncoding}</encoding>
        </configuration>
    </plugin>

xml、properties文件都是资源文件，编码的时候遇到中文总要进行转码！用什么编码？UTF-8,那就记得强制**${project.build.sourceEncoding},虽然<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**默认可以识别，但是我还是觉得不放心。

编译插件

这个插件就是个默认配置，不过我还是谨慎的配置了jdk编译版本跟字符集设置：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.0.2</version>
        <configuration>
            <source>1.6</source>
            <target>1.6</target>
            <encoding>${project.build.sourceEncoding}</encoding>
        </configuration>
    </plugin>

• <source>1.6</source> ：源代码编译版本；
• <target>1.6</target> ：目标平台编译版本；
• <encoding>${project.build.sourceEncoding}</encoding>：字符集编码

如果你用eclipse建立maven项目时，新建的项目往往JDK版本很低——1.5！怎么办？修改settings.xml文件：

<profile>
        <id>jdk-1.6</id>
        <activation>
            <activeByDefault>true</activeByDefault>
            <jdk>1.6</jdk>
        </activation>
        <properties>
            <maven.compiler.source>1.6</maven.compiler.source>
            <maven.compiler.target>1.6</maven.compiler.target>
            <maven.compiler.compilerVersion>1.6</maven.compiler.compilerVersion>
        </properties>
    </profile>

eclipse会很听话的构建一个JDK1.6版本的maven项目！

测试插件

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.7.2</version>
        <configuration>
            <parallel>methods</parallel>
            <threadCount>10</threadCount>
            <argLine>-Dfile.encoding=UTF-8</argLine>
            <!-- <skip>true</skip> -->
            <!-- <testFailureIgnore>true</testFailureIgnore> -->
        </configuration>
    </plugin>

• <parallel>methods</parallel>：方法级并发；
• <threadCount>10</threadCount>：是线程数，当前是10；
• <argLine>-Dfile.encoding=UTF-8</argLine>：就是参数命令行，这一行很关键。

测试插件有个小问题，它不依赖项目的字符集设置，它依赖于操作系统。如果你用命令行操作，看中文提示测试结果还好。

• 但在win+eclipse（UTF-8设置）下，那就是乱码了；
• <skip>true</skip>是忽略测试；
• <testFailureIgnore>true</testFailureIgnore>：忽略测试异常；

测试报告插件

要测试，就要有报告，知晓测试覆盖率，这就需要clover：

<plugin>
        <groupId>maven</groupId>
        <artifactId>maven-clover-plugin</artifactId>
        <version>2.4.2</version>
        <configuration>
            <encoding>${project.build.sourceEncoding}</encoding>
        </configuration>
    </plugin>

安全起见，我还是要强制字符集编码设置：

<encoding>${project.build.sourceEncoding}</encoding>

可以使用 mvn cobertura:cobertura 产生测试覆盖率报告！

eclipse插件

在eclipse下进行maven项目开发，还是需要eclipse相应的插件：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-eclipse-plugin</artifactId>
        <version>2.8</version>
        <configuration>
            <wtpmanifest>true</wtpmanifest>
            <wtpapplicationxml>true</wtpapplicationxml>
            <wtpversion>2.0</wtpversion>
            <downloadSources>true</downloadSources>
            <downloadJavadocs>true</downloadJavadocs>
        </configuration>
    </plugin>

• <wtpmanifest>true</wtpmanifest>：产生manifest文件
• <wtpapplicationxml>true</wtpapplicationxml>：产生web.xml文件
• <wtpversion>2.0</wtpversion>：这是eclipse里面的wtp版本
• <downloadSources>true</downloadSources>：下载源代码
• <downloadJavadocs>true</downloadJavadocs>：下载源码文档

虽然这么配置了，但是由maven项目转为eclipse的wtp类型的项目时，所产生的文件根本没有实际意义。

web.xml文件的servlet版本很低，也许是我没有配置。对应的xml字符集的头标识也没有。

war包插件

既然是web项目，就需要打war包，那就需要这个插件：

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <version>2.1.1</version>
        <configuration>
            <encoding>${project.build.sourceEncoding}</encoding>
            <warName>platform</warName>
            <webappDirectory>${project.build.directory}/platform</webappDirectory>
            <warSourceDirectory>WebContent</warSourceDirectory>
        </configuration>
    </plugin>

• <encoding>${project.build.sourceEncoding}</encoding>强制字符集编码
• <warName>platform</warName>war包名字——platform.war
• <webappDirectory>${project.build.directory}/platform</webappDirectory>产生war前，用于存放构建war包的目录——target/platform。
• <warSourceDirectory>WebContent</warSourceDirectory>：我把web工程搞成了eclipse下的WTP类型。我不喜欢maven产生的webapp目录，更喜欢WebContent！

tomcat插件

我习惯于用tomcat作为JSP容器，对jetty多少有点陌生。不但如此，我还通过在Bamboo中配置命令让这个应用可以在tomcat中定时部署：

<plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>tomcat-maven-plugin</artifactId>
        <configuration>
            <charset>${project.build.sourceEncoding}</charset>
            <url>http://localhost:8080/manager</url>
            <server>tomcat.server</server>
            <path>/platform</path>
            <port>8080</port>
            <warFile>${project.build.directory}/platform.war</warFile>
            <warSourceDirectory>WebContent</warSourceDirectory>
            <uriEncoding>${project.build.sourceEncoding}</uriEncoding>
        </configuration>
    </plugin>

• <charset>${project.build.sourceEncoding}</charset>：字符集强制编码
• <url>http://localhost:8080/manager/text</url>：我这里已经使用了Tomcat7，如果是Tomcat6就不需要/text！
• <server>tomcat.server</server>这是个用户名设置

需要配置maven的settings.xml文件：

<servers>
        <server>
            <id>tomcat.server</id>
            <username>admin</username>
            <password>123456</password>
        </server>
    </servers>

别急，这时候还没完！

在tomcat的tomcat-users.xml中补充相关内容：

<role rolename="manager-gui"/>
    <role rolename="magager-script"/>
    <user username="admin" password="123456" roles="manager-gui,manager-script" />

• <port>8080</port>：运行时端口
• <path>/platform</path>：是运行时路径——http://host:port/platform
• <warFile>${project.build.directory}/platform.war</warFile>：我们以war包方式发布，需要指定war包路径。
• <warSourceDirectory>WebContent</warSourceDirectory>：同时要指定war包源码路径。这里我使用eclipse的WTP类型工程WebContent目录。
• <uriEncoding>${project.build.sourceEncoding}</uriEncoding>：强制字符集编码！

插件命令

#Run Tomcat
    mvn tomcat:run
    #Stop Tomcat
    #Deploy Tomcat
    mvn tomcat:deploy
    #Undeploy Tomcat
    mvn tomcat:undeploy
    #Redeploy Tomcat
    mvn tomcat:redeploy

总结

关于maven的使用，是需要经常查阅的，在这里做个记录，工作中有用到的可以来及时补充.

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。