Maven 使用手册

文章目录

什么是Maven
作用
- 项目构建
- 依赖管理
目录结构
核心概念
- POM
- Maven仓库
- - 本地仓库
  - 远程仓库
  - - 中央仓库
    - 私服
- 坐标
- 依赖
- - 依赖传递
  - 依赖冲突
  - - 路径最短者优先
    - 路径相同先声明优先
    - 统一管理依赖的版本
  - 依赖范围
  - 可选依赖
  - 排除依赖
- 聚合
- - 概念
  - 实现
- 继承
- - 概念
  - 实现
Maven安装与配置
- 下载/解压
- 配置环境变量
- 配置文件
- - 配置本地仓库位置
  - 配置阿里云镜像
  - Maven工程的默认jdk
Maven常用操作
- 手动安装Maven依赖
- - 命令行
  - 实例
- 部署jar包到远程仓库
- - 远程仓库认证
  - 部署jar包到远程仓库
  - 命令行

什么是Maven

Apache Maven是一个项目管理工具，它基于项目对象模型(POM)的概念，通过一小段描述信息来管理项目的构建、报告和文档。

作用

Maven是跨平台的项目管理工具，主要服务于基于Java平台的项目构建，依赖管理和项目信息管理。

项目构建

项目构建包括清理，···，编译，测试，报告，打包，部署 ···等步骤

依赖管理

传统方式管理jar包依赖的问题：

jar包冲突
jar包依赖
jar包体积过大
jar包在不同阶段无法个性化配置

使用maven方式管理jar包依赖的好处：

解决jar包冲突
解决jar包依赖问题
jar包不用再每个项目保存，只需要放在仓库即可
maven可以指定jar包的依赖范围

目录结构

若要使用Maven，那么项目的目录结构必须符合Maven的规范，其目录结构如下：

核心概念

POM

POM(Project Object Model)项目对象模型，一个项目所有的配置都放在POM文件中：定义项目的类型、名字、管理依赖关系，定制插件的行为等等。Maven通过pom.xml文件来管理依赖和管理项目的构建生命周期，而项目构建的生命周期是依靠一个个的插件完成的。

Maven仓库

Maven管理资源的位置。仓库里面包含依赖（jar）和插件（plugin）。Maven仓库分为本地仓库和远程仓库，而远程仓库又包括私服和中央仓库。

本地仓库

用户自己电脑上的仓库，直接从本地获取。

远程仓库

中央仓库

Maven官方提供的远程仓库，里面拥有最全的jar包资源，Maven首先从本地仓库中寻找项目所需的jar包，若本地仓库没有，再到Maven的中央仓库下载所需jar包。地址是：http://repo1.maven.org/maven2/。

私服

私服是一种特殊的远程仓库，搭建在局域网内的仓库，私服代理广域网的仓库，提供给局域网内的用户使用，可用减少局域网内的用户与外界仓库的传输，每一个jar包只需要拉取一次就可以提供给局域网内所有的用户使用，并且也更加稳定

坐标

在Maven中，坐标是jar包的唯一标识，Maven通过坐标在仓库中找到项目所需的jar包

标签说明：

groupId：公司或组织域名倒序
artifactId：模块名
version：版本号
packaging：项目的打包方式(pom/jar/war，默认jar)

依赖

依赖传递

声明：非compile范围的依赖是不能传递的。

如果我们的项目引用了一个Jar包，而该Jar包又引用了其他Jar包，那么在默认情况下项目编译时，Maven会把直接引用和简洁引用的Jar包都下载到本地。传递性依赖机制能够大大的简化依赖声明，而且大部分情况下我们只需要关心项目的直接依赖是什么，而不用考虑这些直接依赖会引入什么传递性依赖，但是当出现冲突了，则需要很清楚传递性依赖是从什么依赖路径引入的。

WebMavenDemo项目依赖JavaMavenService1，JavaMavenService1项目依赖JavaMavenService2

pom.xml文件配置好依赖关系后，必须首先mvn install后，依赖的jar包才能使用。

