Maven 翻译为”专家”、”内行”,是 Apache 下的一个纯 Java 开发的开源项目。基于项目对象模型(缩写:POM)概念,Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。
Maven 是一个项目管理工具,可以对 Java 项目进行构建、依赖管理。
Maven 也可被用于构建和管理各种项目,例如 C#,Ruby,Scala 和其他语言编写的项目。Maven 曾是 Jakarta 项目的子项目,现为由 Apache 软件基金会主持的独立 Apache 项目。
关于Maven的功能:
Maven 能够帮助开发者完成以下工作:
- 构建
- 文档生成
- 报告
- 依赖
- SCMs
- 发布
- 分发
- 邮件列表
Maven 提倡使用一个共同的标准目录结构,Maven 使用约定优于配置的原则,大家尽可能的遵守这样的目录结构。
如下表所示:
| 目录 | 目的 |
|---|---|
| ${basedir} | 存放pom.xml和所有的子目录 |
| ${basedir}/src/main/java | 项目的java源代码 |
| ${basedir}/src/main/resources | 项目的资源,比如说property文件,springmvc.xml |
| ${basedir}/src/test/java | 项目的测试类,比如说Junit代码 |
| ${basedir}/src/test/resources | 测试用的资源 |
| ${basedir}/src/main/webapp/WEB-INF | web应用文件目录,web项目的信息,比如存放web.xml、本地图片、jsp视图页面 |
| ${basedir}/target | 打包输出目录 |
| ${basedir}/target/classes | 编译输出目录 |
| ${basedir}/target/test-classes | 测试编译输出目录 |
| Test.java | Maven只会自动运行符合该命名规则的测试类 |
| ~/.m2/repository | Maven默认的本地仓库目录位置 |
Maven概要介绍
我们要先看一下Java项目需要的东西。 首先,我们需要确定引入哪些依赖包。 例如,如果我们需要用到commons logging,我们就必须把commons logging的jar包放入classpath。如果我们还需要log4j,就需要把log4j相关的jar包都放到classpath中。 这些就是依赖包的管理。
其次,我们要确定项目的目录结构。例如,
src目录存放Java源码,resources目录存放配置文件,bin目录存放编译生成的.class文件。 此外,我们还需要配置环境,例如JDK的版本,编译打包的流程,当前代码的版本号。 最后,除了使用Eclipse这样的IDE进行编译外,我们还必须能通过命令行工具进行编译,才能够让项目在一个独立的服务器上编译、测试、部署。 这些工作难度不大,但是非常琐碎且耗时。如果每一个项目都自己搞一套配置,肯定会一团糟。我们需要的是一个标准化的Java项目管理和构建工具。Maven就是是专门为Java项目打造的管理和构建工具,它的主要功能有:
- 提供了一套标准化的项目结构;
- 提供了一套标准化的构建流程(编译,测试,打包,发布……);
- 提供了一套依赖管理机制。
a-maven-project├── pom.xml├── src│ ├── main│ │ ├── java│ │ └── resources│ └── test│ ├── java│ └── resources└── target
Maven的下载安装与配置
下载安装
Maven 是一个基于 Java 的工具,所以要做的第一件事情就是安装 JDK。
如果您还没有安装JDK,请参考这篇文章JDK安装以及Java资源
如果您还不确定您是否已经安装了JDK
那么请输入如下命令查看:
| 选择您的操作系统 | 创建如下任务 | 输入如下命令查询 |
|---|---|---|
| Windows | 打开命令控制台 | c:\\> java -version |
| Linux | 打开命令终端 | # java -version |
| Mac | 打开终端 | $ java -version |
要安装Maven,可以从Maven官网下载最新的Maven 3.x.x,然后在本地解压,设置几个环境变量:
以下以3.3.9为例,根据自己所下载的版本,按需更改。
| 系统 | 配置 |
|---|---|
| Windows | 右键 “计算机”,选择 “属性”,之后点击 “高级系统设置”,点击”环境变量”,来设置环境变量,有以下系统变量需要配置: 新建系统变量 **MAVEN_HOME**,变量值:**E:\\Maven\\apache-maven-3.3.9**![]() 编辑系统变量 **Path**,添加变量值:**;%MAVEN_HOME%\\bin**![]() 注意:注意多个值之间需要有分号隔开,然后点击确定。 打开命令行窗口,输入 mvn -version,应该看到Maven的版本信息:如果提示命令未找到,说明系统 PATH路径有误,需要修复后再运行。 |
| Linux | 下载解压:# wget http://mirrors.hust.edu.cn/apache/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gz # tar -xvf apache-maven-3.3.9-bin.tar.gz # sudo mv -f apache-maven-3.3.9 /usr/local/编辑 /etc/profile 文件 sudo vim /etc/profile,在文件末尾添加如下代码: export MAVEN_HOME=/usr/local/apache-maven-3.3.9 export PATH=${PATH}:${MAVEN_HOME}/bin保存文件,并运行如下命令使环境变量生效: # source /etc/profile在控制台输入如下命令,如果能看到 Maven 相关版本信息,则说明 Maven 已经安装成功: # mvn -v |
| Mac | 下载解压:$ curl -O http://mirrors.hust.edu.cn/apache/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gz $ tar -xvf apache-maven-3.3.9-bin.tar.gz $ sudo mv -f apache-maven-3.3.9 /usr/local/编辑 /etc/profile 文件 sudo vim /etc/profile,在文件末尾添加如下代码: export MAVEN_HOME=/usr/local/apache-maven-3.3.9 export PATH=${PATH}:${MAVEN_HOME}/bin保存文件,并运行如下命令使环境变量生效: $ source /etc/profile在控制台输入如下命令,如果能看到 Maven 相关版本信息,则说明 Maven 已经安装成功: $ mvn -v Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-11T00:41:47+08:00) Maven home: /usr/local/apache-maven-3.3.9 Java version: 1.8.0_31, vendor: Oracle Corporation Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_31.jdk/Contents/Home/jre Default locale: zh_CN, platform encoding: ISO8859-1 OS name: "mac os x", version: "10.13.4", arch: "x86_64", family: "mac" |
Maven POM
POM是什么?
POM( Project Object Model,项目对象模型 ) 是 Maven 工程的基本工作单元,是一个XML文件,包含了项目的基本信息,用于描述项目如何构建,声明项目依赖,等等。 执行任务或目标时,Maven 会在当前目录中查找 POM。它读取 POM,获取所需的配置信息,然后执行目标。
POM 中可以指定以下配置:
- 项目依赖
- 插件
- 执行目标
- 项目构建 profile
- 项目版本
- 项目开发者列表
- 相关邮件列表信息
在创建 POM 之前,我们首先需要描述项目组 (groupId), 项目的唯一ID。
<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd"><!-- 模型版本 --><modelVersion>4.0.0</modelVersion><!-- 公司或者组织的唯一标志,并且配置时生成的路径也是由此生成, 如com.companyname.project-group,maven会将该项目打成的jar包放本地路径:/com/companyname/project-group --><groupId>com.companyname.project-group</groupId><!-- 项目的唯一ID,一个groupId下面可能多个项目,就是靠artifactId来区分的 --><artifactId>project</artifactId><!-- 版本号 --><version>1.0</version></project>
所有 POM 文件都需要project 元素和三个必需字段:groupId,artifactId,version。
| 节点 | 描述 |
|---|---|
| project | 工程的根标签。 |
| modelVersion | 模型版本需要设置为 4.0。 |
| groupId | 这是工程组的标识。它在一个组织或者项目中通常是唯一的。 例如,一个银行组织 com.companyname.project-group 拥有所有的和银行相关的项目。 |
| artifactId | 这是工程的标识。它通常是工程的名称。 例如,消费者银行。groupId 和 artifactId 一起定义了 artifact 在仓库中的位置。 |
| version | 这是工程的版本号。在 artifact 的仓库中,它用来区分不同的版本。例如: com.company.bank:consumer-banking:1.0 com.company.bank:consumer-banking:1.1 |
父(Super)POM
那么大家知道什么是POM了,可是父(Super)POM又是什么?
父(Super)POM是 Maven 默认的 POM。所有的 POM 都继承自一个父 POM(无论是否显式定义了这个父 POM)。父 POM 包含了一些可以被继承的默认设置。 因此,当 Maven 发现需要下载 POM 中的 依赖时,它会到 Super POM 中配置的默认仓库http://repo1.maven.org/maven2 去下载。
Maven 使用 _effective pom_(Super pom 加上工程自己的配置)来执行相关的目标,它帮助开发者在_ pom.xml_ 中做尽可能少的配置,当然这些配置可以被重写。
使用以下命令来查看 Super POM 默认配置:
:::info
mvn help:effective-pom
:::
接下来我们创建目录 MVN/project,在该目录下创建pom.xml,内容如下:
<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd"><!-- 模型版本 --><modelVersion>4.0.0</modelVersion><!-- 公司或者组织的唯一标志,并且配置时生成的路径也是由此生成, 如com.companyname.project-group,maven会将该项目打成的jar包放本地路径:/com/companyname/project-group --><groupId>com.companyname.project-group</groupId><!-- 项目的唯一ID,一个groupId下面可能多个项目,就是靠artifactId来区分的 --><artifactId>project</artifactId><!-- 版本号 --><version>1.0</version></project>
在命令控制台,进入 MVN/project目录,执行以下命令:
:::info
C:\MVN\project>mvn help:effective-pom
:::
Maven 将会开始处理并显示 effective-pom。
:::info
[INFO] Scanning for projects…
Downloading: https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-clean-plugin/2.5/maven-clean-plugin-2.5.pom
…
[INFO] ————————————————————————————————————
[INFO] BUILD SUCCESS
[INFO] ————————————————————————————————————
[INFO] Total time: 01:36 min
[INFO] Finished at: 2018-09-05T11:31:28+08:00
[INFO] Final Memory: 15M/149M
[INFO] ————————————————————————————————————
:::
Effective POM 的结果就像在控制台中显示的一样,经过继承、插值之后,使配置生效。
<?xml version="1.0" encoding="UTF-8"?><!-- ================================================================= --><!-- --><!-- Generated by Maven Help Plugin on 2012-07-05T11:41:51 --><!-- See: http://maven.apache.org/plugins/maven-help-plugin/ --><!-- --><!-- ================================================================= --><!-- ================================================================= --><!-- --><!-- Effective POM for project --><!-- 'com.companyname.project-group:project-name:jar:1.0' --><!-- --><!-- ================================================================= --><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.project-group</groupId><artifactId>project</artifactId><version>1.0</version><build><sourceDirectory>C:\MVN\project\src\main\java</sourceDirectory><scriptSourceDirectory>src/main/scripts</scriptSourceDirectory><testSourceDirectory>C:\MVN\project\src\test\java</testSourceDirectory><outputDirectory>C:\MVN\project\target\classes</outputDirectory><testOutputDirectory>C:\MVN\project\target\test-classes</testOutputDirectory><resources><resource><mergeId>resource-0</mergeId><directory>C:\MVN\project\src\main\resources</directory></resource></resources><testResources><testResource><mergeId>resource-1</mergeId><directory>C:\MVN\project\src\test\resources</directory></testResource></testResources><directory>C:\MVN\project\target</directory><finalName>project-1.0</finalName><pluginManagement><plugins><plugin><artifactId>maven-antrun-plugin</artifactId><version>1.3</version></plugin><plugin><artifactId>maven-assembly-plugin</artifactId><version>2.2-beta-2</version></plugin><plugin><artifactId>maven-clean-plugin</artifactId><version>2.2</version></plugin><plugin><artifactId>maven-compiler-plugin</artifactId><version>2.0.2</version></plugin><plugin><artifactId>maven-dependency-plugin</artifactId><version>2.0</version></plugin><plugin><artifactId>maven-deploy-plugin</artifactId><version>2.4</version></plugin><plugin><artifactId>maven-ear-plugin</artifactId><version>2.3.1</version></plugin><plugin><artifactId>maven-ejb-plugin</artifactId><version>2.1</version></plugin><plugin><artifactId>maven-install-plugin</artifactId><version>2.2</version></plugin><plugin><artifactId>maven-jar-plugin</artifactId><version>2.2</version></plugin><plugin><artifactId>maven-javadoc-plugin</artifactId><version>2.5</version></plugin><plugin><artifactId>maven-plugin-plugin</artifactId><version>2.4.3</version></plugin><plugin><artifactId>maven-rar-plugin</artifactId><version>2.2</version></plugin><plugin><artifactId>maven-release-plugin</artifactId><version>2.0-beta-8</version></plugin><plugin><artifactId>maven-resources-plugin</artifactId><version>2.3</version></plugin><plugin><artifactId>maven-site-plugin</artifactId><version>2.0-beta-7</version></plugin><plugin><artifactId>maven-source-plugin</artifactId><version>2.0.4</version></plugin><plugin><artifactId>maven-surefire-plugin</artifactId><version>2.4.3</version></plugin><plugin><artifactId>maven-war-plugin</artifactId><version>2.1-alpha-2</version></plugin></plugins></pluginManagement><plugins><plugin><artifactId>maven-help-plugin</artifactId><version>2.1.1</version></plugin></plugins></build><repositories><repository><snapshots><enabled>false</enabled></snapshots><id>central</id><name>Maven Repository Switchboard</name><url>http://repo1.maven.org/maven2</url></repository></repositories><pluginRepositories><pluginRepository><releases><updatePolicy>never</updatePolicy></releases><snapshots><enabled>false</enabled></snapshots><id>central</id><name>Maven Plugin Repository</name><url>http://repo1.maven.org/maven2</url></pluginRepository></pluginRepositories><reporting><outputDirectory>C:\MVN\project\target/site</outputDirectory></reporting></project>
在上面的 pom.xml中,你可以看到 Maven 在执行目标时需要用到的默认工程源码目录结构、输出目录、需要的插件、仓库和报表目录。
Maven 的 pom.xml 文件也不需要手工编写。
Maven 提供了大量的原型插件来创建工程,包括工程结构和pom.xml。
关于所有POM标签的详解
<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.0http://maven.apache.org/maven-v4_0_0.xsd"><!--父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。 坐标包括group ID,artifact ID和version。 --><parent><!--被继承的父项目的构件标识符 --><artifactId /><!--被继承的父项目的全球唯一标识符 --><groupId /><!--被继承的父项目的版本 --><version /><!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项目的pom,其次在文件系统的这个位置(relativePath位置),然后在本地仓库,最后在远程仓库寻找父项目的pom。 --><relativePath /></parent><!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。 --><modelVersion>4.0.0</modelVersion><!--项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app --><groupId>asia.banseon</groupId><!-- 构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID和groupID;在某个特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven为项目产生的构件包括:JARs,源 码,二进制发布和WARs等。 --><artifactId>banseon-maven2</artifactId><!--项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 --><packaging>jar</packaging><!--项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 --><version>1.0-SNAPSHOT</version><!--项目的名称, Maven产生的文档用 --><name>banseon-maven</name><!--项目主页的URL, Maven产生的文档用 --><url>http://www.baidu.com/banseon</url><!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。 --><description>A maven project to study maven.</description><!--描述了这个项目构建环境中的前提条件。 --><prerequisites><!--构建该项目或使用该插件所需要的Maven的最低版本 --><maven /></prerequisites><!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL,本例为 jira --><issueManagement><!--问题管理系统(例如jira)的名字, --><system>jira</system><!--该项目使用的问题管理系统的URL --><url>http://jira.baidu.com/banseon</url></issueManagement><!--项目持续集成信息 --><ciManagement><!--持续集成系统的名字,例如continuum --><system /><!--该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 --><url /><!--构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) --><notifiers><!--配置一种方式,当构建中断时,以该方式通知用户/开发者 --><notifier><!--传送通知的途径 --><type /><!--发生错误时是否通知 --><sendOnError /><!--构建失败时是否通知 --><sendOnFailure /><!--构建成功时是否通知 --><sendOnSuccess /><!--发生警告时是否通知 --><sendOnWarning /><!--不赞成使用。通知发送到哪里 --><address /><!--扩展配置项 --><configuration /></notifier></notifiers></ciManagement><!--项目创建年份,4位数字。当产生版权信息时需要使用这个值。 --><inceptionYear /><!--项目相关邮件列表信息 --><mailingLists><!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 --><mailingList><!--邮件的名称 --><name>Demo</name><!--发送邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --><post>banseon@126.com</post><!--订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --><subscribe>banseon@126.com</subscribe><!--取消订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 --><unsubscribe>banseon@126.com</unsubscribe><!--你可以浏览邮件信息的URL --><archive>http:/hi.baidu.com/banseon/demo/dev/</archive></mailingList></mailingLists><!--项目开发者列表 --><developers><!--某个项目开发者的信息 --><developer><!--SCM里项目开发者的唯一标识符 --><id>HELLO WORLD</id><!--项目开发者的全名 --><name>banseon</name><!--项目开发者的email --><email>banseon@126.com</email><!--项目开发者的主页的URL --><url /><!--项目开发者在项目中扮演的角色,角色元素描述了各种角色 --><roles><role>Project Manager</role><role>Architect</role></roles><!--项目开发者所属组织 --><organization>demo</organization><!--项目开发者所属组织的URL --><organizationUrl>http://hi.baidu.com/banseon</organizationUrl><!--项目开发者属性,如即时消息如何处理等 --><properties><dept>No</dept></properties><!--项目开发者所在时区, -11到12范围内的整数。 --><timezone>-5</timezone></developer></developers><!--项目的其他贡献者列表 --><contributors><!--项目的其他贡献者。参见developers/developer元素 --><contributor><name /><email /><url /><organization /><organizationUrl /><roles /><timezone /><properties /></contributor></contributors><!--该元素描述了项目所有License列表。 应该只列出该项目的license列表,不要列出依赖项目的 license列表。如果列出多个license,用户可以选择它们中的一个而不是接受所有license。 --><licenses><!--描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。 --><license><!--license用于法律上的名称 --><name>Apache 2</name><!--官方的license正文页面的URL --><url>http://www.baidu.com/banseon/LICENSE-2.0.txt</url><!--项目分发的主要方式: repo,可以从Maven库下载 manual, 用户必须手动下载和安装依赖 --><distribution>repo</distribution><!--关于license的补充信息 --><comments>A business-friendly OSS license</comments></license></licenses><!--SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。 --><scm><!--SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。 --><connection>scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk)</connection><!--给开发者使用的,类似connection元素。即该连接不仅仅只读 --><developerConnection>scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk</developerConnection><!--当前代码的标签,在开发阶段默认为HEAD --><tag /><!--指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 --><url>http://svn.baidu.com/banseon</url></scm><!--描述项目所属组织的各种属性。Maven产生的文档用 --><organization><!--组织的全名 --><name>demo</name><!--组织主页的URL --><url>http://www.baidu.com/banseon</url></organization><!--构建项目需要的信息 --><build><!--该元素设置了项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 --><sourceDirectory /><!--该元素设置了项目脚本源码目录,该目录和源码目录不同:绝大多数情况下,该目录下的内容 会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。 --><scriptSourceDirectory /><!--该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 --><testSourceDirectory /><!--被编译过的应用程序class文件存放的目录。 --><outputDirectory /><!--被编译过的测试class文件存放的目录。 --><testOutputDirectory /><!--使用来自该项目的一系列构建扩展 --><extensions><!--描述使用到的构建扩展。 --><extension><!--构建扩展的groupId --><groupId /><!--构建扩展的artifactId --><artifactId /><!--构建扩展的版本 --><version /></extension></extensions><!--当项目没有规定目标(Maven2 叫做阶段)时的默认值 --><defaultGoal /><!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。 --><resources><!--这个元素描述了项目相关或测试相关的所有资源路径 --><resource><!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。举个例子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven /messages。然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。 --><targetPath /><!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出。 --><filtering /><!--描述存放资源的目录,该路径相对POM路径 --><directory /><!--包含的模式列表,例如**/*.xml. --><includes /><!--排除的模式列表,例如**/*.xml --><excludes /></resource></resources><!--这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 --><testResources><!--这个元素描述了测试相关的所有资源路径,参见build/resources/resource元素的说明 --><testResource><targetPath /><filtering /><directory /><includes /><excludes /></testResource></testResources><!--构建产生的所有文件存放的目录 --><directory /><!--产生的构件的文件名,默认值是${artifactId}-${version}。 --><finalName /><!--当filtering开关打开时,使用到的过滤器属性文件列表 --><filters /><!--子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本地配置都会覆盖这里的配置 --><pluginManagement><!--使用的插件列表 。 --><plugins><!--plugin元素包含描述插件所需要的信息。 --><plugin><!--插件在仓库里的group ID --><groupId /><!--插件在仓库里的artifact ID --><artifactId /><!--被使用的插件的版本(或版本范围) --><version /><!--是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该元素才被设置成enabled。 --><extensions /><!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --><executions><!--execution元素包含了插件执行需要的信息 --><execution><!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 --><id /><!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 --><phase /><!--配置的执行目标 --><goals /><!--配置是否被传播到子POM --><inherited /><!--作为DOM对象的配置 --><configuration /></execution></executions><!--项目引入插件所需要的额外依赖 --><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies><!--任何配置是否被传播到子项目 --><inherited /><!--作为DOM对象的配置 --><configuration /></plugin></plugins></pluginManagement><!--使用的插件列表 --><plugins><!--参见build/pluginManagement/plugins/plugin元素 --><plugin><groupId /><artifactId /><version /><extensions /><executions><execution><id /><phase /><goals /><inherited /><configuration /></execution></executions><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies><goals /><inherited /><configuration /></plugin></plugins></build><!--在列的项目构建profile,如果被激活,会修改构建处理 --><profiles><!--根据环境参数或命令行参数激活某个构建处理 --><profile><!--构建配置的唯一标识符。即用于命令行激活,也用于在继承时合并具有相同标识符的profile。 --><id /><!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。profile的力量来自于它 能够在某些特定的环境中自动使用某些特定的值;这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式。 --><activation><!--profile默认是否激活的标志 --><activeByDefault /><!--当匹配的jdk被检测到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本不是以1.4开头的JDK。 --><jdk /><!--当匹配的操作系统属性被检测到,profile被激活。os元素可以定义一些操作系统相关的属性。 --><os><!--激活profile的操作系统的名字 --><name>Windows XP</name><!--激活profile的操作系统所属家族(如 'windows') --><family>Windows</family><!--激活profile的操作系统体系结构 --><arch>x86</arch><!--激活profile的操作系统版本 --><version>5.1.2600</version></os><!--如果Maven检测到某一个属性(其值可以在POM中通过${名称}引用),其拥有对应的名称和值,Profile就会被激活。如果值 字段是空的,那么存在属性名称字段就会激活profile,否则按区分大小写方式匹配属性值字段 --><property><!--激活profile的属性的名称 --><name>mavenVersion</name><!--激活profile的属性的值 --><value>2.0.3</value></property><!--提供一个文件名,通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在,如果不存在则激活 profile。另一方面,exists则会检查文件是否存在,如果存在则激活profile。 --><file><!--如果指定的文件存在,则激活profile。 --><exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists><!--如果指定的文件不存在,则激活profile。 --><missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing></file></activation><!--构建项目所需要的信息。参见build元素 --><build><defaultGoal /><resources><resource><targetPath /><filtering /><directory /><includes /><excludes /></resource></resources><testResources><testResource><targetPath /><filtering /><directory /><includes /><excludes /></testResource></testResources><directory /><finalName /><filters /><pluginManagement><plugins><!--参见build/pluginManagement/plugins/plugin元素 --><plugin><groupId /><artifactId /><version /><extensions /><executions><execution><id /><phase /><goals /><inherited /><configuration /></execution></executions><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies><goals /><inherited /><configuration /></plugin></plugins></pluginManagement><plugins><!--参见build/pluginManagement/plugins/plugin元素 --><plugin><groupId /><artifactId /><version /><extensions /><executions><execution><id /><phase /><goals /><inherited /><configuration /></execution></executions><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies><goals /><inherited /><configuration /></plugin></plugins></build><!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 --><modules /><!--发现依赖和扩展的远程仓库列表。 --><repositories><!--参见repositories/repository元素 --><repository><releases><enabled /><updatePolicy /><checksumPolicy /></releases><snapshots><enabled /><updatePolicy /><checksumPolicy /></snapshots><id /><name /><url /><layout /></repository></repositories><!--发现插件的远程仓库列表,这些插件用于构建和报表 --><pluginRepositories><!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --><pluginRepository><releases><enabled /><updatePolicy /><checksumPolicy /></releases><snapshots><enabled /><updatePolicy /><checksumPolicy /></snapshots><id /><name /><url /><layout /></pluginRepository></pluginRepositories><!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。 --><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies><!--不赞成使用. 现在Maven忽略该元素. --><reports /><!--该元素包括使用报表插件产生报表的规范。当用户执行"mvn site",这些报表就会运行。 在页面导航栏能看到所有报表的链接。参见reporting元素 --><reporting>......</reporting><!--参见dependencyManagement元素 --><dependencyManagement><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies></dependencyManagement><!--参见distributionManagement元素 --><distributionManagement>......</distributionManagement><!--参见properties元素 --><properties /></profile></profiles><!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 --><modules /><!--发现依赖和扩展的远程仓库列表。 --><repositories><!--包含需要连接到远程仓库的信息 --><repository><!--如何处理远程仓库里发布版本的下载 --><releases><!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 --><enabled /><!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:always(一直),daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 --><updatePolicy /><!--当Maven验证构件校验文件失败时该怎么做:ignore(忽略),fail(失败),或者warn(警告)。 --><checksumPolicy /></releases><!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 --><snapshots><enabled /><updatePolicy /><checksumPolicy /></snapshots><!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 --><id>banseon-repository-proxy</id><!--远程仓库名称 --><name>banseon-repository-proxy</name><!--远程仓库URL,按protocol://hostname/path形式 --><url>http://192.168.1.169:9999/repository/</url><!-- 用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 --><layout>default</layout></repository></repositories><!--发现插件的远程仓库列表,这些插件用于构建和报表 --><pluginRepositories><!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --><pluginRepository>......</pluginRepository></pluginRepositories><!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。 --><dependencies><dependency><!--依赖的group ID --><groupId>org.apache.maven</groupId><!--依赖的artifact ID --><artifactId>maven-artifact</artifactId><!--依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 --><version>3.8.1</version><!-- 依赖类型,默认类型是jar。它通常表示依赖的文件的扩展名,但也有例外。一个类型可以被映射成另外一个扩展名或分类器。类型经常和使用的打包方式对应,尽管这也有例外。一些类型的例子:jar,war,ejb-client和test-jar。如果设置extensions为 true,就可以在 plugin里定义新的类型。所以前面的类型的例子不完整。 --><type>jar</type><!-- 依赖的分类器。分类器可以区分属于同一个POM,但不同构建方式的构件。分类器名被附加到文件名的版本号后面。例如,如果你想要构建两个单独的构件成JAR,一个使用Java 1.4编译器,另一个使用Java 6编译器,你就可以使用分类器来生成两个单独的JAR构件。 --><classifier></classifier><!--依赖范围。在项目发布过程中,帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。 - compile :默认范围,用于编译 - provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath- runtime: 在执行时需要使用 - test: 用于test任务时使用 - system: 需要外在提供相应的元素。通过systemPath来取得- systemPath: 仅用于范围为system。提供相应的路径 - optional: 当项目自身被依赖时,标注依赖是否传递。用于连续依赖时使用 --><scope>test</scope><!--仅供system范围使用。注意,不鼓励使用这个元素,并且在新的版本中该元素可能被覆盖掉。该元素为依赖规定了文件系统上的路径。需要绝对路径而不是相对路径。推荐使用属性匹配绝对路径,例如${java.home}。 --><systemPath></systemPath><!--当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。即告诉maven你只依赖指定的项目,不依赖项目的依赖。此元素主要用于解决版本冲突问题 --><exclusions><exclusion><artifactId>spring-core</artifactId><groupId>org.springframework</groupId></exclusion></exclusions><!--可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。可选依赖阻断依赖的传递性。 --><optional>true</optional></dependency></dependencies><!--不赞成使用. 现在Maven忽略该元素. --><reports></reports><!--该元素描述使用报表插件产生报表的规范。当用户执行"mvn site",这些报表就会运行。 在页面导航栏能看到所有报表的链接。 --><reporting><!--true,则,网站不包括默认的报表。这包括"项目信息"菜单中的报表。 --><excludeDefaults /><!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 --><outputDirectory /><!--使用的报表插件和他们的配置。 --><plugins><!--plugin元素包含描述报表插件需要的信息 --><plugin><!--报表插件在仓库里的group ID --><groupId /><!--报表插件在仓库里的artifact ID --><artifactId /><!--被使用的报表插件的版本(或版本范围) --><version /><!--任何配置是否被传播到子项目 --><inherited /><!--报表插件的配置 --><configuration /><!--一组报表的多重规范,每个规范可能有不同的配置。一个规范(报表集)对应一个执行目标 。例如,有1,2,3,4,5,6,7,8,9个报表。1,2,5构成A报表集,对应一个执行目标。2,5,8构成B报表集,对应另一个执行目标 --><reportSets><!--表示报表的一个集合,以及产生该集合的配置 --><reportSet><!--报表集合的唯一标识符,POM继承时用到 --><id /><!--产生报表集合时,被使用的报表的配置 --><configuration /><!--配置是否被继承到子POMs --><inherited /><!--这个集合里使用到哪些报表 --><reports /></reportSet></reportSets></plugin></plugins></reporting><!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和 artifactID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID 匹配到这里的依赖,并使用这里的依赖信息。 --><dependencyManagement><dependencies><!--参见dependencies/dependency元素 --><dependency>......</dependency></dependencies></dependencyManagement><!--项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。 --><distributionManagement><!--部署项目产生的构件到远程仓库需要的信息 --><repository><!--是分配给快照一个唯一的版本号(由时间戳和构建流水号)?还是每次都使用相同的版本号?参见repositories/repository元素 --><uniqueVersion /><id>banseon-maven2</id><name>banseon maven2</name><url>file://${basedir}/target/deploy</url><layout /></repository><!--构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库,参见distributionManagement/repository元素 --><snapshotRepository><uniqueVersion /><id>banseon-maven2</id><name>Banseon-maven2 Snapshot Repository</name><url>scp://svn.baidu.com/banseon:/usr/local/maven-snapshot</url><layout /></snapshotRepository><!--部署项目的网站需要的信息 --><site><!--部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 --><id>banseon-site</id><!--部署位置的名称 --><name>business api website</name><!--部署位置的URL,按protocol://hostname/path形式 --><url>scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web</url></site><!--项目下载页面的URL。如果没有该元素,用户应该参考主页。使用该元素的原因是:帮助定位那些不在仓库里的构件(由于license限制)。 --><downloadUrl /><!--如果构件有了新的group ID和artifact ID(构件移到了新的位置),这里列出构件的重定位信息。 --><relocation><!--构件新的group ID --><groupId /><!--构件新的artifact ID --><artifactId /><!--构件新的版本号 --><version /><!--显示给用户的,关于移动的额外信息,例如原因。 --><message /></relocation><!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的。有效的值有:none(默认),converted(仓库管理员从Maven 1 POM转换过来),partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部 署),verified(被核实时正确的和最终的)。 --><status /></distributionManagement><!--以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里activation元素的说明)。格式是<name>value</name>。 --><properties /></project>
Maven构建生命周期
Maven 构建生命周期定义了一个项目构建跟发布的过程。
一个典型的 Maven 构建(build)生命周期是由以下几个阶段的序列组成的:
| 阶段 | 处理 | 描述 |
|---|---|---|
| 验证 validate | 验证项目 | 验证项目是否正确且所有必须信息是可用的 |
| 编译 compile | 执行编译 | 源代码编译在此阶段完成 |
| 测试 Test | 测试 | 使用适当的单元测试框架(例如JUnit)运行测试。 |
| 包装 package | 打包 | 创建JAR/WAR包如在 pom.xml 中定义提及的包 |
| 检查 verify | 检查 | 对集成测试的结果进行检查,以保证质量达标 |
| 安装 install | 安装 | 安装打包的项目到本地仓库,以供其他项目使用 |
| 部署 deploy | 部署 | 拷贝最终的工程包到远程仓库中,以共享给其他开发人员和工程 |
完成 default 生命周期,这些阶段(包括其他未在上面罗列的生命周期阶段)将被按顺序地执行。
Maven 有以下三个标准的生命周期:
- clean:项目清理的处理
- default(或 build):项目部署的处理
- site:项目站点文档创建的处理
构建阶段由插件目标构成
一个插件目标代表一个特定的任务(比构建阶段更为精细),这有助于项目的构建和管理。这些目标可能被绑定到多个阶段或者无绑定。不绑定到任何构建阶段的目标可以在构建生命周期之外通过直接调用执行。这些目标的执行顺序取决于调用目标和构建阶段的顺序。
例如,考虑下面的命令:
clean 和 pakage 是构建阶段,dependency:copy-dependencies 是目标
:::info
mvn clean dependency:copy-dependencies package
:::
这里的 clean阶段将会被首先执行,然后 dependency:copy-dependencies目标会被执行,最终package阶段被执行。
Clean生命周期
当我们执行
mvn post-clean命令时,Maven 调用clean生命周期,它包含以下阶段:
pre-clean:执行一些需要在clean之前完成的工作clean:移除所有上一次构建生成的文件post-clean:执行一些需要在clean之后立刻完成的工作
mvn clean中的 clean 就是上面的 clean,在一个生命周期中,运行某个阶段的时候,它之前的*所有阶段都会被运行,也就是说,如果执行 mvn clean 将运行以下两个生命周期阶段:
:::info
pre-clean, clean
:::
如果我们运行 mvn post-clean ,则运行以下三个生命周期阶段:
:::info
pre-clean, clean, post-clean
:::
我们可以通过在上面的clean生命周期的任何阶段定义目标来修改这部分的操作行为。
Default(Build)生命周期
是 Maven 的主要生命周期,被用于构建应用,包括下面的 23 个阶段:
| 生命周期阶段 | 描述 |
|---|---|
| validate(校验) | 校验项目是否正确并且所有必要的信息可以完成项目的构建过程。 |
| initialize(初始化) | 初始化构建状态,比如设置属性值。 |
| generate-sources(生成源代码) | 生成包含在编译阶段中的任何源代码。 |
| process-sources(处理源代码) | 处理源代码,比如说,过滤任意值。 |
| generate-resources(生成资源文件) | 生成将会包含在项目包中的资源文件。 |
| process-resources (处理资源文件) | 复制和处理资源到目标目录,为打包阶段最好准备。 |
| compile(编译) | 编译项目的源代码。 |
| process-classes(处理类文件) | 处理编译生成的文件,比如说对Java class文件做字节码改善优化。 |
| generate-test-sources(生成测试源代码) | 生成包含在编译阶段中的任何测试源代码。 |
| process-test-sources(处理测试源代码) | 处理测试源代码,比如说,过滤任意值。 |
| generate-test-resources(生成测试资源文件) | 为测试创建资源文件。 |
| process-test-resources(处理测试资源文件) | 复制和处理测试资源到目标目录。 |
| test-compile(编译测试源码) | 编译测试源代码到测试目标目录. |
| process-test-classes(处理测试类文件) | 处理测试源码编译生成的文件。 |
| test(测试) | 使用合适的单元测试框架运行测试(Juint是其中之一)。 |
| prepare-package(准备打包) | 在实际打包之前,执行任何的必要的操作为打包做准备。 |
| package(打包) | 将编译后的代码打包成可分发格式的文件,比如JAR、WAR或者EAR文件。 |
| pre-integration-test(集成测试前) | 在执行集成测试前进行必要的动作。比如说,搭建需要的环境。 |
| integration-test(集成测试) | 处理和部署项目到可以运行集成测试环境中。 |
| post-integration-test(集成测试后) | 在执行集成测试完成后进行必要的动作。比如说,清理集成测试环境。 |
| verify (验证) | 运行任意的检查来验证项目包有效且达到质量标准。 |
| install(安装) | 安装项目包到本地仓库,这样项目包可以用作其他本地项目的依赖。 |
| deploy(部署) | 将最终的项目包复制到远程仓库中与其他开发者和项目共享。 |
一些与 Maven 生命周期相关的重要概念需要说明:
当一个阶段通过 Maven 命令调用时,例如 mvn compile,只有该阶段之前以及包括该阶段在内的所有阶段会被执行。
不同的 maven 目标将根据打包的类型(JAR /WAR / EAR),被绑定到不同的 Maven 生命周期阶段。
命令行调用
在开发环境中,使用下面的命令去构建、安装工程到本地仓库
:::info
mvn install
:::
这个命令在执行install阶段前,按顺序执行了 default 生命周期的阶段 (validate,compile,package,等等),我们只需要调用最后一个阶段,如这里是install。
在构建环境中,使用下面的调用来纯净地构建和部署项目到共享仓库中
:::info
mvn clean deploy
:::
这行命令也可以用于多模块的情况下,即包含多个子项目的项目,Maven 会在每一个子项目执行 clean命令,然后再执行deploy 命令。
Site生命周期
Maven Site 插件一般用来创建新的报告文档、部署站点等。
pre-site:执行一些需要在生成站点文档之前完成的工作site:生成项目的站点文档post-site: 执行一些需要在生成站点文档之后完成的工作,并且为部署做准备site-deploy:将生成的站点文档部署到特定的服务器上
这里经常用到的是site阶段和site-deploy阶段,用以生成和发布Maven站点,这可是Maven相当强大的功能,Manager比较喜欢,文档及统计数据自动生成,十分美观。
Maven构建配置文件
构建配置文件是一系列的配置项的值,可以用来设置或者覆盖 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系列)。
- 文件的存在或者缺失。
Maven 仓库
仓库在现实中的意义即存放物品的位置,在 Maven 的术语中,仓库是一个位置(place)。 Maven 仓库是项目中依赖的第三方库,这个库所在的位置叫做仓库。 在 Maven 中,任何一个依赖、插件或者项目构建的输出,都可以称之为构件。 Maven 仓库能帮助我们管理构件(主要是JAR),它就是放置所有JAR文件(WAR,ZIP,POM等等)的地方。
Maven 仓库有三种类型:
- 本地(local)
- 中央(central)
- 远程(remote)
本地仓库
Maven 的本地仓库,在安装 Maven 后并不会创建,它是在第一次执行 maven 命令的时候才被创建。
运行 Maven 的时候,Maven 所需要的任何构件都是直接从本地仓库获取的。如果本地仓库没有,它会首先尝试从远程仓库下载构件至本地仓库,然后再使用本地仓库的构件。
默认情况下,不管Linux还是 Windows,每个用户在自己的用户目录下都有一个路径名为 .m2/repository/ 的仓库目录。
Maven 本地仓库默认被创建在%USER_HOME% 目录下。要修改默认位置,在 %M2_HOME%\conf 目录中的 Maven 的 settings.xml 文件中定义另一个路径。
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0http://maven.apache.org/xsd/settings-1.0.0.xsd"><localRepository>C:/MyLocalRepository</localRepository></settings>
当你运行 Maven 命令,Maven 将下载依赖的文件到你指定的路径中。
中央仓库
Maven 中央仓库是由 Maven 社区提供的仓库,其中包含了大量常用的库。 中央仓库包含了绝大多数流行的开源Java构件,以及源码、作者信息、SCM、信息、许可证信息等。一般来说,简单的Java项目依赖的构件都可以在这里下载到。
中央仓库的关键概念:
- 这个仓库由 Maven 社区管理。
- 不需要配置。
- 需要通过网络才能访问。
要浏览中央仓库的内容,maven 社区提供了一个 URL:http://search.maven.org/#browse。使用这个仓库,开发人员可以搜索所有可以获取的代码库。
远程仓库
如果 Maven 在中央仓库中也找不到依赖的文件,它会停止构建过程并输出错误信息到控制台。为避免这种情况,Maven 提供了远程仓库的概念,它是开发人员自己定制仓库,包含了所需要的代码库或者其他工程中用到的 jar 文件。
例:
使用下面的pom.xml,Maven 将从远程仓库中下载该 pom.xml中声明的所依赖的(在中央仓库中获取不到的)文件。
<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.0http://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><dependencies><dependency><groupId>com.companyname.common-lib</groupId><artifactId>common-lib</artifactId><version>1.0.0</version></dependency><dependencies><repositories><repository><id>companyname.lib1</id><url>http://download.companyname.org/maven2/lib1</url></repository><repository><id>companyname.lib2</id><url>http://download.companyname.org/maven2/lib2</url></repository></repositories></project>
Maven依赖搜索的顺序
当我们执行 Maven 构建命令时,Maven 开始按照以下顺序查找依赖的库:
步骤 1 - 在本地仓库中搜索,如果找不到,执行步骤 2,如果找到了则执行其他操作。
步骤 2 - 在中央仓库中搜索,如果找不到,并且有一个或多个远程仓库已经设置,则执行步骤 4,如果找到了则下载到本地仓库中以备将来引用。
步骤 3 - 如果远程仓库没有被设置,Maven 将简单的停滞处理并抛出错误(无法找到依赖的文件)。
步骤 4 - 在一个或多个远程仓库中搜索依赖的文件,如果找到则下载到本地仓库以备将来引用,否则 Maven 将停止处理并抛出错误(无法找到依赖的文件)。
Maven 阿里云仓库
Maven 仓库默认在国外, 国内使用难免很慢,我们可以更换为阿里云的仓库。
修改 maven 根目录下的conf文件夹中的 settings.xml 文件,在 mirrors节点上,添加内容如下:
<mirror><id>aliyunmaven</id><mirrorOf>*</mirrorOf><name>阿里云公共仓库</name><url>https://maven.aliyun.com/repository/public</url></mirror>
如果想使用其它代理仓库,可在 <repositories></repositories> 节点中加入对应的仓库使用地址。
以使用 spring 代理仓为例:
<repository><id>spring</id><url>https://maven.aliyun.com/repository/spring</url><releases><enabled>true</enabled></releases><snapshots><enabled>true</enabled></snapshots></repository>
在你的pom.xml 文件<denpendencies></denpendencies>节点中加入你要引用的文件信息:
<dependency><groupId>[GROUP_ID]</groupId><artifactId>[ARTIFACT_ID]</artifactId><version>[VERSION]</version></dependency>
执行拉取命令:
:::info
mvn install
:::
Gradle 配置指南
在build.gradle 文件中加入以下代码:
allprojects {repositories {maven {url 'https://maven.aliyun.com/repository/public/'}mavenLocal()mavenCentral()}}
如果想使用其它代理仓
以使用spring仓为例,代码如下:
allProjects {repositories {maven {url 'https://maven.aliyun.com/repository/public/'}maven {url 'https://maven.aliyun.com/repository/spring/'}mavenLocal()mavenCentral()}}
加入你要引用的文件信息:
dependencies {compile '[GROUP_ID]:[ARTIFACT_ID]:[VERSION]'}
执行以下命令安装依赖:
:::info
gradle dependencies
或
./gradlew dependencies
:::
Maven 插件
每个生命周期中都包含着一系列的阶段(
phase)。这些phase就相当于 Maven 提供的统一的接口,然后这些phase的实现由 Maven 的插件来完成。我们在输入
mvn命令的时候 比如mvn clean,clean对应的就是Clean生命周期中的clean阶段。但是clean的具体操作是由maven-clean-plugin来实现的。 Maven 生命周期的每一个阶段的具体实现都是由 Maven 插件实现的。Maven 实际上是一个依赖插件执行的框架,每个任务实际上是由插件完成。Maven 插件通常被用来:
- 创建
jar文件- 创建
war文件- 编译代码文件
- 代码单元测试
- 创建工程文档
- 创建工程报告
插件通常提供了一个目标的集合,并且可以使用下面的语法执行:
:::info
mvn [plugin-name]:[goal-name]
:::
例:一个 Java 工程可以使用 maven-compiler-plugin 的 compile-goal 编译,使用以下命令:
:::info
mvn compiler:compile
:::
插件的类型
Maven 提供了下面两种类型的插件:
| 类型 | 描述 |
|---|---|
| Build plugins | 在构建时执行,并在 pom.xml 的 元素中配置。 |
| Reporting plugins | 在网站生成过程中执行,并在 pom.xml 的 元素中配置。 |
常用插件的列表:
| 插件 | 描述 |
|---|---|
| clean | 构建之后清理目标文件。删除目标目录。 |
| compiler | 编译 Java 源文件。 |
| surefile | 运行 JUnit 单元测试。创建测试报告。 |
| jar | 从当前工程中构建 JAR 文件。 |
| war | 从当前工程中构建 WAR 文件。 |
| javadoc | 为工程生成 Javadoc。 |
| antrun | 从构建过程的任意一个阶段中运行一个 ant 任务的集合。 |
插件是在
pom.xml中使用plugins元素定义的。 每个插件可以有多个目标。 你可以定义阶段,插件会使用它的phase元素开始处理。我们已经使用了clean阶段。 你可以通过绑定到插件的目标的方式来配置要执行的任务。我们已经绑定了echo任务到maven-antrun-plugin的run目标。 就是这样,Maven 将处理剩下的事情。 它将下载本地仓库中获取不到的插件,并开始处理。
依赖管理
如果我们的项目依赖第三方的
jar包,例如commons logging,那么问题来了:commons logging发布的jar包在哪下载? 如果我们还希望依赖log4j,那么使用log4j需要哪些jar包?类似的依赖还包括:
JUnit,JavaMail``,MySQL驱动等等,一个可行的方法是通过搜索引擎搜索到项目的官网,然后手动下载zip包,解压,放入classpath。但是,这个过程非常繁琐。Maven解决了依赖管理问题。
例如,我们的项目依赖abc这个jar包,而abc又依赖xyz这个jar包:
┌──────────────┐│Sample Project│└──────────────┘│▼┌──────────────┐│ abc │└──────────────┘│▼┌──────────────┐│ xyz │└──────────────┘
当我们声明了abc的依赖时,Maven自动把abc和xyz都加入了我们的项目依赖,不需要我们自己去研究abc是否需要依赖xyz。
因此,Maven的第一个作用就是解决依赖管理。我们声明了自己的项目需要abc,Maven会自动导入abc的jar包,再判断出abc需要xyz,又会自动导入xyz的jar包,这样,最终我们的项目会依赖abc和xyz两个jar包。
看一个复杂依赖示例:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>1.4.2.RELEASE</version></dependency>
当我们声明一个spring-boot-starter-web依赖时,Maven会自动解析并判断最终需要大概二三十个其他依赖:
:::info
spring-boot-starter-web
spring-boot-starter
spring-boot
sprint-boot-autoconfigure
spring-boot-starter-logging
logback-classic
logback-core
slf4j-api
jcl-over-slf4j
slf4j-api
jul-to-slf4j
slf4j-api
log4j-over-slf4j
slf4j-api
spring-core
snakeyaml
spring-boot-starter-tomcat
tomcat-embed-core
tomcat-embed-el
tomcat-embed-websocket
tomcat-embed-core
jackson-databind
…
:::
如果我们自己去手动管理这些依赖是非常费时费力的,而且出错的概率很大。
依赖关系
Maven定义了几种依赖关系,分别是compile、test、runtime和provided:
| scope | 说明 | 示例 |
|---|---|---|
| compile | 编译时需要用到该jar包(默认) | commons-logging |
| test | 编译Test时需要用到该jar包 | junit |
| runtime | 编译时不需要,但运行时需要用到 | mysql |
| provided | 编译时需要用到,但运行时由JDK或某个服务器提供 | servlet-api |
其中,默认的compile是最常用的,Maven会把这种类型的依赖直接放入classpath。
test依赖表示仅在测试时使用,正常运行时并不需要。最常用的test依赖就是JUnit:
<dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter-api</artifactId><version>5.3.2</version><scope>test</scope></dependency>
runtime依赖表示编译时不需要,但运行时需要。最典型的runtime依赖是JDBC驱动,例如MySQL驱动:
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.48</version><scope>runtime</scope></dependency>
provided依赖表示编译时需要,但运行时不需要。最典型的provided依赖是Servlet API,编译的时候需要,但是运行时,Servlet服务器内置了相关的jar,所以运行期不需要:
<dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>4.0.0</version><scope>provided</scope></dependency>
Maven如何知道从何处下载所需的依赖?也就是相关的jar包?
是Maven维护了一个中央仓库(repo1.maven.org),所有第三方库将自身的jar以及相关信息上传至中央仓库,Maven就可以从中央仓库把所需依赖下载到本地。
Maven并不会每次都从中央仓库下载jar包。一个jar包一旦被下载过,就会被Maven自动缓存在本地目录(用户主目录的.m2目录),所以,除了第一次编译时因为下载需要时间会比较慢,后续过程因为有本地缓存,并不会重复下载相同的jar包。
唯一ID
对于某个依赖,Maven只需要3个变量即可唯一确定某个jar包:
- groupId:属于组织的名称,类似Java的包名;
- artifactId:该jar包自身的名称,类似Java的类名;
- version:该jar包的版本。
通过上述3个变量,即可唯一确定某个jar包。
Maven通过对jar包进行PGP签名确保任何一个jar包一经发布就无法修改。
修改已发布jar包的唯一方法是发布一个新版本。
因此,某个jar包一旦被Maven下载过,即可永久地安全缓存在本地。
注:只有以-SNAPSHOT结尾的版本号会被Maven视为开发版本,开发版本每次都会重复下载,这种SNAPSHOT版本只能用于内部私有的Maven repo,公开发布的版本不允许出现SNAPSHOT。
Maven 镜像
除了可以从Maven的中央仓库下载外,还可以从Maven的镜像仓库下载。如果访问Maven的中央仓库非常慢,我们可以选择一个速度较快的Maven的镜像仓库。Maven镜像仓库定期从中央仓库同步:
slow ┌───────────────────┐┌─────────────>│Maven Central Repo.││ └───────────────────┘│ ││ │sync│ ▼┌───────┐ fast ┌───────────────────┐│ User │─────────>│Maven Mirror Repo. │└───────┘ └───────────────────┘
此处在上文已经介绍过,在简单过一遍。
中国区用户可以使用阿里云提供的Maven镜像仓库。使用Maven镜像仓库需要一个配置,在用户主目录下进入.m2目录,创建一个settings.xml配置文件,内容如下:
<settings><mirrors><mirror><id>aliyun</id><name>aliyun</name><mirrorOf>central</mirrorOf><!-- 国内推荐阿里云的Maven镜像 --><url>https://maven.aliyun.com/repository/central</url></mirror></mirrors></settings>
搜索第三方组件
如果我们要引用一个第三方组件,比如okhttp,如何确切地获得它的groupId、artifactId和version?
通过search.maven.org搜索关键字,找到对应的组件后,直接复制:
命令行编译
在命令中,进入到pom.xml所在目录,输入以下命令:
$ mvn clean package
成功之后,即可在target目录下获得编译后自动打包的jar。
如何在IDE中使用Maven
市面上大部分IDE都内置了对Maven的支持。
大部分,可以直接创建或导入Maven项目。
构建流程
Maven基础系列(二)构建流程


