理解 Maven 依赖范围及编译与运行时的需求

CodeDunkster

于 2024-08-31 12:05:30 发布

阅读量1.2k

点赞数 29

文章标签： maven java

本文链接：https://blog.csdn.net/weixin_54574094/article/details/141750653

版权

在使用 Maven 构建 Java 项目时，我们经常需要添加各种依赖（JAR 包）到项目中。然而，依赖的作用范围（Scope）决定了这些 JAR 包在不同阶段的作用和存在方式。本文将详细介绍 Maven 依赖范围的定义、编译和运行时的需求，以及如何正确理解这些概念。

Maven 依赖范围（Scope）

在 Maven 的 pom.xml 文件中，依赖的 scope 元素用来定义该依赖的作用范围。常见的作用范围包括：

compile：默认范围。编译、测试、运行和打包时都需要这个依赖。适用于所有阶段。
provided：编译和测试时需要，但在运行时由外部环境提供。适用于如 Servlet API 这样的库，通常由容器（如 Tomcat）提供。
runtime：编译时不需要，但在运行时需要。适用于 JDBC 驱动程序等库。
test：只在测试阶段需要，不会包含在最终的构建包中。适用于 JUnit 等测试框架。
system：与 provided 类似，但需要在本地文件系统中指定路径，通常不推荐使用。

编译时与运行时的 JAR 包需求

1. 编译时的依赖

编译时，Java 编译器需要知道你代码中所使用的类和接口的定义。如果你在代码中引用了某些类，编译器需要能够找到这些类的定义文件。例如：

HttpServletRequest 和 HttpServletResponse：这些类属于 Servlet API。为了编译使用这些类的代码，编译器需要知道这些类的定义。为了达到这个目的，你必须在 pom.xml 文件中将 Servlet API 的依赖 scope 设置为 provided，因为 Servlet API 是由应用服务器（如 Tomcat）提供的。
```
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope>
</dependency>
```
编译期依赖的例子：假设你在项目中使用了 HttpServletRequest，编译时需要 javax.servlet-api JAR 包，因为编译器需要知道 HttpServletRequest 类的定义。

2. 运行时的依赖

在代码编译完成后，应用程序在运行时需要不同的依赖来完成实际的操作。运行时依赖是指那些编译时不需要，但在应用程序运行时必须存在的 JAR 包。例如：

JDBC 驱动程序：编写数据库操作代码时，使用 JDBC 接口来访问数据库，而不是具体的 JDBC 实现（如 MySQL JDBC 驱动）。因此，编译时不需要 MySQL 驱动程序，但在运行时需要它来实际连接 MySQL 数据库。你需要在 pom.xml 文件中将 JDBC 驱动程序的 scope 设置为 runtime。
```
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
    <scope>runtime</scope>
</dependency>
```
运行期依赖的例子：在运行时，JVM 需要 MySQL JDBC 驱动来连接数据库。虽然在编译时只需要 JDBC 接口，但运行时需要实际的 JDBC 驱动程序。

编译和运行时的具体示例

示例 1: Servlet API

在编写和编译 Java Servlet 时，必须使用 Servlet API 的类，如 HttpServletRequest 和 HttpServletResponse。这些类的定义由 Servlet API 提供，这意味着在编译阶段，你需要将 Servlet API 的 JAR 包包含在项目中，但实际的 Servlet 容器（如 Tomcat）会在运行时提供这些 API 的实现。

示例 2: JDBC 驱动

假设你的项目使用 JDBC 连接 MySQL 数据库。编写代码时，你使用的是 JDBC 接口（如 Connection 和 DriverManager），这些接口由 Java 标准库提供。编译时，编译器不需要 MySQL 驱动程序。只有在实际运行时，JVM 需要 MySQL JDBC 驱动程序来建立数据库连接。

不太明白的同学可以到这里看看----->代码实例