Maven的pom配置文件的scope属性

scope属性主要用于控制依赖范围,主要分为编译、打包、运行、测试、依赖传递等各个常见,scope不同于optional提供了更多可选择的配置参数用于应对不同的依赖场景。

所属分类 JAVA

相关标签 Maven依赖管理

scope属性样例

scope属性一般配置在依赖节点内。

该属性的主要作用是用于控制当前依赖的依赖范围。

简单来说就是控制依赖在应用的编译到发布过程中生效的范围。

比如下方样式就是大名鼎鼎的lombok插件,配置为provided(已提供范围)。

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok  do not compile-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.14</version>
    <!-- compile:默认范围,用于编译 -->
    <!-- provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath -->
    <!-- runtime:在执行时需要使用 --> 
    <!-- test:用于test任务时使用 -->
    <!-- system:需要外在提供相应的元素。通过systemPath来取得 -->
    <!-- systemPath:仅用于范围为system。提供相应的路径 -->
    <scope>provided</scope>
</dependency>

属性定义和解释

compile是默认的范围。

一般来说如果dependency节点内没有配置scope,就表示是compile。

编译范围依赖在所有的classpath中可用,打包时该依赖会被打包。

该依赖会被传递。

provided依赖表示该依赖在实际JDK或容器中已存在。

已提供范围的依赖在编译classpath可用。

打包时该依赖不会被打包。

常见的例子:

Web应用在编译时需要依赖的ServletAPI来编译servlet,但实际打包时并不需要这个ServletAPI。

因为ServletAPI的jar包往往由应用服务器或者servlet容器(如Tomcat)提供。

因此可以将ServletAPI依赖配置为provided。

同理本文上方例子里的lombok插件也只是编译的时候需要。

该依赖不会被传递。

runtime依赖在运行和测试系统的时候需要,但在编译的时候不需要。

runtime与provided刚好相反,打包时该依赖会被打包。

常见的例子:

编译的时候只需要JDBC的API。

而在运行的时候才需要JDBC驱动。

该依赖会被传递。

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

该依赖不会被传递。

system范围依赖与provided类似,但是你必须显式的提供一个对于本地系统中JAR文件的路径。

这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。

这样的构件应该是一直可用的,Maven也不会在仓库中去寻找它。

如果你将一个依赖范围设置成系统范围,你必须同时提供一个systemPath元素。

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

system一般用在某些特殊的jar包依赖(比如私有jar或者某些过期版本的jar)

该依赖不会被传递。

<dependency>
    <groupId>quartz</groupId>
    <artifactId>quartz</artifactId>
    <version>1.8.6</version>
    <!-- system:需要外在提供相应的元素。通过systemPath来取得 -->
    <scope>system</scope>
    <!-- systemPath:仅用于范围为system。提供相应的路径 -->
    <systemPath>${project.basedir}/src/main/webapp/WEB-INF/lib/quartz-1.8.6.jar</systemPath>
</dependency>

拓展阅读:optional

除了scope管理依赖范围之外,还有一个optional也用于控制依赖范围。

optional(可选的依赖)

理解为此功能/此依赖可选,如果不需要某项功能,可以不引用这个包。

optional主要作用于其他依赖当前项目的工程,阻断依赖的传递。

简单来说:

A配置了某个依赖(例如是下方的devtools),设置optional为true。

B为A的子项目或依赖A,这时候如需要devtools,B可以配置devtools的依赖。

如果B不需要devtools,pom文件无需任何配置(B项目中不会自定引入devtools)。

反之,如果A项目optiona设为false或没有设置(optiona默认为false)。

B项目无论是否配置devtools该依赖都会被引入。

<!--devtools 热部署-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-devtools</artifactId>
  <optional>true</optional>
</dependency>

米虫

做一个有理想的米虫,伪全栈程序猿,乐观主义者,坚信一切都是最好的安排!

本站由个人原创、收集或整理,如涉及侵权请联系删除

本站内容支持转发,希望贵方携带转载信息和原文链接

本站具有时效性,不提供有效、可用和准确等相关保证

本站不提供免费技术支持,暂不推荐您使用案例商业化

发表观点

提示

昵称

邮箱

QQ

网址

当前还没有观点发布,欢迎您留下足迹!

同类其他

JAVA

listener、filter、servlet的加载次序

在web.xml中经常会看到listener,filter,servlet的相关标签配置,它们分别是监听器、过滤器、容器,都是在项目启动的时候就可以进行初始化的加载动作

JAVA中创建线程的三种方式的使用与区别

JAVA中通过继承Thread类、实现Runnable接口以及实现Callable接口配合Future接口实现创建多线程,三种方式各有优缺点,而第三种则具备更多的增强能力

SpringBoot配置文件生效优先级

SpringBoot 可以通过 spring.profiles.active 属性指定生效不同配置文件来满足多环境要求,多环境更为复杂的场景,就需要理解配置文件生效优先级,考虑直接引入外部配置项和配置文件

自定义filter过滤器拦截未登录(非法)请求

在JAVA的WEB工程中我们可以将JSP页面文件放在WEB-INFO中限制用户进行URL直接访问,但静态资源如js、css文件却是需要被外部直接访问的,直接对外暴露又不太安全,可以通过自定义过滤器处理

JAVA语言中的反射机制的作用原理及使用

JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意一个方法和属性;动态获取的信息以及动态调用对象的方法的功能。

JAVA单例模式中的饿汉模式与懒汉模式

在绝大多数的JAVA经典应用框架中广泛使用到了单例设计模式,单例设计模式最普遍的分类方式分类分为懒汉模式与饿汉模式两种,其主要区别在于初始化创建对象的时机不同。

选择个人头像

昵称

邮箱

QQ

网址

评论提示

  • 头像:系统为您提供了12个头像自由选择,初次打开随机为你选择一个
  • 邮箱:可选提交邮箱,该信息不会外泄,或将上线管理员回复邮件通知
  • 网址:可选提交网址,评论区该地址将以外链的形式展示在您的昵称上
  • 记忆:浏览器将记忆您已选择或填写过得信息,下次评论无需重复输入
  • 审核:提供一个和谐友善的评论环境,本站所有评论需要经过人工审核