Maven知识 %Eclipse%

Maven

0 导言：

生产环境下开发不再是一个项目一个工程，而是每一个模块创建一个工程，而多个模块整合在一起就需要使用到像Maven这样的构建工具。

1 为什么需要Maven？

Maven是干什么用的？这是很多同学在刚开始接触Maven时最大的问题。之所以会提出这个问题，是因为即使不使用Maven我们仍然可以进行B/S结构项目的开发。从表述层、业务逻辑层到持久化层再到数据库都有成熟的解决方案——不使用Maven我们一样可以开发项目啊？

1.1 目前的技术在开发中存在的问题

1. 一个项目就是一个工程
   如果项目非常庞大，就不适合继续使用package来划分模块。最好是每一个模块对应一个工程，利于分工合作。 借助与Maven可以将一个工程拆分为多个工程。

2. 项目中的jar包必须复制粘贴到WEB-INF/lib目录下。
   问题：同样的jar包文件重复出现在不同的项目工程中，会浪费存储空间，且工程显得臃肿。
   借助Maven，可以将jar包仅保存在“仓库”中，有需要的工程“引用”这个文件即可，并不需要真正复制导入。

3. jar包需要别人替我们准备好，或者去网上下载
   问题：JavaEE开发中需要使用到的jar包种类繁多，几乎每个jar包在其本身的官网上的获取方式都不尽相同。为了查找一个jar包找遍互联网，身心俱疲，没有经历过的人或许体会不到这种折磨。不仅如此，费劲心血找的jar包里有的时候并没有你需要的那个类，又或者又同名的类没有你要的方法——以不规范的方式获取的jar包也往往是不规范的。
   借助于Maven可以以一种规范的方式下载jar包，因为所有知名框架或第三方工具的jar包都按照了统一的规范存放在了Maven的中央仓库中。

4. jar包之间的依赖关系
   jar包往往不是孤立存在的，很多jar包都需要在其他jar包的支持下才能够正常工作，我们称之为jar包之间的依赖关系。最典型的例子是：commons-fileupload-1.3.jar依赖于commons-io-2.0.1.jar，如果没有IO包，FileUpload包就不能正常工作。造成的问题是，了解所有的依赖以及下载，劳心劳神，无形中增加了极大的学习成本。
   Maven的特性，会将被依赖的jar包自动导入进来，减轻了我们开发人员的负担。

2.Maven是什么？

2.1 Maven简介

Maven是Apache软件基金会组织维护的一款自动化构建工具，专注服务于Java平台的项目构建和依赖管理。Maven这个单词的本意是：专家，内行。读音是['meɪv(ə)n]或['mevn]。

2.2 什么是构建

要了解构建的含义我们应该由浅入深的从以下三个层面来看：

1. 纯Java代码
   大家都知道，我们Java是一门编译型语言，.java扩展名的源文件需要编译成.class扩展名的字节码文件才能够执行。所以编写任何Java代码想要执行的话就必须经过编译得到对应的.class文件。

2. Web工程
   当我们需要通过浏览器访问Java程序时就必须将包含Java程序的Web工程编译的结果“拿”到服务器上的指定目录下，并启动服务器才行。这个“拿”的过程我们叫部署。
   我们可以将未编译的Web工程比喻为一只生的鸡，编译好的Web工程是一只煮熟的鸡，编译部署的过程就是将鸡炖熟。
   Web工程和其编译结果的目录结构对比见下图：

3. 实际项目
   在实际项目中整合第三方框架，Web工程中除了Java程序和JSP页面、图片等静态资源之外，还包括第三方框架的jar包以及各种各样的配置文件。所有这些资源都必须按照正确的目录结构部署到服务器上，项目才可以运行。

所以综上所述：构建就是以我们编写的Java代码、框架配置文件、国际化等其他资源文件、JSP页面和图片等静态资源作为“原材料”，去“生产”出一个可以运行的项目的过程。那么项目构建的全过程中都包含哪些环节呢？

2.3 构建过程的几个主要环节

①清理：删除以前的编译结果，为重新编译做好准备。
②编译：将Java源程序编译为字节码文件。
③测试：针对项目中的关键点进行测试，确保项目在迭代开发过程中关键点的正确性。
④报告：在每一次测试后以标准的格式记录和展示测试结果。
⑤打包：将一个包含诸多文件的工程封装为一个压缩文件用于安装或部署。Java工程对应jar包，Web工程对应war包。
⑥安装：在Maven环境下特指将打包的结果——jar包或war包安装到本地仓库中。
⑦部署：将打包的结果部署到远程仓库或将war包部署到服务器上运行。

