Maven

发表于 2023-11-25 更新于 2023-12-19 分类于 Java ， Maven

简单介绍Maven、安装配置、基本使用、IDEA使用Maven和依赖管理

前言

之前胡乱吞枣的看过Maven的视频，当时就是啥也没记住，看完视频就算完了，然后在看Servlet时感觉前面的都忘掉了，想着再看一遍，既然都看了，就得留下点东西吧，既是总结，也是为了以后方便自己回顾。

1. Maven简介

Maven是专门用于管理和构建Java项目的工具，它基于项目对象模型(POM-Project Object Model)的概念，通过一小段描述信息来管理项目的构建、报告和文档，Maven官网，它的主要功能有：

提供了一套标准化的项目结构，便于不同IDE的项目可以通用

提供了一套标准化的构建流程（编译，测试，打包，发布……）

提供了一套依赖管理机制，方便管理项目依赖的第三方资源

标准化的项目结构：

项目结构我们都知道，每一个开发工具（IDE）都有自己不同的项目结构，它们互相之间不通用。我在eclipse中创建的项目，无法在IDEA中进行使用，这就造成了很大的不方便。

而Maven提供了一套标准化的项目结构，所有的IDE使用Maven构建的项目完全一样，所以IDE创建的Maven项目可以通用。下图就是Maven构建的项目结构：

其中pom.xml项目核心配置文件和src目录同级。

标准化的构建流程：

我们开发了如上图所示的一套系统，代码需要进行编译 -> 测试 -> 打包 ->发布，这些操作如果需要反复进行就显得特别麻烦，而Maven提供了一套简单的命令来完成项目构建。

依赖管理机制：

依赖管理就是管理项目所依赖的第三方资源（jar包、插件）。如项目中需要使用JDBC和Druid的话，就需要去网上下载对应的依赖包，复制到项目中，还要将jar包加入工作环境这一系列的操作。如下图所示：

而Maven使用标准的坐标配置来管理各种依赖，只需要简单的配置就可以完成依赖管理。在pom.xml项目核心配置文件中进行配置：

如上图右边所示就是mysql驱动包的坐标，在项目中只需要写这段配置，其他都不需要我们担心，Maven都帮我们进行操作，mysql驱动包会自动放到项目的External Libraries中。

1.1 Maven模型

Maven模型包含三部分：

项目对象模型 (Project Object Model)
依赖管理模型(Dependency)
插件(Plugin)

如上图所示就是Maven的模型，红色框框起来的部分，用来完成 标准化构建流程 。如我们需要编译，Maven提供了一个编译插件供我们使用，我们需要打包，Maven就提供了一个打包插件提供我们使用等。

上图中黑色框起来的部分，项目对象模型就是将我们自己的项目抽象成一个对象模型，有自己专属的坐标，如下图所示是一个Maven项目模型，黑色框是当前项目坐标：

依赖管理模型是使用坐标来描述当前项目依赖哪些第三方jar包，红色框框所示。

1.2 Maven仓库

有这样的场景，我们创建Maven项目，在项目中使用坐标来指定项目依赖的第三方jar包，那么依赖的jar包到底存储在什么地方呢？其实依赖jar包是存储在我们的本地仓库中。而项目运行时从本地仓库中拿需要的依赖jar包。

Maven共有三种仓库，分别是：

本地仓库：自己计算机上的一个目录
中央仓库：由Maven团队维护的全球唯一的仓库
- 地址： https://repo1.maven.org/maven2/
远程仓库(私服)：一般由公司团队搭建的私有仓库

今天我们只学习远程仓库的使用，并不会搭建。

当项目中使用坐标引入对应依赖jar包后，首先会查找本地仓库中是否有对应的jar包：

如果有，则在项目直接引用;
如果没有，则去中央仓库中下载对应的jar包到本地仓库。

graph LR;
    A[Maven项目1] ----> B[Maven本地仓库];
    D[Maven项目2] ----> B[Maven本地仓库];
    B[Maven本地仓库] ----> C[Maven中央仓库];
    
	A[Maven项目1] ----> B[Maven本地仓库];
	D[Maven项目2] ----> B[Maven本地仓库];
	C[Maven中央仓库] ----> B[Maven本地仓库];

如果还可以搭建远程仓库，将来jar包的查找顺序则变为：

本地仓库 --> 远程仓库–> 中央仓库

graph LR;
    A[Maven项目1] ----> B[Maven本地仓库];
    D[Maven项目2] ----> B[Maven本地仓库];
    B --> E[远程仓库]
    E --> C[中央仓库]
    
	A[Maven项目1] ----> B[Maven本地仓库];
	D[Maven项目2] ----> B[Maven本地仓库];
	E --> B
	C --> E

2. Maven安装配置