WebMavenDemo的pom.xml文件想能编译通过，JavaMavenService1必须mvn install
JavaMavenService的pom.xml文件想能编译通过，JavaMavenService2必须mvn install

为JavaMavenService2中增加了一个spring-core.jar包后，会惊喜的发现依赖的两个项目都自动的增加了这个jar包，这就是依赖的传递性。

依赖冲突

依赖的原则主要是为了解决模块之间jar包冲突问题

路径最短者优先

例如：当我们工程Animal依赖Cat，Cat又依赖Action，每个单独工程中Action依赖log4j-1.2.17，Cat依赖log4j-1.2.14，那我们的Animal工程要依赖于哪个版本呢？

答：其实Maven为我们提供了内置的原则，就是路径最短者优先，我们的Animal工程最终依赖的是log4j-1.2.14

路径相同先声明优先

例如：当我们工程Animal同时依赖Cat，又依赖Action，每个单独工程中Action依赖log4j-1.2.17，Cat依赖log4j-1.2.14，这时候依赖的路径是相同的，那我们的Animal工程最终依赖的是哪个版本呢？

答：这个时候我们要看这两个jar文件在pom文件声明的先后顺序，优先声明者先依赖。

统一管理依赖的版本

为了统一管理版本号，可以使用properties标签，里面可以自定义版本的标签名。在使用的地方使用${自定义标签名}

<properties><!-- 在properties里面统一管理依赖的版本 -->  <spring-boot.version>2.1.3.RELEASE</spring-boot.version><spring-cloud-starter-alibaba.version>0.9.0.RELEASE</spring-cloud-starter-alibaba.version><maven.compiler.source>1.8</maven.compiler.source><maven.compiler.target>1.8</maven.compiler.target>
</properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>${spring-boot.version}</version></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId><version>${spring-cloud-starter-alibaba.version}</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId><version>${spring-boot.version}</version></dependency>
</dependencies>

依赖范围

依赖范围就是控制依赖在不同阶段的作用。不同的依赖会使用不同的classpath，在Maven中依赖的域有这几个：import、provided、runtime、compile、system、test。默认取值为compile。

可选依赖

在导入一个依赖的时候，是否需要把这个依赖向下传递

false：可以向下传递（默认值）
true：不可以向下传递

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.1.6.RELEASE</version><!-- 不可以向下传递依赖 --><optional>true</optional>
</dependency>

排除依赖

如果我们只想下载直接引用的Jar包，那么需要在pom.xml中做如下配置：

(将需要排除的Jar包的坐标写在中)

<dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-web</artifactId>  <!-- 去掉springboot默认配置的logback依赖 -->  <exclusions><exclusion>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-logging</artifactId>  </exclusion>  </exclusions>
</dependency>

聚合

概念

将多个项目同时运行就称为聚合。聚合的作用，是为了简化构建项目的过程。一次性构建多个项目！

实现

只需在pom文件中作如下配置即可实现聚合：

<modules><module>nacos-config-example</module><module>nacos-discovery-example</module><module>nacos-gateway-example</module>
</modues>

继承

概念

在聚合多个项目时，如果这些被聚合的项目中需要引入相同的Jar，那么可以将这些Jar写入父pom中，各个子项目继承该pom即可。继承的作用，为了简化pom.xml配置，简化groupId，artifactId， version ，还可以锁定子工程依赖版本。

实现

父pom配置：将需要继承的Jar包的坐标放入标签即可。

<dependencyManagement><dependencies><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>28.0-jre</version></dependency></dependencies>
</dependencyManagement>

子pom配置：

<parent><groupId>父pom所在项目的groupId</groupId><artifactId>父pom所在项目的artifactId</artifactId><version>父pom所在项目的版本号</version>
</parent>

Maven安装与配置

下载/解压

在网上找到相应的maven资源，如下图进行解压：

配置环境变量

新建系统变量

变量名：M2_HOME

变量值：C:\develop\Maven\apache-maven-3.6.0（以实际为准）
Path系统变量

在Path系统变量新增环境变量 %M2_HOME%\bin ，然后保存
命令提示符