2.4 Maven核心概念

Maven能够实现自动化构建是和它的内部原理分不开的，这里我们从Maven的九个核心概念入手，看看Maven是如何实现自动化构建的。
①POM
②约定的目录结构
③坐标④依赖管理
⑤仓库管理
⑥生命周期
⑦插件和目标
⑧继承
⑨聚合

3 如何使用Maven

Maven的核心程序中仅仅定义了抽象的生命周期，而具体的操作则是由Maven的插件来完成的。可是Maven的插件并不包含在Maven的核心程序中，在首次使用时需要联网下载。
下载得到的插件会被保存到本地仓库中。本地仓库默认的位置是：~.m2 epository。
修改默认本地仓库的位置可以让Maven核心程序到我们修改后的位置去查找插件，具体操作：

1. 找到Maven解压目录/conf/settings.xml
2. 在settings.xml文件中找到 <localRepository> 标签
3. 将该标签从注释中取出，并将标签体内路径改为自定义Maven仓库路径即可。
如：<localRepository>D:RepMaven</localRepository>

4 POM

Project Object Model：项目对象模型。将Java工程的相关信息封装为对象作为便于操作和管理的模型。Maven工程的核心配置。可以说学习Maven就是学习pom.xml文件中的配置。

5 坐标

5.1 几何中的坐标

[1]在一个平面中使用x、y两个向量可以唯一的确定平面中的一个点。
[2]在空间中使用x、y、z三个向量可以唯一的确定空间中的一个点。

5.2 Maven的坐标

使用如下三个向量在Maven的仓库中唯一的确定一个Maven工程。
[1]groupid：公司或组织的域名倒序+当前项目名称
[2]artifactId：当前项目的模块名称
[3]version：当前模块的版本使用如下三个向量在Maven的仓库中唯一的确定一个Maven工程。

<groupId>com.krismile.maven</groupId>
<artifactId>Hello</artifactId>
<version>0.0.1-SNAPSHOT</version>

5.3 如何通过坐标到仓库中查找jar包？

[1]将gav三个向量连起来

com.krismile.maven+Hello+0.0.1-SNAPSHOT

[2]以连起来的字符串作为目录结构到仓库中查找

com/krismile/maven/Hello/0.0.1-SNAPSHOT/Hello-0.0.1-SNAPSHOT.jar

注意：我们自己的Maven工程必须执行安装操作才会进入仓库。安装的命令是：mvn install

6 依赖

Maven中最关键的部分，我们使用Maven最主要的就是使用它的依赖管理功能。要理解和掌握Maven的依赖管理，我们只需要解决一下几个问题：

①依赖的目的是什么
当Ajar包用到了B jar包中的某些类时，A就对B产生了依赖，这是概念上的描述。那么如何在项目中以依赖的方式引入一个我们需要的jar包呢？答案非常简单，就是使用dependency标签指定被依赖jar包的坐标就可以了。

<dependency>
	<groupId>com.krismile.maven</groupId>
	<artifactId>Hello</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<scope>compile</scope>
</dependency

②依赖的范围
上面的依赖信息中除了目标jar包的坐标还有一个scope设置，这是依赖的范围。依赖的范围有几个可选值，我们用得到的是：compile、test、provided三个。

[1]从项目结构角度理解compile和test的区别

结合具体例子：对于HelloFriend来说，Hello就是服务于主程序的，junit是服务于测试程序的。HelloFriend主程序需要Hello是非常明显的，测试程序由于要调用主程序所以也需要Hello，所以compile范围依赖对主程序和测试程序都应该有效。HelloFriend的测试程序部分需要junit也是非常明显的，而主程序是不需要的，所以test范围依赖仅仅对于主程序有效。

[2]从开发和运行这两个不同阶段理解compile和provided的区别

[3]有效性总结

	compile	test	provided
主程序	√	×	√
测试程序	√	√	√
参与部署	√	×	×

③依赖的传递性

A依赖B，B依赖C，A能否使用C呢？那要看B依赖C的范围是不是compile，如果是则可用，否则不可用。

④依赖的排除

