快速优雅的入门Maven

﹏ヽ暗。殇╰゛Y 2022-01-06 03:47 250阅读 0赞

### 快速优雅的了解Maven ###

*  Maven简单教程
 *   *  Maven常用网站推荐
     *  Maven简介
     *  Maven仓库的种类
     *   *  仓库简介
         *  本地仓库(local)
         *  远程仓库(remote)
         *  中央仓库(central)
         *  Maven 依赖搜索顺序
     *  Maven目录详解
     *   *  Maven目录结构
         *  bin
         *  boot
         *  config
         *  lib
     *  settings.xml配置文件详解
     *  maven常用命令
     *  pom.xml详解
     *  scope详解
     *  依赖三剑客
     *   *  依赖传递
         *  依赖仲裁
         *  依赖排除

# Maven简单教程 #

## Maven常用网站推荐 ##

![mvn-logo][]  
[Maven官网][Maven]  
[Maven中央仓库][Maven 1]  
[Maven坐标仓库][Maven 2]

## Maven简介 ##

*  Maven 翻译为"专家"、“内行”，是 Apache 下的一个纯 Java 开发的开源项目。基于项目对象模型（缩写：POM）概念，Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。
 *  Maven 是一个项目管理工具，可以对 Java 项目进行构建、依赖管理。
 *  Maven 也可被用于构建和管理各种项目，例如 C\#，Ruby，Scala 和其他语言编写的项目。
 *  Maven 曾是 Jakarta 项目的子项目，现为由 Apache 软件基金会主持的独立 Apache 项目。

## Maven仓库的种类 ##

### 仓库简介 ###

*  在 Maven 的术语中，仓库是一个位置（place）。
 *  Maven 仓库是项目中依赖的第三方库，这个库所在的位置叫做仓库。
 *  在 Maven 中，任何一个依赖、插件或者项目构建的输出，都可以称之为构件。
 *  Maven 仓库能帮助我们管理构件（主要是JAR），它就是放置所有JAR文件（WAR，ZIP，POM等等）的地方。

Maven仓库三种类型: 本地（local）
    				 中央（central）
                     远程（remote）

### 本地仓库(local) ###

*  Maven 的本地仓库，在安装 Maven 后并不会创建，它是在第一次执行 maven 命令的时候才被创建。
 *  运行 Maven 的时候，Maven 所需要的任何构件都是直接从本地仓库获取的。如果本地仓库没有，它会首先尝试从远程仓库下载构件至本地仓库，然后再使用本地仓库的构件。
 *  默认情况下，不管Linux还是 Windows，每个用户在自己的用户目录下都有一个路径名为 .m2/respository/ 的仓库目录。

本机Maven默认的仓库目录:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70]

*  Maven 本地仓库默认被创建在 %USER\_HOME% 目录下。要修改默认位置，在 %M2\_HOME%\\conf 目录中的 Maven 的 **settings.xml** 文件中定义另一个路径。

<localRepository>/Users/liusheng/work/MAVEN/repository</localRepository>

### 远程仓库(remote) ###

*  如果 Maven 在本地仓库中找不到依赖的文件，它会停止构建过程并输出错误信息到控制台。为避免这种情况，Maven 提供了远程仓库的概念，它是开发人员自己定制仓库, 又称之为**私服**，它包含了所需要的代码库或者其他工程中用到的 jar 文件。

### 中央仓库(central) ###

*  Maven 中央仓库是由 Maven 社区提供的仓库，其中包含了大量常用的库。
 *  中央仓库包含了绝大多数流行的开源Java构件，以及源码、作者信息、SCM、信息、许可证信息等。一般来说，简单的Java项目依赖的构件都可以在这里下载到。

中央仓库的关键概念：仓库由 Maven 社区管理
    				 不需要配置
    				 需要通过网络才能访问

### Maven 依赖搜索顺序 ###

