[后端] maven学习笔记 (一): 项目结构/依赖管理

Maven 学习笔记 (一)

Maven 的作用

按照维基百科的说法：
Apache Maven，是一个软件（特别是Java软件）项目管理及自动构建工具，由Apache软件基金会所提供。Maven也可被用于构建和管理各种项目，例如C#，Ruby，Scala和其他语言编写的项目。
Maven解决了软件构建的两方面问题：一是软件是如何构建的，二是软件的依赖关系。

简单来说，Maven是我们管理项目的构建工具。

Maven 的项目结构

一个标准的 Maven 项目应有如下结构：

|-- pom.xml (Maven配置文件)
|-- src (源代码)
    |-- main (源代码)
        |-- java (java源代码)
        |-- resources (资源)
    |-- test (测试)
        |-- java (java测试代码)
|-- target (编译目标文件)

Maven POM

• POM是Maven的最重要配置文件，用于配置Maven项目信息
• POM以pom.xml的形式存在于Maven项目的根目录下
• 以下是一个典型的POM文件：

<?xml version="1.0" encoding="UTF-8"?>
<!-- Maven版本信息 -->
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!-- 模型版本信息 -->
	<modelVersion>4.0.0</modelVersion>

    <!-- 父工程的信息 -->
	<parent>
        <!-- 父工程组标识，标识工程所属组织 -->
		<groupId>org.springframework.boot</groupId>
        <!-- 父工程标识 -->
		<artifactId>spring-boot-starter-parent</artifactId>
        <!-- 父工程版本信息 -->
		<version>2.4.5</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
    
    <!-- 工程信息 -->
    <!-- 工程标识 -->
	<groupId>com.eastwood</groupId>
    <!-- 工程标识 -->
	<artifactId>homeworkProject</artifactId>
    <!-- 工程版本 -->
	<version>1.0-SNAPSHOT</version>

    <!-- 项目属性变量 -->
	<properties>
		<java.version>1.8</java.version>
	</properties>

    <!-- 项目依赖 -->
	<dependencies>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
            <!--依赖范围 (compile(默认)/provided/runtime/test/system) -->
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.20</version>
		</dependency>

	</dependencies>

    <!-- 插件管理 -->
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<version>2.4.5</version>
			</plugin>
		</plugins>
	</build>
</project>

依赖管理

快速入门

直到笔者当前的学习阶段，依赖管理是maven最常用的功能。
在maven中导入依赖，只需在pom.xml中的<dependencies>中添加<dependence>项即可。
依赖传递是maven最常用的特性，即当我们导入一个包时，maven会自动导入该包的所有依赖。

依赖属性

在pom.xml中，依赖有如下如下属性：

元素	类型	描述
groupId	String	提供该依赖的组织名，如org.apache.maven
artifactId	String	该依赖的唯一标识，如maven-artifact
version	String	依赖版本号，如3.2.1。在Maven2中，也可以表示版本范围
classifier	String	依赖类型，有两个作用：1. 表示附加标识，如 sources、javadoc；2. 区分同一POM中用不同jdk构建的版本，如jdk14，jdk15
scope	String	依赖范围(详见下文)
systemPath	String	仅适用于system范围，已不建议使用，标识该依赖在文件系统中的路径
exclusions/exclusion*	List<Exclusion>	在依赖传递中需要排除的依赖的集合(多项)
optional	String	表示该依赖在这个库中的使用是非强制的。虽然当库在其他地方使用时依赖项的版本将被考虑到依赖项计算，但它不会被传递。注意，该属性虽然因技术原因描述为String，本质是Boolean，默认值是false

maven的依赖文件名是属性从上到下拼接而成的，要注意属性的顺序。

依赖范围

依赖范围用于限制依赖传递，决定依赖何时被引用。

范围	特征
compile	默认范围，该范围依赖项在项目的所有类路径中可用。参与全过程周期且会被打包。此外，该范围依赖可以被传递
provided	表示依赖项由运行时的 JDK 或者网络服务器提供。该范围依赖项会被添加到用于编译和测试的类路径中，而非运行时的类路径中。该范围依赖不传递。不会被打包。
runtime	表示依赖在编译时不需要，而在运行时需要。Maven在运行时和测试类路径中引用该依赖，而在编译类路径中不引用。(数据库驱动包一般是该范围)
test	该范围依赖项在正常运行中不被需要，且只在测试编译及运行阶段可用。该范围不传递
system	该范围与 provided 相似，用于导入本地的JAR，需要在 systemPath 属性中指出JAR包的位置。该依赖参与全过程，但默认不会被打包。

在使用 system 范围时，可能因本地 JAR 包无法打包产生问题，需要在依赖项中进行以下配置：

<configuration>
	<includeSystemScope>true</includeSystemScope>
</configuration>

该配置的作用是让本地包也参与打包

依赖传递

• 一般情况下，依赖传递的作用是在导入依赖时，自动导入该依赖的依赖。但可能出现依赖冲突的情况，此时需要依赖仲裁介入。
• 依赖仲裁
  在发生依赖冲突时，Maven采用“最近定义”原则。即采用在依赖树中离该项目更近的版本。例如项目有如下依赖树：

A
|-B
|--C
|---D 2.0
|-E
|--D 1.0

该树中，根节点 A 为本项目。
对于节点（依赖） D ，存在两条依赖路径：A->B->C->D 和 A->E->D ，其中第二条路径更短，故采用第二条路径中 D 的版本。若深度（路径长度）一致，采用靠前的版本。
除此之外，也可以在 POM 中直接指定需要使用的依赖版本。

• 依赖传递受依赖范围的影响，部分范围的依赖不会传递。
• 导入含有可选依赖项的依赖时，默认不会传递标记为可选依赖的依赖，但可指定导入可选依赖。