【Maven】属性scope依赖作用范围详解-蒲公英云

【Maven】属性scope依赖作用范围详解

文章目录

- 前言
- scope取值和作用表
- 详解
- - compile
  - provided
  - system
  - runtime
  - test
  - import

前言

Maven中使用 scope 来指定当前包的依赖范围和依赖的传递性。常见的可选值有：compile,provided,runtime,test, syste,import 等。scope 主要是用在 pom.xml 文件中的依赖定义部分，例如：

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

scope取值和作用表

scope取值	有效范围	依赖传递	是否打入jar包	例子
compile	all	是	是	spring-core
provided	compile,test	否	否	servlet-api
system	compile,test	是
runtime	runtime,test	是	是	JDBC驱动
test	test	否	否	JUnit
import		是

详解

compile

为默认的依赖有效范围。定义依赖关系没有指定依赖有效范围，默认采用该依赖有效范围；

此种依赖，在编译、运行、测试时均有效，会以依赖传递，打入jar包；

provided

在编译、测试时有效，但是在运行时无效。provided意味着打包的时候不会打入jar包，别的设施(Web Container)会提供。

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

例如：servlet-api，运行项目时，容器已经提供，就不需要打入jar包了。

说到provided，这里就要说到 dependency 下的子标签 optional ，如果一个依赖的 optional 设置为true，则该依赖在打包的时候不会被打进jar包，同时不会通过依赖传递传递到依赖该项目的工程；例如：x

依赖B，B由依赖于A（x->B->A），则A中设置 optional 为true的依赖不会被传递到x中。

两者区别：

1、为true 表示某个依赖可选，该依赖是否使用都不会影响服务运行；

2、provided的在目标容器中已经提供了这个依赖，无需在提供

system

system依赖不是由maven仓库管理，而是本地的jar包，因此必须配合systemPath标签来指定本地的jar包所在全路径。这类jar包默认会参与编译、测试，但是不会被参与打包阶段。如果也想打包进去的话，需要在插件里做配置true；

//引用本地jar包
<dependency>
    <groupId>com.mytest</groupId>
    <artifactId>test</artifactId>
    <version>1.0</version>
    <scope>system</scope>
    <systemPath>${pom.basedir}/lib/test-1.0.jar</systemPath>
</dependency>

由于此类依赖不是通过Maven仓库解析的，而且往往与本机系统绑定，可能造成构建的不可移植，因此应该谨慎使用。

runtime

在运行、测试时有效，但是在编译代码时无效，打入jar包；
例如：JDBC驱动实现，项目代码编译只需要JDK提供的JDBC接口，只有在测试或运行项目时才需要实现上述接口的具体JDBC驱动。

test

只在测试时有效，包括测试代码的编译，执行，不会打入jar包；例如：JUnit。

import

import 只能在pom文件的<dependencyManagement>中使用，从而引入其他的pom文件中引入依赖;
如：在Spring boot 项目的POM文件中，我们可以通过在POM文件中继承 Spring-boot-starter-parent来引
用Srping boot默认依赖的jar包，如下：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.BUILD-SNAPSHOT</version>
</parent>

但是，通过上面的parent继承的方法，只能继承一个 spring-boot-start-parent。实际开发中，用户很可能需要继承自己公司的标准parent配置，这个时候可以使用 scope=import 来实现多继承。代码如下：

<dependencyManagement>
         <dependencies>
             <dependency>
                 <!-- Import dependency management from Spring Boot -->
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-dependencies</artifactId>
                 <version>2.0.1.BUILD-SNAPSHOT</version>
                 <type>pom</type>
                 <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

通过上面方式，就可以获取spring-boot-dependencies.2.0.1.BUILD-SNAPSHOT.pom文件中dependencyManagement配置的jar包依赖。如果要继承多个，可以在dependencyManagement中添加，如：

<dependencyManagement>
         <dependencies>
             <!-- Override Spring Data release train provided by Spring Boot -->
             <dependency>
                 <groupId>org.springframework.data</groupId>
                 <artifactId>spring-data-releasetrain</artifactId>
                 <version>Fowler-SR2</version>
                 <type>pom</type>
                 <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.0.1.BUILD-SNAPSHOT</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>