【开发】Maven Pom文件总结

Maven

maven生命周期

  • clean: 删除构建目录
  • validate: 检查工程配置是否正确,完成构建过程的所有必要信息是否能够获取到。
  • compile: 编译工程源码
  • test: 使用适当的单元测试框架(例如JUnit)运行测试。
  • package: 获取编译后的代码,并按照可发布的格式进行打包,例如 JAR、WAR 或者 EAR 文件
  • verify: 运行检查操作来验证工程包是有效的,并满足质量要求。
  • install: 安装工程包到本地仓库中,该仓库可以作为本地其他工程的依赖。
  • site: 创建新的报告文档、部署站点等
  • deploy: 拷贝最终的工程包到远程仓库中,以共享给其他开发人员和工程。

pom.xml常用节点

基本信息

<modelVersion>4.0.0</modelVersion>
<groupId>com.xstore.order.production</groupId>
<artifactId>xstore-order-production</artifactId>
<name>xstore-order-production</name>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>

groupId, artifactId, name, version 构成应用的坐标

packaging 默认为 jar

packaging

default bindings

  • pom 声明该artifact仅仅是pom文件,是子模块的容器
  • jar
  • ejb
  • maven-plugin
  • war
  • ear
  • rar
version
  • SNAPSHOT:快照版本
  • ALPHA:内测版本
  • BETA:公测版本
  • RELEASE:稳定版本
  • GA:正式发布

properties

dependencyManagement

build

Core Maven Plugins

The Resources Plugin

资源插件将文件从输入资源目录复制到输出目录。

  • resources: 将main源码下的资源文件复制到main输出目录中
  • testResources: 将test源码下的资源文件复制到test输出目录中
  • copy-resources: 讲任意资源文件复制到输出目录中,需要指定来源和输出目录
<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <version>3.0.2</version>
    <configuration>
        <outputDirectory>output-resources</outputDirectory>
        <resources>
            <resource>
                <directory>input-resources</directory>
                <excludes>
                    <exclude>*.png</exclude>
                </excludes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </configuration>
</plugin>

上面的配置,将input-resources中的资源文件复制到output-resuorces中,并且排除了以png为后缀的文件。

其中filtering设置为true,则会用properties中声明的变量替换资源文件中的占位符变量:

<properties>
    <resources.name>Baeldung</resources.name>
</properties>

将替代资源文件中包含如下文本的地方:

Welcome to ${resources.name}!
The Compiler Plugin

用以构建源码

  • compile 编译main下的源码
  • testCompile 编译test下的源码
<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.7.0</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
    </configuration>
</plugin>

方便起见,可以将版本号声明为一个属性:

<properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
</properties>

可以做一些额外的设置,如警告unchecked操作:

<configuration>
    <compilerArgs>
        <arg>-Xlint:unchecked</arg>
    </compilerArgs>
</configuration>
The Surefire Plugin

用于执行单元测试,默认情况下将在target/surefire-reports中生成xml报告

默认情况下,surefire将自动包含所有以Test开始或以Test,Tests,TestCase结束的测试类

包含在顶级POM中

  • test 默认选项的goal
<plugin>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.21.0</version>
    <configuration>
        <excludes>
            <exclude>DataTest.java</exclude>
        </excludes>
        <includes>
            <include>DataCheck.java</include>
        </includes>
    </configuration>
</plugin>
The Failsafe Plugin

用于项目的集成测试

与surefire插件不同的是,它必须在pom.xml中明确指定goal的值

  • integeration-test: 运行集成测试,测试失败不会令构建失败
  • verify: 确认集成测试通过
<plugin>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>2.21.0</version>
    <executions>
        <execution>
            <goals>
                <goal>integration-test</goal>
                <goal>verify</goal>
            </goals>
            <configuration>
                ...
            </configuration>
        </execution>
    </executions>
</plugin>

默认包含如下测试文件:

<includes>
    <include>**/IT*.java</include>
    <include>**/*IT.java</include>
    <include>**/*ITCase.java</include>
</includes>

IT -> Integration Test

The Verifier Plugin

确保文件和目录的存在或不存在,也可以根据正则表达式检查文件的内容

  • verify 显式指定时才会触发该插件
<plugin>
    <artifactId>maven-verifier-plugin</artifactId>
    <version>1.1</version>
    <configuration>
        <verificationFile>input-resources/verifications.xml</verificationFile>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>verify</goal>
            </goals>
        </execution>
    </executions>
</plugin>

默认的检查文件位于src/test/verifier/verifications.xml,如果想要使用别的文件,需要指定verificationFile参数

下面的校验要求input-resources/baeldung.txt存在单词Welcome

<verifications
  xmlns="http://maven.apache.org/verifications/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/verifications/1.0.0 
  http://maven.apache.org/xsd/verifications-1.0.0.xsd">
    <files>
        <file>
            <location>input-resources/baeldung.txt</location>
            <contains>Welcome</contains>
        </file>
    </files>
</verifications>
The Install Plugin

将应用打包至本地仓库中。这个插件包含在顶级POM中,因此不需要显式的包含它

The Deploy Plugin

将包部署到远程Maven仓库中。

distributionManagement

用以定义要部署的仓库的信息

modules

Maven Pom Modules

<modules>
  <module>my-project</module>
  <module>another-project</module>
  <module>third-project/pom-example.xml</module>
</modules>

无需考虑项目之间的依赖关系,maven会确保依赖的模块优先被构建

Maven 项目管理

https://blog.csdn.net/AAzpf/article/details/79650139

http://www.codebelief.com/article/2017/10/maven-best-practice-to-manage-multi-module-project/

使用maven进行模块管理,每个模块下面都有一个pom文件,pom中维护各模块之间的依赖和继承关系。

项目模块化可以将通用的部分抽离出来,方便重用。修改一部分代码不再需要build整个项目,缩短了build时间。

Maven 依赖管理

http://ifeve.com/maven-dependency-mechanism/

传递性依赖

假设你的项目依赖于一个库,而这个库又依赖于其他库。你不必自己去找出所有这些依赖,你只需要加上你直接依赖的库,Maven会隐式的把这些库间接依赖的库也加入到你的项目中。当项目中出现多个版本构件依赖的情形,依赖调解决定最终应该使用哪个版本。项目会选择依赖关系树中路径最短的版本作为依赖。当两个版本的依赖路径长度一致时,POM中依赖声明的顺序决定了哪个版本会被使用,也叫作”第一声明原则”。

依赖范围

  • compile 默认范围
  • provided provided范围表明你希望由JDK或者某个容器提供运行时依赖。如Servlet API和相关的Java EE APIs,会由web容器提供运行时依赖。provided依赖只对编译和测试classpath有效,并且不能传递。
  • runtime 编译时不需要依赖,而只在运行时依赖。此依赖范围对运行和测试classpath有效,对编译classpath无效。
  • test 只在编译测试代码和运行测试的时候需要,应用的正常运行不需要此类依赖。
  • system 系统范围与provided类似,不过你必须显式指定一个本地系统路径的JAR,此类依赖应该一直有效,Maven也不会去仓库中寻找它。
  • import import范围只适用于pom文件中的<dependencyManagement>部分。表明指定的POM必须使用<dependencyManagement>部分的依赖。因为依赖已经被替换,所以使用import范围的依赖并不影响依赖传递。

依赖管理

Maven提供了一个机制来集中管理依赖信息,叫做依赖管理元素<dependencyManagement>。假设你有许多项目继承自同一个公有的父项目,那可以把所有依赖信息放在一个公共的POM文件,并且在子POM中简单第引用该构件即可。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271