Maven基础

1. 是什么

跨平台的项目管理工具。作为Apache组织中的一个颇为成功的开源项目，Maven主要服务基于java平台的项目构建、依赖管理和项目信息管理。

2. Maven坐标

• 什么是Maven坐标

Maven的世界拥有数量非常巨大的构件，也就是平常用的jar、war等文件。Maven为这些构件引入坐标概念之前，无法使用任何一种唯一标志去标识所有这些组件。

Maven定义了这样一组规则：世界上任何构件都可以使用Maven坐标唯一表识，Maven的坐标元素包括groupId、artifactId、version、packaging、classifier。只要提供正确的坐标元素，Maven就能找到对应的构件。

• 坐标详解

<project>

    .......

    <dependencies>

      <dependency>
      <groupId>org.sonatype.nexus</groupId>
      <artifactId>nexus-indexer</artifactId>
      <version>2.0.0</version>

      <type>--</type>
      <scope>--</scope>
      <optional>--</optional>
      <exclusions>

          <exclusion>

             ......

         </exclusion>

      </exclusions>
      </dependency>

    </dependencies>

    .......
</project>

1）groupId[必须]：当前maven项目隶属的实际项目。Maven项目和实际项目不是一一对应的关系，比如springFramework这一实际项目，对应的Maven项目会有很多，spring-core，spring-context等。groupId的命名方式和Java包名的表示方式类似，通常与域名反向一一对应。org.sonatype表示公司建立的一个非营利性组织，nexus表示Nexus这一实际项目。
2）artifactId [必须]：该元素表示的是世纪项目中的一个Maven模块，推荐的做法是使用项目名称作为前缀，方便寻找实际构件。
3）version[必须]：Maven项目当前所处的版本。
4）packaging[可选]：Maven项目的打包方式。当不定义的时候，默认是jar。
5）classifier[不能直接定义]：用来帮助定义构件输出的一些附属构件
6）type：依赖的类型
7）scope：依赖的范围
1⃣️compile：编译依赖范围。如果没有指定，则会默认使用该范围。
2⃣️test：测试依赖范围。
3⃣️provided：已提供依赖范围。
4⃣️runtime：运行时依赖范围
5⃣️system：系统依赖范围
6⃣️import：导入依赖范围
8）optional：标记依赖是否可选【在理想情况下是不应该使用可选依赖的，使用可选依赖是因为某一个项目实现了多个特性，在面向对象设计中，有个单一指责性原则，意指一个类应该只有一项职责，而不是柔和太多的功能
9）exclusions：用来排除传递性依赖

<project>
	<modelVersion>4.0.0</modelVersion>
    <groupId>com.juvenxu.mvnbook</groupId>
	<artificatId>project-a</artificatId>
	<version>1.0.0</version>
	<dependencies>
	  <dependency>
	     <groupId>com.juvenxu.mvnbook</groupId>
	     <artificatId>project-b</artificatId>
	     <version>1.0.0</version>
	     <exclusions>
	        <exclusion>
	           <groupId>com.juvenxu.mvnbook</groupId>
	           <artificatId>project-c</artificatId>
	        <exclusion>
	     </exclusions>
      </dependency>
      <dependency>
	     <groupId>com.juvenxu.mvnbook</groupId>
	     <artificatId>project-c</artificatId>
	     <version>1.0.0</version>
      </dependency>
    </dependencies>
</project>	

上述代码中，项目A依赖于项目B，但是由于一些原因，不想引入传递性依赖C，而是自己显示地生命对于项目C1.0.0版本的依赖。代码中使用exclusions元素声明排除依赖，exclusions可以包含一个或者多个exclusion子元素，因此可以排除一个或者多个传递性依赖。需要注意的是，声明exclusion的时候只需要一个groupId和artificatId，而不需要version元素，这是因为只需要groupId和artificatId就能定位某个依赖。换句话说，Maven解析后的依赖中，不可能出现groupId和artificatId相同，但是version不同的两个依赖。

查看当前项目已解析依赖：

mvn dependency:list

查看当前项目的依赖树：

mvn dependency:tree

分析当前项目的依赖：

mvn dependency:analyze

• 构建模块

使用mvn clean install构建一个模块如test，Maven会根据pom配置自动下载所需要的依赖构件，执行编译、测试、打包等工作，最后将项目生成的test-1.0.0-SNAP-SHOT.jar安装到本地仓库中。这时，该模块就能被maven的其他模块来使用了。

3. 仓库

• 是什么

在Maven世界中，任何一个依赖、插件或者项目构建的输出，都可以成为构建。得益于坐标机制，任何Maven项目使用任何一个构件的方式都是完全相同的。在此基础上，Maven可以在某个位置统一存储所有Maven项目共享的构件，这个统一的位置就是仓库。

• 布局方式

任何一个构件都有其唯一的坐标，根据这个坐标可以定义其在仓库中的唯一存储路径。

• 仓库分类