*  当我们执行 Maven 构建命令时，Maven 开始按照以下顺序查找依赖的库(jar)：  
    Maven找jar包的过程是这样的，先在本地仓库找，找不到再去远程仓库（如果配置了的话就称之为私服），再找不到去中央仓库（[http://repo1.maven.org/maven2/，maven团队负责维护）][http_repo1.maven.org_maven2_maven].  
    从中央仓库找到后，会在远程仓库和本地仓库放一份，从远程仓库找到后也会在本地仓库放一份
    
    ![在这里插入图片描述][2019062415383697.png]
 *  搭建私服好处多多，在一个公司内部可以开发一些公共的基础组件放到私服上，方便其他同事使用

## Maven目录详解 ##

### Maven目录结构 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 1]

### bin ###

*  该目录包含了mvn运行的脚本，这些脚本用来配置java命令，准备好classpath和相关的Java系统属性，然后执行Java命令。

### boot ###

*  该目录只包含一个文件，该文件为plexus-classworlds-2.5.2.jar。plexus-classworlds是一个类加载器框架，相对于默认的java类加载器，它提供了更加丰富的语法以方便配置，Maven使用该框架加载自己的类库。

### config ###

*  该目录包含了一个非常重要的文件settings.xml。直接修改该文件，就能在机器上全局地定制maven的行为，即对所有用户都生效。

### lib ###

*  该目录包含了所有Maven运行时需要的Java类库，Maven本身是分模块开发的，因此用户能看到诸如maven-core-3.0.jar、maven-model-3.0.jar之类的文件，此外这里还包含一些Maven用到的第三方依赖如commons-cli-1.2.jar、commons-lang-2.6.jar等等。

## settings.xml配置文件详解 ##

*  这个网上太多, 不再累述. 我们要注意的是配置自己的本地仓库位置和国内镜像.

## maven常用命令 ##

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>mvn -version</td> 
   <td>显示版本信息</td> 
  </tr> 
  <tr> 
   <td>mvn clean</td> 
   <td>删除target目录</td> 
  </tr> 
  <tr> 
   <td>mvn compile</td> 
   <td>编译src/main/java下的源代码</td> 
  </tr> 
  <tr> 
   <td>mvn package</td> 
   <td>打包，在target下生成jar包或者war包</td> 
  </tr> 
  <tr> 
   <td>mvn test</td> 
   <td>执行src/test/java下以Test开头或者以Test结尾的类的测试用例</td> 
  </tr> 
  <tr> 
   <td>mvn install</td> 
   <td>打包，并把jar包或者war包复制到本地仓库，供其他模块使用</td> 
  </tr> 
  <tr> 
   <td>mvn deploy</td> 
   <td>将打包的文件发布到私服</td> 
  </tr> 
  <tr> 
   <td>mvn dependency:tree</td> 
   <td>打印出项目的整个依赖树</td> 
  </tr> 
 </tbody> 
</table>

*  当然也可以连着使用

mvn clean package 清理打包
    mvn clean package -DskipTests=true 清理打包，并跳过测试用例
    mvn clean install 清理打包，并将jar包或者war包复制到本地仓库

## pom.xml详解 ##

*  groupId 一般都是公司域名倒过来
 *  artifactId 功能/模块命名
 *  version 版本号
 *  这三个维度确定一个jar包，就像用（x，y，z）坐标在三维空间中唯一确定一个点。
 *  packaging 打包方式，jar，war，maven-plugin（开发maven插件）

## scope详解 ##

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>解释</th> 
   <th>是否会被打入最终的jar包</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>compile</td> 
   <td>默认的scope</td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td>test</td> 
   <td>测试使用</td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td>provided</td> 
   <td>编译需要</td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td>runtime</td> 
   <td>编译不需要，运行时需要（接口与实现分离）</td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td>system</td> 
   <td>加载本地jar</td> 
   <td>否</td> 
  </tr> 
 </tbody> 
</table>

*  类似如下这种，没有指定scope，说明scope是compile

<dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>

*  test是指在运行测试用例的时候才会用到，没必要打入到最后的jar里面，所以你看到的测试框架的scope基本上都是test

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

*  provided，编译的时候会用到，但不会被打入最后的jar包  
    例如想把spring boot项目以war包的形式放在tomcat中运行，首先得加入如下依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
        <scope>provided</scope>
    </dependency>

*  或者你写了一个放在Storm集群或者Flink集群上运行的任务，最后都要把Storm的依赖或者Flink的依赖设置成provided，因为集群上已经都有这些环境的jar包、

如果你用到lombok插件的话，你会发现lombok的Maven是如下形式，说明它只会编译的时候会用到。

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.6</version>
        <scope>provided</scope>
    </dependency>

*  我写了如下一个测试类

@Data
    public class Test {
    
        private String name;
        private int age;
    }

*  生成的class文件反编译后的如下，验证了我们的想法，编译之后确实没有必要再用lombok这个jar包

public class Test {
        private String name;
        private int age;
    
        public Test() {
        }
    
        public String getName() {
            return this.name;
        }
    
        public int getAge() {
            return this.age;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    }

*  runtime，运行时才会用到。例如，如果你的项目有对数据库的操作，但没有加入相应的JDBC的实现jar包，如mysql-connector-java，是可以编译成功的，只有运行时才会报错。所以你看到的JDBC实现的jar包scope为runtime，表明这个jar包在运行时才会用到

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.35</version>
        <scope>runtime</scope>
    </dependency>

*  system，本地加载jar，当你和第三方公司合作，他们只是给了你一个jar包时，你可以有三种选择

1.  mvn install到本地仓库
2.  mvn deploy到私服
3.  指定jar包路径，从本地加载，例如如下pom形式

<dependency>
        <groupId>com.tievd.third</groupId>
        <artifactId>arcvideo</artifactId>
        <version>1.0</version>
        <scope>system</scope>
        <systemPath>${basedir}/lib/face-api-1.0.jar</systemPath>
    </dependency>

*  前文已经说到scope为system的依赖不会被打入最终的jar包，得通过配置插件等方式将依赖打入最终的jar包，所以这种方式一般很少使用。

## 依赖三剑客 ##

### 依赖传递 ###

*  假设我们现在有一个多模块项目，依赖关系如图，我们在st-web模块中引入st-dal依赖时，st-common-lib这个依赖也会被我们引入，这个就是依赖传递，下表中列出了scope在依赖过程中发生的变化，列标题为被依赖的模块的scope  
    ![在这里插入图片描述][20190624161657937.png]

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th>compile</th> 
   <th>test</th> 
   <th>provided</th> 
   <th>runtime</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>compile</td> 
   <td>compile</td> 
   <td>-</td> 
   <td>-</td> 
   <td>runtime</td> 
  </tr> 
  <tr> 
   <td>test</td> 
   <td>test</td> 
   <td>-</td> 
   <td>-</td> 
   <td>test</td> 
  </tr> 
  <tr> 
   <td>provided</td> 
   <td>provided</td> 
   <td>-</td> 
   <td>provided</td> 
   <td>provided</td> 
  </tr> 
  <tr> 
   <td>runtime</td> 
   <td>runtime</td> 
   <td>-</td> 
   <td>-</td> 
   <td>runtime</td> 
  </tr> 
 </tbody> 
</table>

### 依赖仲裁 ###

依赖仲裁就是当项目中引入的jar包，groupId （公司域名倒过来）和artifactId （功能命令）一样，但是version不一样，应该选用哪一个version？也经常被人叫做依赖冲突

*  最短路径原则

假如说我们现在的项目依赖关系如图？那么maven会选用st-common-lib的那个版本呢？

答案是1.1这个版本，st-web到st-common-lib(1.1)的距离为1，st-web到st-common-lib(1.0)的距离为2，选择距离短的，即最短路径原则  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 2]  
如何看依赖的距离关系呢？前文说过，执行如下命令打印出全局的依赖树，层级关系特别清楚  
`mvn dependency:tree > show.txt`

*  声明优先原则
    
    项目依赖如图，路径一样，会选用st-common-lib的哪个版本呢？这就得看你在pom文件中先声明是哪个依赖，如果在pom.xml中，st-remote-invoker写在前面，就会用1.0这个版本，如果st-dal写在前面，则会用1.1这个版本  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 3]