1. 安装Maven到没有中文、特殊字符的路径下。
  
  安装打开文件夹后的目录结构如下:
  1
  2
  3
  4
  5
  6
  7
  |-- bin (文件夹)
  |-- boot (文件夹)
  |-- conf (文件夹)
  |-- lib (文件夹)
  |-- LICENSE
  |-- NOTICE
  |-- README.txt
  - bin目录：存放Maven可执行命令，例如mvn命令
  - conf目录：存放Maven的配置文件。settings.xml 配置文件后期需要修改。
  - lib目录：存放Maven依赖的jar包。Maven也是使用java开发的，所以它也依赖其他的jar包。
1. 配置环境变量
  - 在系统变量中新建一个变量MAVEN_HOME
    
    变量名 MAVEN_HOME
    
    变量值 D:\apache-maven-3.9.5
  - 在PATH中添加新的值%MAVEN_HOME%\bin
  - 在命令行窗口中输入mvn --version进行验证
1. 配置本地仓库

变量名	MAVEN_HOME
变量值	D:\apache-maven-3.9.5

修改 conf/settings.xml 中的为一个指定目录作为本地仓库，用来存储jar包。
1
<localRepository>D:\apache-maven-3.9.5\mvn_resp</localRepository>
如果不配置的话本地仓库的默认目录为C:\Users\用户名\.m2\repository

配置阿里云私服

中央仓库在国外，所以下载jar包速度可能比较慢，而阿里公司提供了一个远程仓库，里面基本也都有开源项目的jar包。

修改 conf/settings.xml 中的标签，为其添加如下子标签：
1
2
3
4
5
<mirror>  
        <id>alimaven</id>  
        <name>aliyun maven</name>   			         <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        <mirrorOf>central</mirrorOf>          
</mirror>

3. Maven基本使用

3.1 Maven常用命令

compile：编译项目的源代码，将源代码编译成字节码文件。

clean：清理项目，删除之前构建过程中生成的目录和文件，通常用于在重新构建项目之前执行。

test：运行项目中的测试用例。

package：将项目打包成可发布的格式，比如 JAR（Java Archive）或 WAR（Web Archive）。

install：将项目打包结果安装到本地 Maven 仓库中，以供其他项目引用。

假设我们已经有了一个Maven构建的项目，项目结构如下：

1
2
3

maven-project
	|--- src (文件夹)
	|--- pom.xml

我们使用上面命令需要在磁盘上进入到项目的 pom.xml 同级目录下，打开命令提示符。

编译命令演示：
1
2
compile:编译
mvn compile
执行上述命令可以看到：
- 从阿里云下载编译需要的插件的jar包，在本地仓库也能看到下载好的插件。
- 在项目下会生成一个 target 目录，编译后的字节码文件就放在target目录中。
  
  此时的Maven项目结构为：
  1
  2
  3
  4
  maven-project
  |--- src (代码文件夹)
  |--- target (存放字节码文件)
  |--- pom.xml
清理命令演示：
1
2
clean:清理
mvn clean
执行上述命令可以看到
- 从阿里云下载清理需要的插件jar包
- 删除项目下的 target 目录
  
  此时的Maven项目结构为：
  1
  2
  3
  maven-project
  |--- src (代码文件夹)
  |--- pom.xml
打包命令演示：
1
2
package:打包
mvn package
执行上述命令可以看到：
- 从阿里云下载打包需要的插件jar包
- 在项目的 terget 目录下有一个jar包（将当前项目打成的jar包，Web项目会打包成war包）
测试命令演示：
1
2
test:测试
mvn test
该命令会执行所有的测试代码。
安装命令演示：
1
mvn install
该命令会将当前项目打成jar包（将当前项目打成的jar包，Web项目会打包成war包），并安装到本地仓库。

3.2 Maven生命周期

Maven 构建项目生命周期描述的是一次构建过程经历经历了多少个事件

Maven 对项目构建的生命周期划分为3套：

clean ：清理工作。
default ：核心工作，例如编译，测试，打包，安装等。
site ：产生报告，发布站点等。这套声明周期一般不会使用。

同一套生命周期内，执行后边的命令，前面的所有命令会自动执行。例如默认（default）生命周期如下：

graph LR
    A((开始)):::circle -->|验证通过| B[compile]
    B -->|编译成功| C[test]
    C -->|测试通过| D[package]
    D -->|打包成功| E[install]
    E -->|安装成功| F((结束))

当我们执行 install（安装）命令时，它会先执行 compile命令，再执行 test 命令，再执行 package 命令，最后执行 install 命令。

当我们执行 package （打包）命令时，它会先执行 compile 命令，再执行 test 命令，最后执行 package 命令。

4. IDEA使用Maven

4.1 IDEA配置Maven环境

需要先在IDEA中配置Maven环境：

