Maven的scope属性详解

Maven使用<dependency>标签来管理项目依赖,该标签有一个<scope>标签,该标签用来描述当前依赖的范围;下面将分别讲解<scope>标签的取值。

Maven使用<dependency>标签来管理项目依赖,该标签有一个<scope>子标签,该标签用来描述当前依赖的范围(即classpath的范围);下面将分别讲解<scope>标签的取值。目前<scope>可以使用5个值: 

  • compile 缺省值,适用于所有阶段,会随着项目一起发布/打包。

  • provided 类似 compile,期望JDK、容器或使用者会提供这个依赖。如:servlet.jar 由容器tomcat、jboss提供等。 

  • runtime 只在运行时使用,如:JDBC驱动,适用运行和测试阶段。 

  • test 只在测试时使用,用于编译和运行测试代码。不会随项目发布。如:JUnit 

  • system 类似provided,需要显式提供包含依赖的jar,Maven不会在Repository中查找它。可以通过引用本地磁盘路径的jar包;

Maven的scope各个取值对classpath的影响。如下图:

Maven的scope属性详解

实例:引入itoo-base依赖,scope取值为provided。

<dependencies>
  <dependency>
    <groupId>com.dynamic</groupId>
    <artifactId>itoo-base</artifactId>
    <type>ejb</type>
    <scope>provided</scope>
  </dependency>
</dependencies>

scope的取值详解如下:

compile - 编译范围

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

provided - 已提供范围

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

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>2.5</version>
    <scope>provided</scope>
</dependency>

runtime - 运行时范围

runtime 依赖在运行和测试系统的时候需要,但在编译的时候不需要。比如,你可能在编译的时候只需要JDBC API JAR(JDBC只提供了接口规范),而只有在运行的时候才需要JDBC驱动实现,如:MySQL、Oracle驱动。

test - 测试范围 

test 范围依赖,在一般的编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用。例如:junit.jar 文件一般只需要在单元测试中才能使用。

system - 系统范围

system 范围依赖与 provided 类似,但是你必须显式的提供一个本地系统中 jar 文件的磁盘路径。这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。这样的构件应该是一直可用的,Maven 也不会在仓库中去寻找它。如果你将一个依赖范围设置成系统范围,你必须同时提供一个 systemPath 元素。

<dependency>
    <groupId>ojdbc6</groupId>
    <artifactId>ojdbc6</artifactId>
    <version>6</version>
    <scope>system</scope>
    <systemPath>C:\libs\odbc.jar</systemPath>
</dependency>

注意该范围是不推荐使用的(你应该一直尽量去从公共或定制的 Maven 仓库中引用依赖)。

参考资料:

https://www.cnblogs.com/hzzll/p/6738955.html

沉浸于现实的忙碌之中,没有时间和精力思念过去,成功也就不会太远了。——雷音
0 不喜欢
说说我的看法 -
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号