如果我们在当前工程中引入了一个依赖是A，而A又依赖了B，那么Maven会自动将A依赖的B引入当前工程，但是个别情况下B有可能是一个不稳定版，或对当前工程有不良影响。这时我们可以在引入A的时候将B排除。

[1]情景举例

[2]配置方式

<dependency>
	<groupId>com.krismile.maven</groupId>
	<artifactId>HelloFriend</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<type>jar</type>
	<scope>compile</scope>
	// 需排除的jar包写在这里面
	<exclusions>
		<exclusion>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

[3]排除后的效果

⑤统一管理所依赖jar包的版本

对同一个框架的一组jar包最好使用相同的版本。为了方便升级框架，可以将jar包的版本信息统一提取出来
[1]统一声明版本号

<properties>
	<krismile.spring.version>4.1.1.RELEASE</krismile.spring.version>
</properties>

其中krismile.spring.version部分是自定义标签。

[2]引用前面声明的版本号

<dependencies>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-core</artifactId>
		<version>${krismile.spring.version}</version>】
	</dependency>
</dependencies>

[3]其他用法

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

在properties标签内可以自定义统一管理的内容， 同时Maven也有一些内置的标签，比如上述的管理项目字符集的标签。 换句话说， 如果想要统一管理某些内容， 可以在properties内定义。

⑥依赖的原则：解决jar包冲突
[1]路径最短者优先

[2]路径相同时先声明者优先

这里“声明”的先后顺序指的是dependency标签配置的先后顺序。

7 仓库

7.1 分类

[1]本地仓库：为当前本机电脑上的所有Maven工程服务。
[2]远程仓库
(1)私服：架设在当前局域网环境下，为当前局域网范围内的所有Maven工程服务。

(2)中央仓库：架设在Internet上，为全世界所有Maven工程服务。
(3)中央仓库的镜像：架设在各个大洲，为中央仓库分担流量。减轻中央仓库的压力，同时更快的响应用户请求。

7.2 仓库中的文件

[1]Maven的插件
[2]我们自己开发的项目的模块
[3]第三方框架或工具的jar包

tips：不管是什么样的jar包，在仓库中都是按照坐标生成目录结构，所以可以通过统一的方式查询或依赖。

8 生命周期

8.1 什么是Maven的生命周期？

●Maven生命周期定义了各个构建环节的执行顺序，有了这个清单，Maven就可以自动化的执行构建命令了。

●Maven有三套相互独立的生命周期，分别是：
①Clean Lifecycle在进行真正的构建之前进行一些清理工作。
②Default Lifecycle构建的核心部分，编译，测试，打包，安装，部署等等。
③Site Lifecycle生成项目报告，站点，发布站点。
它们是相互独立的，你可以仅仅调用clean来清理工作目录，仅仅调用site来生成站点。当然你也可以直接运行mvn clean install site 运行所有这三套生命周期。

每套生命周期都由一组阶段(Phase)组成，我们平时在命令行输入的命令总会对应于一个特定的阶段。比如，运行mvn clean，这个clean是Clean生命周期的一个阶段。有Clean生命周期，也有clean阶段。

8.2 Clean生命周期

Clean生命周期一共包含了三个阶段：

①pre-clean 执行一些需要在clean之前完成的工作
②clean 移除所有上一次构建生成的文件
③post-clean 执行一些需要在clean之后立刻完成的工作

8.3 Site生命周期

①pre-site 执行一些需要在生成站点文档之前完成的工作
②site 生成项目的站点文档
③post-site 执行一些需要在生成站点文档之后完成的工作，并且为部署做准备
④site-deploy 将生成的站点文档部署到特定的服务器上

这里经常用到的是site阶段和site-deploy阶段，用以生成和发布Maven站点，这可是Maven相当强大的功能，Manager比较喜欢，文档及统计数据自动生成，很好看。

8.4 Default生命周期

Default生命周期 是Maven生命周期中 最重要 的一个，绝大部分工作都发生在这个生命周期中。这里，只解释一些比较重要和常用的阶段：