在命令提示符下输入mvn –version，如果你看到类似消息，说明 Apache Maven 在 Windows 上已安装成功。

配置文件

配置本地仓库位置

Maven安装好之后默认配置了本地仓库，在%user%/.m2/respository目录，但是通常不会使用Maven的默认本地仓库，而是修改maven的本地仓库的地址，修改Maven目录的conf/settings.xml

<localRepository>C:\develop\Maven\apache-maven-3.6.0\respository</localRepository>

配置阿里云镜像

为了更好的下载速度，我们会选用国内镜像，这里配置的是阿里云镜像

<!-- 配置阿里云镜像 -->
<mirror><!--该镜像的唯一标识符。id用来区分不同的mirror元素。 --><id>nexus-aliyun</id><!--*指的是访问任何仓库都使用我们的私服--><mirrorOf>*</mirrorOf><!--镜像名称--><name>Nexus aliyun</name><!--该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL--><url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>

Maven工程的默认jdk

创建Maven项目的时候，默认编译的jdk版本是1.7，但是我们需要使用的是jdk1.8版本

<!-- 配置maven编译jdk版本 -->
<profile>    <id>jdk-1.8</id>    <activation>    <activeByDefault>true</activeByDefault>    <jdk>1.8</jdk>    </activation>    <properties>    <maven.compiler.source>1.8</maven.compiler.source>    <maven.compiler.target>1.8</maven.compiler.target><maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion> </properties>
</profile>

Maven常用操作

手动安装Maven依赖

maven仓库官网：https://mvnrepository.com/

像Oracle驱动包在Maven中心仓库是找不到的，需要到Oracle官网下载，然后手动安装Maven依赖

命令行

mvn install:install-file -DgroupId=groupId -DartifactId=artifactId -Dversion=version -Dpackaging=jar -Dfile=jar包的位置

实例

mvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc7 -Dversion=12.1.0.2 -Dpackaging=jar -Dfile=E:\ojdbc7.jar

执行完maven命令，然后再引入依赖

<dependency><groupId>com.oracle</groupId><artifactId>ojdbc7</artifactId><version>12.1.0.2</version>
</dependency>

部署jar包到远程仓库

远程仓库认证

大部分远程仓库无需认证就可以访问，但有时候出于安全方面的考虑，我们需要提供认证信息才能访问一些远程仓库。例如，组织内部有一个Maven仓库服务器，该服务器为每个项目都提供独立的Maven仓库，为了防止非法的仓库访问，管理员为每个仓库提供了一组用户名及密码。这时，为了能让Maven访问仓库内容，就需要配置认证信息。

setting.xml文件：

<servers><server><id>releases</id><username>admin</username><password>admin123</password></server><server><id>snapshots</id><username>admin</username><password>admin123</password></server>
</servers>

部署jar包到远程仓库

私服的一大作用是部署第三方构件，包括组织内部生成的构件以及一些无法从外部仓库直接获取的构件。无论是日常开发中生成的构件，还是正式版本发布的构件，都需要部署到仓库中，供其他团队成员使用。

Maven除了能对项目进行编译、测试、打包之外，还能将项目生成的构建部署到仓库中。首先，需要编写项目的pom.xml文件，配置distributionManagement元素见下面：

注意：repository里的id需要和第一步里的server id名称保持一致

<project>
...<distributionManagement><repository><!--repository里的id需要和第一步里的server id名称保持一致--><id>releases</id><!--仓库名称--><name>Releases</name><!--私服仓库地址--><url>http://10.172.0.201:8081/repository/maven-releases/</url></repository><snapshotRepository><id>snapshots</id><name>Snapshot</name><url>http://10.172.0.201:8081/repository/maven-snapshots/</url></snapshotRepository></distributionManagement>
...
</project>

distributionManagement包含repository和snapshotRepository子元素：

（这两个子元素都配置id、name和url，id为该远程仓库的唯一标识，name是为了方便人阅读，url表示该仓库的地址）

repository：发布版本构建的仓库
snapshotRepository：表示快照版本的仓库

命令行

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