在IDEA中点击File（或者alt + F打开），然后点击Settings。

IDEA -> File -> Settings
搜索maven
设置 IDEA 使用本地安装的 Maven，并修改配置文件路径，即修改Maven home path和User settings file。
- 修改前：
  
  Maven home path: Bundled (Maven 3)
  
  User settings file: C:\Users\用户名.m2\settings.xml
  
  Local repository: C:\Users\用户名.m2\repository
- 修改后：
  
  Maven home path: D:\apache-maven-3.9.5
  
  User settings file: D:\apache-maven-3.9.5\conf\settings.xml
  
  Local repository: D:\apache-maven-3.9.5\mvn_resp
点击Apply，再点击OK生效

Maven home path:	Bundled (Maven 3)
User settings file:	C:\Users\用户名.m2\settings.xml
Local repository:	C:\Users\用户名.m2\repository

Maven home path:	D:\apache-maven-3.9.5
User settings file:	D:\apache-maven-3.9.5\conf\settings.xml
Local repository:	D:\apache-maven-3.9.5\mvn_resp

4.2 Maven坐标详解

什么是坐标？

Maven 中的坐标是资源的唯一标识
使用坐标来定义项目或引入项目中需要的依赖

Maven 坐标主要组成

groupId：定义当前Maven项目隶属组织名称（像是公司名称，通常是域名反写，例如：com.itheima）
artifactId：定义当前Maven项目名称（通常是模块名称，例如 order-service、goods-service）
version：定义当前项目版本号

如下面就是使用坐标表示一个项目：

1
2
3

<groupId>com.itheima</groupId>
<artifactId>maven-demo</artifactId>
<version>1.0-SNAPSHOT</version>

注意：

上面所说的资源可以是插件(像编译maven所需插件或者打包所需插件)、依赖、当前项目。

我们的项目如果被其他的项目依赖时，也是需要坐标来引入的。

4.3 IDEA创建Maven项目

填写模块信息，点击Create

创建好的项目目录结构如下：

maven项目
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com.itheima
│   │   │       └── Main.java
│   │   └── resources
|   |
│   └── test
│       ├── java
│       │   └── com.itheima
│       │       └── MainTest.java
│       └── resources   //注意，创建完项目后会发现test中没有resources文件夹，需要自己创建
│           
├── pom.xml

4.4 IDEA导入Maven项目

可以通过以下步骤进行项目的导入：

选择右侧Maven面板，点击 + 号
选中对应项目的pom.xml文件，双击即可

4.5 配置Maven-Helper插件

为方便Maven操作可在IDEA中下载Maven插件提高工作效率：

选择 IDEA中 File --> Settings
选择 Plugins
搜索 Maven，选择第一个 Maven Helper，点击Install安装，弹出面板中点击Accept
重启 IDEA

安装完该插件后可以通过选中项目右键进行相关命令操作。

5. 依赖管理

5.1 使用坐标引入jar包

使用坐标引入jar包的步骤：

在项目的 pom.xml 中编写标签
在标签中使用引入坐标

定义坐标的 groupId，artifactId，version

<dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>
</dependencies>

点击刷新按钮，使坐标生效

自动导入设置：

上面每次操作都需要点击刷新按钮，让引入的坐标生效。当然我们也可以通过设置让其自动完成

选择 IDEA中 File --> Settings
在弹出的面板中找到 Build Tools
选择 Any changes，点击 ok 即可生效

5.2 依赖范围

通过设置坐标的依赖范围(scope)，可以设置对应jar包的作用范围：编译环境（在主工程java目录下可以使用依赖）、测试环境（在主工程test目录下可以使用依赖）、运行环境（打包成jar包或者war包后lib中有这个第三方依赖jar包）。

如下图所示给 junit 依赖通过 scope 标签指定依赖的作用范围。那么这个依赖就只能作用在测试环境，其他环境下不能使用。

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

那么 scope 都可以有哪些取值呢？

依赖范围	编译classpath	测试classpath	运行classpath	例子
compile(默认范围)	Y	Y	Y	logback
test	-	Y	-	Junit
provided	Y	Y	-	servlet-api
runtime	-	Y	Y	jdbc驱动
system	Y	Y	-	存储在本地的jar包

compile(默认范围) ：作用于编译环境、测试环境、运行环境。
test ：作用于测试环境。典型的就是Junit坐标，以后使用Junit时，都会将scope指定为该值
provided ：作用于编译环境、测试环境。我们后面会学习 servlet-api ，在使用它时，必须将 scope 设置为该值，不然运行时就会报错
runtime ：作用于测试环境、运行环境。jdbc驱动一般将 scope 设置为该值，当然不设置也没有任何问题

注意：

如果引入坐标不指定 scope 标签时，默认就是 compile 值。以后大部分jar包都是使用默认值。