Maven 依赖机制

Dear 丶 2023-10-05 18:49 13阅读 0赞

## 依赖机制 ##

[官方文档][Link 1]  
依赖在pom.xml体现为 `<dependency>` 配置，格式如下：

`<groupId>` 、 `<artifactId>` 和 `<version>` 用于唯一定位一个依赖。  
`<scope>` 用于指定依赖项的作用域。

### 依赖作用域 <scope> ###

依赖作用域用于**限制依赖项的可传递性**，并确定依赖项**何时包含在类路径中**。

*  可传递性是什么意思？  
    举个例子，A模块引用了mysql依赖。如果设定该依赖是可传递的，那么当B模块引用A模块时，则相当于B模块间接的引入了mysql依赖。如果该依赖不是可传递的，那么当B模块需要使用相关的类时则需要单独引入mysql依赖。

#### 作用域的可选项 ####

*  **compile**  
    **默认选项**（如果不指定<scope>）。表示该依赖项是**可传递的**。依赖项在编译、测试、运行时等所有类路径中都可用。
 *  **provided**  
    表示该依赖项是**不可传递的**。依赖项仅在编译和测试的类路径可用，而运行时类路径不可用（**简单说就是打包后不会添加到成品包中**）。比如，我们开发web项目需要使用到servlet api，则需要引入servlet依赖，但是在运行时，web容器会提供相关的类，所以我们并不需要让依赖项添加到成品包中。（如果成品包有该依赖项内容，而web容器又存在相关内容，则会发生冲突，导致不可预期的后果）
 *  **runtime**  
    表示该依赖项是**可传递的**。依赖项仅在运行时可用。（最直观的感受就是在代码中没法直接 import）比如，我们在操作数据库时，使用的是jdbc接口，但在实际运行时，必须要有实现类，我们可以引入mysql依赖，或者oracle依赖等等。这些实现类依赖就可以设定为 runtime。同类的还有日志门面slf4j等等。
 *  **test**  
    表示该依赖项是**不可传递的**。依赖项仅在测试阶段可用。通常用于测试库，比如JUnit。
 *  **system**  
    这个范围与provided类似，只是必须要通过 `<systemPath>` 显示指定依赖项的位置。（不会在存储库中查找）
 *  **import**  
    只有 **<dependencyManagement>** 部分中 **pom类型的依赖项** 才支持此范围。相当于在 **<dependencyManagement>** 预定义依赖项的版本。此类依赖项不会影响原依赖项的可传递性。

### 依赖优先级 ###

上文提到了依赖项的 **可传递性**，那势必会带来一个问题，多个模块引入同个依赖的不同版本，那以谁为准呢？  
比如：A模块引入mysql:5.0，B模块引入了mysql:8.0，那C模块同时依赖了A模块和B模块，那么C模块实际引入的是哪个版本呢？

#### 优先级策略 ####

*  **最近定义原则**  
    如下示例，`A -> E -> D 1.0` 比 `A -> B -> C -> D 2.0` 更短，所以最终 `D 1.0` 生效。

A
      ├── B
      │   └── C
      │       └── D 2.0
      └── E
          └── D 1.0

*  **优先定义原则**  
    如下示例，`A -> B -> C 1.0` 和 `A -> D -> C 1.0` 路径相同，但是ABC优先定义，所以最终 `C 2.0` 生效。

A
      ├── B
      │   └── C 2.0
      └── D
          └── C 1.0

[Link 1]: http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html