### 依赖排除 ###

*  去掉间接引入的jar包

如不想用spring boot默认提供的log，想集成第三方的log时，或者说上面依赖仲裁的第二个例子中，只想用st-common-lib的1.1版本，就可以把1.0版本排除掉

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

参考:

*  [Mave菜鸟教程][Mave]
 *  [Maven官网][Maven]
 *  [Maven仓库][Maven 2]
 *  [Maven文档][Maven 3]
 *  [把Maven的架构，用法，坑点介绍的清清楚楚][Maven 4]

[mvn-logo]: /images/20211228/bfee4344f17f4ee7b89f1cea036c611b.png
[Maven]: http://maven.apache.org/
[Maven 1]: http://repo1.maven.org/maven2/
[Maven 2]: https://mvnrepository.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70]: /images/20211228/117278451f684d0ba2d5de9196e33f73.png
[http_repo1.maven.org_maven2_maven]: http://repo1.maven.org/maven2/%EF%BC%8Cmaven%E5%9B%A2%E9%98%9F%E8%B4%9F%E8%B4%A3%E7%BB%B4%E6%8A%A4%EF%BC%89
[2019062415383697.png]: /images/20211228/2434b49e43ad4841be3da0a7a05a1cbb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 1]: /images/20211228/8b0a70bfc88543c28b29ba589d2c3695.png
[20190624161657937.png]: /images/20211228/d219ca9d2c7f4b9b9d29cb5ad57b9f71.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 2]: /images/20211228/b0be22fc3c21411eaffca2295a33a9ef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NTIyMzA2_size_16_color_FFFFFF_t_70 3]: /images/20211228/3f279902bd674b53b71dfa3c5106749d.png
[Mave]: https://www.runoob.com/maven/maven-tutorial.html
[Maven 3]: http://maven.apache.org/guides/getting-started/index.html
[Maven 4]: https://blog.csdn.net/Thinkingcao/article/details/89919182