Detailed explanation of scope in Maven dependency

scope介绍

scope元素的主要作用就是控制 dependency 元素的使用范围。

因为项目存在编译、运行、测试、等不同的生命周期，在这些生命周期中，使用scope标签可以用来指令maven依赖生效的的范围。

通俗的讲，就是控制 jar 包在哪些范围被加载和使用。

scope元素主要有以下6种。

compile

compile 是默认值，如果没有指定 scope 值，该元素的默认值为 compile。也就是说一个dependency标签下没有显示指定该元素的话，该依赖的scope就是compile。

compile表示被依赖包需要参与当前项目的编译，包括后续的测试，运行周期也参与其中，是一个比较强的依赖；打包的时候通常需要包含进去。

runtime

runtime表示该依赖不会参与到项目的编译，但是会参与测试，运行周期。与compile相比，就是跳过了编译而已。打包的时候通常需要包含进去。

举个栗子，使用JDBC定义了数据库连接的协议，那么使用jdbc的API时，对应的API jar是compile的，至于使用oracle jdbc驱动包，还是mysql jdbc驱动包是运行期间的事，可以将后者的scope设置为runtime。

另外runtime的依赖通常和optional搭配使用，optional为true，我可以用A实现，也可以用B实现。optional为true的依赖不会打包，需要使用的包含该依赖的项目显式引入。如果一个依赖的<optional> 设置为true，则该依赖在打包的时候不会被打进jar包，同时不会通过依赖传递传递到依赖该项目的工程；例如：x依赖B，B由依赖于A（x->B->A），则A中设置<optional> 为true的依赖不会被传递到x中。

test

scope为test表示依赖项目仅仅参与测试相关的工作，包括测试代码的编译，执行。不会被打包到项目jar包中，同时如果项目A依赖于项目B，项目B中的test作用域下的依赖不会被继承。

比较典型的如junit。

provided

provided意味着打包的时候可以不用包进去，需要别的设施去提供，例如项目的使用方提供SDK包下引用的日志依赖、web 容器提供servlet相关依赖。

事实上该依赖理论上可以参与编译，测试，运行等周期。相当于compile，但是在打包阶段做了exclude的动作。

system

system 元素与 provided 元素类似，但是被依赖项不会从 maven 仓库中查找，而是从本地系统中获取，systemPath 元素用于制定本地系统中 jar 文件的路径。例如：

1
2
3
4
5
6
7

<dependency>
    <groupId>org.test</groupId>
    <artifactId>test</artifactId>
    <version>1.0</version>
    <scope>system</scope>
    <systemPath>${basedir}/org/test.jar</systemPath>
</dependency>

这个一定要配合systemPath标签使用，指定自定义jar包的路径。

import

import比较特殊，它只使用在dependencyManagement标签中，表示从其它的pom中导入dependency的配置，打包类型package为pom，例如 (B项目导入A项目中的包配置)。

举个栗子，项目中不想使用spring-boot-starter-parent做为项目的父模块，想使用自定义的pom作为父模块，毕竟maven也是单继承，那么我们可以通过在import的方式将spring-boot-dependencies的pom依赖配置导入到项目中，然后使用springboot相关的starter项：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>1.3.3.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
 
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

如果我们自己定义的相关的maven依赖在类似上面的pom依赖中，然后在dependencyManagement标签中导入为scope元素import，就可以使pom文件变的非常简洁，具体的maven配置项放在具体pom里，就像java中使用组合而非继承的方式。

依赖传递

A–>B–>C。当前项目为A，A依赖于B，B依赖于C。知道B在A项目中的scope，那么怎么知道C在A中的scope呢？

答案是：

当C是test或者provided时，C直接被丢弃，A不依赖C；

否则A依赖C，C的scope继承于B的scope。

具体关系可以参照表格