对Maven来说，仓库只分为两类：本地仓库和远程仓库。当Maven坐标寻找构件的时候，它首先会去查看本地仓库，如果本地仓库存在此构见，则直接使用；如果本地仓库不存在此构件，或需要查看是否有更新的构件版本，则它就会去远程仓库查找，发现需要的构件之后，下载到本地仓库再使用。如果本地和远程仓库都没有找到所需的构件，Maven 就会报错。中央仓库是Maven自带的远程仓库，它包含了绝大部分开源的构件。私服是一种特殊的远程仓库，为了节省带宽和时间，应该在局域网内架设一个私有的仓库服务器，用其代理所有外部的远程仓库，内部的项目还能部署到私服上供其他项目使用。Maven仓库的分类如下：

• mvn clean install
  Install插件的install目标将项目的构建输出文件安装到本地仓库。
• 声明远程仓库地址

<project>
   ...
	<repositories>
         <repository>
		    <id>jboss</id>
			<name>JBoss Repository</name>
			<url>http://repository.jboss.com/maven2/</url>
			   <releases>
			      <enabled>true</enabled>
			   </releases>
			   <snapshots>
			      <enabled>false</enabled>
			   </snapshots>
			   <layout>default</layout>
        </repository>
	</repositories>
</project>	

在repositories元素下，可以使用子元素声明一个或者多个远程仓库地址。上述图片声明了一个id为jboss，名称为JBoss Repository的远程仓库。任何一个仓库声明的id都是唯一的，配置中的url指向了仓库地址，一般来说该地址都是基于Http协议的，都可在浏览器中打开仓库地址浏览构件。
其中relesas和snapshots元素比较重要，用来控制maven对于发布版构件和快照版构件的下载。该例子中release内的enabled为true，表示开启JBoss仓库的发布版本下载支持，snapshots内的enabled为false，表示关闭JBoss仓库的快照版本的下载支持。因此，根据该配置，Maven只会从JBoss仓库下载发布版本，而不会下载快照版本。对于relesas和snapshots来说，除了有enabled，还有另外两个子元素。

<releases>
	<enabled>true</enabled>
	<updatePolicy>always</updatePolicy>
	<checksumPolicy>ignore</checksumPolicy>
</releases>

updatePolicy：配置从远程仓库更新Maven的频率，默认值为daily，表示每天检查一次。
其他取值：never-从不检查更新；always-每次检查都构建更新；internal；X-每隔X分钟检查一次更新(X为任意整数)。
checksumPolicy：用来配置maven的检查检验和文件的策略。

<settings>
	<servers>

		<server>
			<id>my-pro</id>
			<username>user</username>
			<password>pass</password>
		</server>
       ......
	</servers>
</settings>	

id：必须与pom中需要认证的repository元素的id完全一致，id将仓库信息和认证配置联系在一起了。

• 部署至远程仓库

Maven除了能对项目进行编译、测试、打包之外，还能将项目生成的构建部署带仓库中。首先需要配置pom.xml文件，增加<distributionManagement>,

 <distributionManagement>
        <repository>
            <id>aa</id>
            <url>http</url>
        </repository>
    </distributionManagement>

distributionManagement包括repository和snapshotRepository，前者表示发布版本构建的仓库，后者表示快照版本的仓库。配置正确后，在运行mvn clean deploy，Maven就会将项目构建输出输出的构件部署到配置对应的远程仓库，如果项目当前的版本是快照版本，则部署到快照版本仓库地址，否则就部署到发布版本仓库地址。

4. 生命周期和插件

Maven的生命周期是抽象的，就是为了对所有的构建过程进行抽象和统一。这个生命周期包含了项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成等几乎所有的步骤。
模拟生命周期模版方法的抽象类如下：

public abstract class AbstractBuild {
    public void build(){
        
        //初始化
        initialize();
        //编译
        compile();
        //测试
        test();
        //打包-packagepackage与java关键字冲突 所以用packckagee代替
        packckagee();
        //集成测试
        integrationTest();
        //部署
        deploy();
    }

    protected abstract void initialize();
    protected abstract void compile();
    protected abstract void test();
    protected abstract void packckagee();
    protected abstract void integrationTest();
    protected abstract void deploy();
}

• 生命周期

Maven拥有三套相互独立的生命周期，分别为clean、default和site，分别是清理项目、构建项目和建立项目站点。
clean的生命周期:

clean生命周期的目的是清理项目，它包含三个阶段：
1）pre-clean 执行一些清理前需要完成的工作。
2）clean 清理上一次构建生成的文件。
3）post-clean 执行一些清理后需要完成的工作。

default的生命周期:

compile 编译项目的主源码。一般来说，是编译src/main/java目录下的Java文件只项目输出的主classpath目录中。
process-classes
generate-test-sources
process-test-sources 处理项目测试资源文件。一般来说，是对src/test/resourece目录的内容进行变量替换等工作后，复制到项目输出的测试classpath目录中。
generate-test-sources
process-test-rsources
test-compile 编译项目的测试代码。一般来说，是编译src/test/resources牡蛎下的内容进行变量替换等工作后，复制到项目输出的测试classpath目录中。
process-test-classes
test 使用单元测试框架云馨测试，测试代码不会被打包或部署。
prepare-package
package 接受编译好的代码，打包成可发布的格式，如JAR。
pre-integration-test
post-integration-test
vertify
install 将包安装到Maven本地仓库，供本地其他Maven项目使用。
deploy 将最红的包复制到远程仓库，供其他开发人员和Maven项目使用。

site的生命周期:

pre-site 执行一些在生成项目占点之前需要完成的工作/
site 生成项目站点文档。
post-site 执行一些在生成项目站点之后需要完成的工作。
site-deploy 将生成的项目站点发不到服务器上。

• 命令行与生命周期

mvn clean：调用clean生命周期的clean阶段。

$mvn test：该命令调用default生命周期的test阶段。实际执行的阶段为default生命周期的validate、initialize等，直到test的所有阶段。这也解释了为什么在执行测试的时候，项目的代码能够自动得以编译。
$mvn clean install：该命令调用clean生命周期的clean阶段和default生命周期的install阶段。世纪执行的阶段为clean生命周期的pre-clean、clean阶段，以及default生命周期的从validate至install的所有阶段。该阶段结合了两个生命周期，在执行真正的项目构建之前清理项目是一个很好的实践。
$mvn clean deploy site-deploy：该命令调用clean生命周期的clean阶段、default生命周期的deploy阶段。实际执行的阶段为clean生命周期的lean阶段，default生命周期的deploy阶段，以及site生命周期的site-deploy阶段。世纪执行的阶段为clean生命周期的pre-clean、clean阶段，default生命周期的所有阶段，以及site生命周期的所有阶段。该命令结合了Maven所有三个生命周期，且deploy和default生命周期的最后一个阶段，site-deploy为site生命周期的最后一个阶段。

• 自定义绑定

用户可以选择将某个插件绑定到生命周期的某个阶段上，这种自定义绑定方式能让Maven项目在构建的过程中执行更多更丰富的角色。
一个常见的例子是创建项目的源码jar包，内置的插件绑定关系中并没有涉及这一任务，因此需要用户进行自行配置。maven-source-plugin可以帮助我们完成该任务，它的jar-no-fork目标能够将项目的主代码打成jar文件，可以将其绑定到default生命周期的vertify阶段上，在执行完成测试后和安装构建之前创建源码jar包。

 <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.1.1</version>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <phase>vertify</phase>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

• POM中插件全局配置

    <build>
        <plugins>
            <plugin>
             <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                 <version>2.1</version>
                <configuration>
                    <source>1.5</source>
                    <target>1.5</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

这样，不管绑定到compile阶段的maven-compile-plugin:compile任务，还是绑定到test-compiler阶段的maven-compile-plugin:testCompiler任务，就都能够使用该配置，基于Java1.5版本进行编译。

5. 聚合和继承

为了等到更清晰的设计及更高的可用性，往往会采用各种方式对软件进行划分。Maven应用到实际项目中的时候，也需要将项目划分成不同模块。
聚合特性：能够把项目的各个模块聚合在一起构建，而Maven的继承特性则能够帮助抽取各模块相同的依赖和插件等配置，在简化pom的同时，还能促进各个模块配置的一致性。
为了能够使用一条命令就能构建A和B两个模块，需要创建一个额外的名为C的模块，然后通过C模块构建整个项目的所有模块。

<?xml version="1.0" encoding="UTF-8"?>
<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.cch.com</groupId>
    <artifactId>C</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>A</module>
        <module>B</module>
    </modules>
</project>

一般情况下，聚合模块在最顶层，其他模块作为聚合模块的子模块。
从聚合模块运行mvn clean install，Maven会首先解析要聚合模块的pom、分析要构建的模块、并计算出一个反应堆要构建的顺序，然后根据这个顺序依次构建各个模块。
继承特性：
pom中如下元素可以继承：

 - groupId：项目组ID，项目坐标的核心元素
 - artifactId：项目版本，项目坐标的核心元素
 - description：项目的描述信息
 - organization：项目的组织信息
 - inceptionYear：项目的创始年份
 - url：项目的URL地址
 - developers：项目的开发者信息
 - contributors：项目的贡献者信息
 - distributionManagement：
 - issueManagement：项目的部署配置
 - ciManagement：项目的缺陷跟踪系统
 - scm：项目的版本控制系统信息
 - mailinglists：项目的邮件列表信息
 - properties：自定义的Maven属性
 - dependencies：项目的依赖配置
 - dependencyManagement：项目的依赖管理配置
 - repositories：项目的仓库配置
 - build：包括项目的源码目录配置、输出目录配置、插件配置、插件管理配置等。
 - reporting：包括项目的报告输出目录配置、报告插件配置等。

聚合主要为了方便快速构建项目；继承主要为了消除重复配置。

未完待续。。。感谢关注