Maven - 基础

Maven简介
Maven下载安装
Maven基础概念
Maven项目
- 手动生成Maven项目
- IDEA生成Maven项目
依赖管理
生命周期与插件
- 生命周期
- 插件

# Maven简介

Maven 官网：http://maven.apache.org/

Maven 下载：http://maven.apache.org/download.cg

为什么 Maven 会出现？

当我们升级某一个工具如 Mabatis 的时候，可能导致 Juint 版本需要更新，而这时开发人员又无法立即得知，所以产生了 jar 包冲突，那么我们需要一个强大的工具来管理每一个开发用到的 jar 包。

Maven 的本质是一个项目管理工具，将项目开发和管理过程抽象成一个项目对象模型(POM)。

POM (Project Object Model）：项目对象模型。

Maven 的作用：

项目构建：提供标准的、跨平台的自动化项目构建方式
依赖管理：方便快捷的管理项目依赖的资源（jar 包），避免资源间的版本冲突问题
统一开发结构：提供标准的、统一的项目结构

如上图的多个文件夹是早期开发的不同工具对应的文件夹，导致无法统一资源目录，而 Maven 的出现统一了资源目录，让什么资源放在什么目录的结构称为标准。

Maven Java 资源目录如下：

# Maven下载安装

# 下载

Maven 属于绿色版软件，解压即可安装。

# 配置

Maven 下载解压后，需要依赖 Java 环境才能运行，即配置好 JAVA_HOME。

并且配置好 Java 的运行环境，即在环境变量指定 Maven 的运行路径。

我这里叫 M2_HOME，也可以叫 MAVEN_HOME。

配置好 Maven 的环境变量后，需要找到 Path，配置 Maven 的 bin 目录。

# 测试

确保我们配置的内容已经生效，在命令行输入 mvn，如果看到如图效果代表成功，只要不出现 mvn 不是内部或外部命令都代表成功。

# Maven基础概念

# 仓库

仓库：用于存储资源，包含各种 jar 包。

仓库分类：本地仓库和远程仓库（私服和中央仓库）。

仓库分类:

本地仓库：自己电脑上存储资源的仓库，连接远程仓库获取资源
远程仓库：非本机电脑上的仓库，为本地仓库提供资源
中央仓库：Maven 团队维护，存储所有资源的仓库
私服：部门 / 公司范围内存储资源的仓库，从中央仓库获取资源

私服的作用：
- 保存具有版权的资源，包含购买或自主研发的 jar
- 中央仓库中的 jar 都是开源的，不能存储具有版权的资源
- 一定范围内共享资源，仅对内部开放，不对外共享

# 坐标

坐标：Maven 中的坐标用于描述仓库中资源的位置。

坐标的主要组成：
- groupId：定义当前 Maven 项目隶属组织名称（通常是域名反写）
- artifactId：定义当前 Maven 项目名称（通常是模块名称）
- version：定义当前版本号
- packaging：定义该项目的打包方式
坐标的作用：使用唯一的标识，唯一性定位资源位置，通过该标识可以将资源的识别与下载交由机器完成

# 仓库配置

我们下载的 jar 包放在本机的哪里？我们又如何自定义 jar 包的下载路径？需要进行仓库的配置。

仓库的配置需要用到 Maven 安装目录下的 conf 目录下的 settings.xml 文件，打开它

本地仓库配置

Maven 启动后，会自动保存下载的资源到本地仓库。

默认位置：

<localRepository>${user.home}/.m2/repository</localRepository>

当前目录位置为登录用户名所在目录下的 .m2 文件夹中，即 C 盘下。

自定义位置：

<localRepository>F:\Programming area\Maven\Maven_repository</localRepository>

当前目录位置为 F:\Programming area\Maven\Maven_repository 文件夹中。

笔记

建议自定义位置到空间大的磁盘，因为后期下载的 jar 包非常多，占空间大。

2022-02-05 @Young Kbt

远程仓库配置

远程仓库是固定的（国外），了解即可：Maven 默认从国外官网的中央仓库下载 jar 包。

<repositories> 
    <repository>
        <id>central</id>
        <name>Central Repository</name> 
        <url>https://repo.maven.apache.org/maven2</url>
        <layout>default</layout>
        <snapshots>
            <enabled>false</enabled> 
        </snapshots>
    </repository> 
</repositories>

1
2
3
4
5
6
7
8
9
10
11

镜像仓库配置

默认的远程仓库我们无法修改，但是我们可以修改不访问默认的远程仓库，而是访问其他的仓库，这里使用的是国内的阿里云镜像仓库。

打开 Maven 安装目录下的 conf 目录下的 settings.xml 文件，找到 <mirrors> 标签，在里面添加如下内容：

<mirrors>
    <mirror>
        <!-- 此镜像的唯一标识符，用来区分不同的 mirror 元素 -->
        <id>nexus-aliyun</id>
        <!-- 对那种仓库进行镜像（就是替代哪种仓库）-->
        <mirrorOf>central</mirrorOf>
        <!-- 镜像名称 -->
        <name>Nexus aliyun</name>
        <!-- 镜像 URL -->
        <url>http://maven.aliyun.com/nexus/content/groups/public</url>
    </mirror> 
</mirrors>

1
2
3
4
5
6
7
8
9
10
11
12

最终下载的 jar 包不再是国外的 Maven 官网仓库，而是国内的阿里云仓库，速度更快。

# Maven项目

# 手动生成Maven项目

Maven 工程目录结构

在 src 同层目录下创建 pom.xml 文件，这是 Maven 管理项目的核心文件。

文件内容例如：

<?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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>cn.knt</groupId>
    <artifactId>project-java</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>
</project>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Maven 项目构建命令

Maven 构建命令使用 mvn 开头，后面加功能参数，可以一次执行多个命令，使用空格分隔。

mvn compile # 编译
mvn clean # 清理 编译产生的内容
mvn test # 测试
mvn package	# 打包
mvn install # 安装到本地仓库

1
2
3
4
5

构建命令生成项目

创建工程

进入到指定的目录下创建项目，命令如下：

mvn archetype:generate \
	-DgroupId={project-packaging} \
	-DartifactId={project-name} \
	-DarchetypeArtifactId=maven-archetype-quickstart \
	-DinteractiveMode=false

1
2
3
4
5

创建 Java 工程

mvn archetype:generate \
    -DgroupId=cn.kbt \
    -DartifactId=java-project \
    -DarchetypeArtifactId=maven-archetype-quickstart \
    -Dversion=0.0.1-snapshot \
    -DinteractiveMode=false

1
2
3
4
5
6

创建 web 工程

mvn archetype:generate \
    -DgroupId=cn.kbt \
    -DartifactId=web-project \
    -DarchetypeArtifactId=maven-archetype-webapp \
    -Dversion=0.0.1-snapshot \
    -DinteractiveMode=false

1
2
3
4
5
6

# IDEA生成Maven项目

IDEA 对 3.6.2 及以上版本存在兼容性问题，为避免冲突，IDEA 中安装使用 3.6.1 版本。

在 IDEA 的 settings 中设置 Maven 的根目录、settings.xml 目录、仓库目录，如图：

然后新建工程的时候，选择 Maven 即可。

创建 Java 项目，选择 archetype-quickstart 进行项目创建

创建 Web 项目，选择 archetype-webapp 进行项目创建

如果用到 Tomcat，则在 pom.xml 中添加 Tomcat 插件

<build> 
    <plugins>
        <plugin> 
            <groupId>org.apache.tomcat.maven</groupId> 
            <artifactId>tomcat7-maven-plugin</artifactId> 				
            <version>2.1</version>
            <configuration>
                <port>80</port>
                <path>/</path> 
            </configuration>
        </plugin> 
    </plugins>
</build>

1
2
3
4
5
6
7
8
9
10
11
12
13

# 依赖管理

依赖配置

依赖指的是当前项目运行所需要的 jar，一个项目可以设置多个依赖。

格式：

<!-- 设置当前项目所依赖的所有 jar -->
<dependencies>
    <!-- 设置具体的依赖 -->
    <dependency>
        <!-- 依赖所属群组 id -->
        <groupId></groupId>
        <!-- 依赖所属项目 id -->
        <artifactId></artifactId>
        <!-- 依赖版本号 -->
        <version></version>
    </dependency>
</dependencies>

1
2
3
4
5
6
7
8
9
10
11
12

依赖传递

依赖具有传递性，包括直接传递和间接传递。

直接传递：在当前项目中通过依赖配置建立的依赖关系（A 使用 B，A 和 B 就是直接传递）
间接传递：被依赖的资源如果依赖其他资源，当前项目间接依赖其他资源（比较拗口，意思是如果 A 依赖 B，而 B 依赖 C，那么 A 和 C 之间就是间接传递）

依赖传递的冲突问题：

路径优先：当依赖中出现相同的资源时，层级越深，优先级越低，层级越浅，优先级越高
声明优先：当资源在相同层级被依赖时，配置顺序靠前的覆盖配置顺序靠后的
特殊优先：当同级配置了相同资源的不同版本，后配置的覆盖先配置的

可选依赖 optional

可选依赖指的是对外隐藏当前所依赖的资源。

<dependency>
    <groupId></groupId>
    <artifactId></artifactId>
    <version></version>
    <!-- 添加下面这一行，对外隐藏 -->
    <optional>true</optional>
</dependency>

1
2
3
4
5
6
7

排除依赖 exclusions

排除依赖指主动断开依赖的资源，被排除的资源无需指定版本。

exclusions 支持排除多个依赖，每个依赖需要用 <exclusion> 包裹起来。

<dependency>
    <groupId></groupId>
    <artifactId></artifactId>
    <version></version>
    <!-- exclusions 支持排除多个依赖 -->
    <exclusions>
        <exclusion>
            <groupId></groupId>
            <artifactId></artifactId>
        </exclusion>
    </exclusions>
</dependency>

1
2
3
4
5
6
7
8
9
10
11
12

依赖范围

依赖的 jar 包默认情况可以在任何地方使用，可以通过 scope 标签设定其作用范围。

作用范围：

主程序范围有效（main 文件夹范围内）
测试程序范围有效（test 文件夹范围内）
是否参与打包（package 文件夹范围内）

scope	主代码	测试代码	打包	范例
compile（默认）	生效	生效	生效	log4j
test		生效		junit
provided	生效	生效		servlet-api
runtime			生效	jdbc

选择 scope，主要看在哪个范围不生效。

带有依赖范围的资源在进行传递时，作用范围将受到影响。

<dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.11</version>
        <scope>test</scope>
    </dependency>
</dependencies>

1
2
3
4
5
6
7
8

# 生命周期与插件

# 生命周期

Maven 项目构建生命周期描述的是一次构建过程经历了多少个事件，配合插件使用（到了某个生命周期触发插件）。

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

clean：清理工作
default：核心工作，例如编译、测试、打包、部署等
site：产生报告，发布站点等

clean 生命周期

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

default 生命周期

validate（校验） 校验项目是否正确并且所有必要的信息可以完成项目的构建过程。
initialize（初始化） 初始化构建状态，比如设置属性值。
generate-sources（生成源代码） 生成包含在编译阶段中的任何源代码。
process-sources（处理源代码） 处理源代码，比如说，过滤任意值。
generate-resources（生成资源文件） 生成将会包含在项目包中的资源文件。
process-resources （处理资源文件） 复制和处理资源到目标目录，为打包阶段最好准备。
compile（编译） 编译项目的源代码。
process-classes（处理类文件） 处理编译生成的文件，比如说对Java class文件做字节码改善优化。
generate-test-sources（生成测试源代码） 生成包含在编译阶段中的任何测试源代码。
process-test-sources（处理测试源代码） 处理测试源代码，比如说，过滤任意值。
generate-test-resources（生成测试资源文件） 为测试创建资源文件。
process-test-resources（处理测试资源文件） 复制和处理测试资源到目标目录。
test-compile（编译测试源码） 编译测试源代码到测试目标目录.
process-test-classes（处理测试类文件） 处理测试源码编译生成的文件。
test（测试） 使用合适的单元测试框架运行测试（Juint是其中之一）。
prepare-package（准备打包） 在实际打包之前，执行任何的必要的操作为打包做准备。
package（打包） 将编译后的代码打包成可分发格式的文件，比如JAR、WAR或者EAR文件。
pre-integration-test（集成测试前） 在执行集成测试前进行必要的动作。比如说，搭建需要的环境。
integration-test（集成测试） 处理和部署项目到可以运行集成测试环境中。
post-integration-test（集成测试后） 在执行集成测试完成后进行必要的动作。比如说，清理集成测试环境。
verify （验证） 运行任意的检查来验证项目包有效且达到质量标准。
install（安装） 安装项目包到本地仓库，这样项目包可以用作其他本地项目的依赖。
deploy（部署） 将最终的项目包复制到远程仓库中与其他开发者和项目共享。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

并不是都会执行所有的步骤，而是执行选择步骤的上方步骤，如选择了 generate-test-resources，则 generate-test-resources 上面的步骤都会执行，但是下面的并不会执行。

site 生命周期

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

# 插件

插件与生命周期内的阶段绑定，在执行到对应的生命周期时执行对应的插件功能。

代码示例：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>2.2.1</version>
            <executions>
                <execution>
                    <goals>  <!-- 当运行到指定 phase 时执行 goals 内容 -->
                        <goal>jar</goal>  		<!-- 项目源码打 jar 包 -->
                        <goal>test-jar</goal>   <!-- 测试源码打 jar 包 -->
                    </goals>
                    <phase>generate-test-resources</phase> <!-- phase：阶段 -->
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

则运行到 generate-test-resources 阶段时，执行两个 goal 的内容：项目源码打 jar 包，测试源码打 jar 包。

编辑此页

#Maven

更新时间: 2023/10/23, 10:58:52

Maven - 进阶→