Maven：依赖scope标签简介

川长思鸟来 2024-03-22 10:13 15阅读 0赞

## scope标签 ##

*  标签的位置：dependencies/dependency/scope
 *  标签的可选值：compile/test/provided/system/runtime/import

### 依赖范围 ###

#### compile 和 test 和 provided 对比 ####

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th>main目录（空间）</th> 
   <th>test目录（空间）</th> 
   <th>开发过程（时间）</th> 
   <th>部署到服务器（时间）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>compile</td> 
   <td>有效</td> 
   <td>有效</td> 
   <td>有效</td> 
   <td>有效</td> 
  </tr> 
  <tr> 
   <td>test</td> 
   <td>无效</td> 
   <td>有效</td> 
   <td>有效</td> 
   <td>无效</td> 
  </tr> 
  <tr> 
   <td>provided</td> 
   <td>有效</td> 
   <td>有效</td> 
   <td>有效</td> 
   <td>无效</td> 
  </tr> 
 </tbody> 
</table>

#### 结论 ####

*  compile：通常使用的第三方框架的 jar 包这样在项目实际运行时真正要用到的 jar 包都是以 compile 范围进行依赖的。比如 SSM 框架所需jar包。
 *  test：测试过程中使用的 jar 包，以 test 范围依赖进来。比如 junit。
 *  provided：在开发过程中需要用到的“服务器上的 jar 包”通常以 provided 范围依赖进来。比如 servlet-api、jsp-api。而这个范围的 jar 包之所以不参与部署、不放进 war 包，就是避免和服务器上已有的同类 jar 包产生冲突，同时减轻服务器的负担。说白了就是：“服务器上已经有了，你就别带啦！”

### 依赖传递 ###

在 A 依赖 B，B 依赖 C 的前提下，C 是否能够传递到 A，取决于 B 依赖 C 时使用的依赖范围。

*  B 依赖 C 时使用 compile 范围：可以传递
 *  B 依赖 C 时使用 test 或 provided 范围：不能传递，所以需要这样的 jar 包时，就必须在需要的地方明确配置依赖才可以。

### 其他/system/runtime/import ###

#### import ####

管理依赖最基本的办法是继承父工程，但是和 Java 类一样，Maven 也是单继承的。如果不同体系的依赖信息封装在不同 POM 中了，没办法继承多个父工程怎么办？这时就可以使用 import 依赖范围。

典型案例当然是在项目中引入 SpringBoot、SpringCloud 依赖：

<dependencyManagement>
        <dependencies>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR9</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.2.6.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.6.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

##### import 依赖范围使用要求： #####

*  打包类型必须是 pom
 *  必须放在 dependencyManagement 中

#### system ####

以 Windows 系统环境下开发为例，假设现在 D:\\tempare\\wuxian-maven-test-1.0-SNAPSHOT.jar 想要引入到我们的项目中，此时我们就可以将依赖配置为 system 范围：

<dependency>
        <groupId>com.wuxian.maven</groupId>
        <artifactId>wuxian-maven-test</artifactId>
        <version>1.0-SNAPSHOT</version>
        <systemPath>D:\tempare\wuxian-maven-test-1.0-SNAPSHOT.jar</systemPath>
        <scope>system</scope>
    </dependency>

#### runtime ####

专门用于编译时不需要，但是运行时需要的 jar 包。比如：编译时我们根据接口调用方法，但是实际运行时需要的是接口的实现类。典型案例是：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>