validate
generate-sources
process-sources
generate-resources
process-resources 复制并处理资源文件，至目标目录，准备打包。
compile 编译项目的源代码。
process-classes
generate-test-sources
process-test-sources
generate-test-resources
process-test-resources 复制并处理资源文件，至目标测试目录。
test-compile 编译测试源代码。
process-test-classes
test 使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署。
prepare-package
package 接受编译好的代码，打包成可发布的格式，如JAR。
pre-integration-test
integration-test
post-integration-test
verify
install 将包安装至本地仓库，以让其它项目依赖。
deploy 将最终的包复制到远程的仓库，以让其它开发人员与项目共享或部署到服务器上运行。

8.5 生命周期与自动化构建

运行任何一个阶段的时候，它前面的所有阶段都会被运行。

例如我们运行mvn install 的时候，代码会被编译，测试，打包。
这就是Maven为什么能够自动执行构建过程的各个环节的原因。
此外，Maven的插件机制是完全依赖Maven的生命周期的，因此理解生命周期至关重要。

9 插件和目标

●Maven的核心仅仅定义了抽象的生命周期，具体的任务都是交由插件完成的。
●每个插件都能实现多个功能，每个功能就是一个插件目标。
●Maven的生命周期与插件目标相互绑定，以完成某个具体的构建任务。

例如：compile就是插件maven-compiler-plugin的一个目标； pre-clean是插件maven-clean-plugin的一个目标。

10 继承

10.1 为什么需要继承机制

由于非compile范围的依赖信息是不能在“依赖链”中传递的，所以有需要的工程只能单独配置。例如：
在两个工程(二者之间含依赖关系)下需要配置同一段scope依赖范围为test的如下代码：

<dependency>
	<groupId>junit</groupId>
	<artifactId>junit</artifactId>
	<version>4.0</version>
	<scope>test</scope>
</dependency>

此时如果项目需要将各个模块的junit版本统一为4.9，那么到各个工程中手动修改无疑是非常不可取的。使用继承机制就可以将这样的依赖信息统一提取到父工程模块中进行统一管理。

10.2 创建父工程

创建父工程和创建一般的Java工程操作一致，唯一需要注意的是：打包方式处要设置为pom。

10.3 在子工程中引用父工程

<parent>
	<!--父工程坐标-->
	<groupId>...</groupId>
	<artifactId>...</artifactId>
	<version>...</version>
	<relativePath>从当前目录到父项目的pom.xml文件的相对路径</relativePath>
</parent>


<parent>
	<groupId>com.krismile.maven</groupId>
	<artifactId>Parent</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<!--指定从当前子工程的pom.xml文件出发，查找父工程的pom.xml的路径-->
	<relativePath>../Parent/pom.xml</relativePath>
</parent>

此时如果子工程的groupId和version如果和父工程重复则可以删除。

10.4 在父工程中管理依赖

将Parent项目中的dependencies标签，用dependencyManagement标签括起来

<dependencyManagement>
	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.9</version>
			<scope>test</scope>
		</dependency>
	</dependencies>
</dependencyManagement>

在子项目中重新指定需要的依赖，删除范围和版本号

<dependencies>
	<dependency>
		<groupId>junit</groupId>
		<artifactId>junit</artifactId>
	</dependency>
</dependencies>

11 聚合

11.1 为什么要使用聚合？

将多个工程拆分为模块后，需要手动逐个安装到仓库后依赖才能够生效。修改源码后也需要逐个手动进行clean操作。而使用了聚合之后就可以批量进行Maven工程的安装、清理工作。

11.2 如何配置聚合？

在总的聚合工程中使用modules/module标签组合，指定模块工程的相对路径即可

<modules>
	<module>../Hello</module>
	<module>../HelloFriend</module>
	<module>../MakeFriends</module>
</modules>

12 Maven酷站

我们可以到 Maven酷站 搜索需要的jar包的依赖信息。

补充：约定的目录结构

约定的目录结构对于Maven实现自动化构建而言是必不可少的一环，就拿自动编译来说，Maven必须能找到Java源文件，下一步才能编译，而编译之后也必须有一个准确的位置保持编译得到的字节码文件。
我们在开发中如果需要让第三方工具或框架知道我们自己创建的资源在哪，那么基本上就是两种方式：

①通过配置的形式明确告诉它
②基于第三方工具或框架的约定Maven对工程目录结构的要求就属于后面的一种。

现在JavaEE开发领域普遍认同一个观点：约定>配置>编码。意思就是能用配置解决的问题就不编码，能基于约定的就不进行配置。而Maven正是因为指定了特定文件保存的目录才能够对我们的Java工程进行自动化构建。