Maven依赖scope作用域详解

ゝ一纸荒年。 2024-04-19 12:00 67阅读 0赞

在POM中，`<dependency>`引入了`<scope>`，它主要管理依赖的部署。目前`<scope>`可以使用5个值：

*  compile，缺省值，适用于所有阶段，会随着项目一起发布。
 *  provided，类似compile，期望JDK、容器或使用者会提供这个依赖。如servlet.jar。
 *  runtime，只在运行时使用，如JDBC驱动，适用运行和测试阶段。
 *  test，只在测试时使用，用于编译和运行测试代码。不会随项目发布。
 *  system，类似provided，需要显式提供包含依赖的jar，Maven不会在Repository中查找它。

依赖范围控制哪些依赖在哪些classpath 中可用，哪些依赖包含在一个应用中。让我们详细看一下每一种范围：

## compile （编译范围） ##

compile是默认的范围；如果没有提供一个范围，那该依赖的范围就是编译范围。编译范围依赖在所有的classpath 中可用，同时它们也会被打包。

## provided （已提供范围） ##

provided 依赖只有在当JDK 或者一个容器已提供该依赖之后才使用。例如， 如果你开发了一个web 应用，你可能在编译 classpath 中需要可用的Servlet API 来编译一个servlet，但是你不会想要在打包好的WAR 中包含这个Servlet API；这个Servlet API JAR 由你的应用服务器或者servlet 容器提供。已提供范围的依赖在编译classpath （不是运行时）可用。它们不是传递性的，也不会被打包。

# #

## runtime （运行时范围） ##

runtime 依赖在运行和测试系统的时候需要，但在编译的时候不需要。比如，你可能在编译的时候只需要JDBC API JAR，而只有在运行的时候才需要JDBC  
驱动实现。

## test （测试范围） ##

test范围依赖 在一般的编译和运行时都不需要，它们只有在测试编译和测试运行阶段可用。

## system （系统范围） ##

system范围依赖与provided 类似，但是你必须显式的提供一个对于本地系统中JAR 文件的路径。这么做是为了允许基于本地对象编译，而这些对象是系统类库的一部分。这样的构件应该是一直可用的，Maven 也不会在仓库中去寻找它。如果你将一个依赖范围设置成系统范围，你必须同时提供一个 systemPath 元素。注意该范围是不推荐使用的（你应该一直尽量去从公共或定制的 Maven 仓库中引用依赖）。