maven scope 的作用

本是古典何须时尚 2022-09-04 07:46 19阅读 0赞

scope范围决定了其依赖传递和作用时期

all （compile ） =compile,runtime ,test  
provide,system,runtime只占其中两种，其中一种是test,另一种根据名称可知  
test就一种  
    例如：provided  
依赖其的父项目不会引用的，运行调用对应方法会报错----不依赖传递  
但是可以编译通过--编代码、编译的时候有----仅编译时有效

### 一： ###

### 1.Maven中的依赖作用范围概述 ###

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

1.  `<dependency>`
2.  `<groupId>org.springframework</groupId>`
3.  `<artifactId>spring-test</artifactId>`
4.  `<version>3.2.1.RELEASE</version>`
5.  `<scope>test</scope>`
6.  `</dependency>`

### 2.scope各种取值详解 ###

<table> 
 <thead> 
  <tr> 
   <th>scope取值</th> 
   <th>有效范围（compile, runtime, test）</th> 
   <th>依赖传递</th> 
   <th>例子</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>compile</strong></td> 
   <td>all</td> 
   <td>是</td> 
   <td>spring-core</td> 
  </tr> 
  <tr> 
   <td><strong>provided</strong></td> 
   <td>compile, test</td> 
   <td>否</td> 
   <td>servlet-api</td> 
  </tr> 
  <tr> 
   <td><strong>runtime</strong></td> 
   <td>runtime, test</td> 
   <td>是</td> 
   <td>JDBC驱动</td> 
  </tr> 
  <tr> 
   <td><strong>test</strong></td> 
   <td>test</td> 
   <td>否</td> 
   <td>JUnit</td> 
  </tr> 
  <tr> 
   <td><strong>system</strong></td> 
   <td>compile, test</td> 
   <td>是</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

正如上表所示，

**compile** ：为默认的依赖有效范围。如果在定义依赖关系的时候，没有明确指定依赖有效范围的话，则默认采用该依赖有效范围。此种依赖，在编译、运行、测试时均有效。

**provided** ：在编译、测试时有效，但是在运行时无效。例如：servlet-api，运行项目时，容器已经提供，就不需要Maven重复地引入一遍了。

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

**test** ：只在测试时有效，例如：JUnit。

**system** ：在编译、测试时有效，但是在运行时无效。和provided的区别是，使用system范围的依赖时必须通过systemPath元素显式地指定依赖文件的路径。由于此类依赖不是通过Maven仓库解析的，而且往往与本机系统绑定，可能造成构建的不可移植，因此应该谨慎使用。systemPath元素可以引用环境变量。例如：

1.  `<dependency>`
2.  `<groupId>javax.sql</groupId>`
3.  `<artifactId>jdbc-stdext</artifactId>`
4.  `<version>2.0</version>`
5.  `<scope>system</scope>`
6.  `<systemPath>${java.home}/lib/rt.jar</systemPath>`
7.  `</dependency>`

转自：[https://www.jianshu.com/p/91655539e0ce][https_www.jianshu.com_p_91655539e0ce]

二：

scope的分类  
compile  
默认就是compile，什么都不配置也就是意味着compile。compile表示被依赖项目需要参与当前项目的编译，当然后续的测试，运行周期也参与其中，是一个比较强的依赖。打包的时候通常需要包含进去。

test  
scope为test表示依赖项目仅仅参与测试相关的工作，包括测试代码的编译，执行。比较典型的如junit。

runntime  
runntime表示被依赖项目无需参与项目的编译，不过后期的测试和运行周期需要其参与。与compile相比，跳过编译而已，说实话在终端的项目（非开源，企业内部系统）中，和compile区别不是很大。比较常见的如JSR×××的实现，对应的API jar是compile的，具体实现是runtime的，compile只需要知道接口就足够了。oracle jdbc驱动架包就是一个很好的例子，一般scope为runntime。另外runntime的依赖通常和optional搭配使用，optional为true。我可以用A实现，也可以用B实现。

provided  
provided意味着打包的时候可以不用包进去，别的设施(Web Container)会提供。事实上该依赖理论上可以参与编译，测试，运行等周期。相当于compile，但是在打包阶段做了exclude的动作。

system  
从参与度来说，也provided相同，不过被依赖项不会从maven仓库抓，而是从本地文件系统拿，一定需要配合systemPath属性使用。

scope的依赖传递  
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。

转自：[https://blog.csdn.net/kimylrong/article/details/50353161][https_blog.csdn.net_kimylrong_article_details_50353161]

三：

scope的值  
官方解释

compile   
This is the default scope, used if none is specified. Compile dependencies are available in all classpaths of a project. Furthermore, those dependencies are propagated to dependent projects.   
provided   
This is much like compile, but indicates you expect the JDK or a container to provide the dependency at runtime. For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the Servlet API and related Java EE APIs to scope provided because the web container provides those classes. This scope is only available on the compilation and test classpath, and is not transitive.   
runtime   
This scope indicates that the dependency is not required for compilation, but is for execution. It is in the runtime and test classpaths, but not the compile classpath.   
test   
This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases. This scope is not transitive.   
system   
This scope is similar to provided except that you have to provide the JAR which contains it explicitly. The artifact is always available and is not looked up in a repository.   
import (only available in Maven 2.0.9 or later)   
This scope is only supported on a dependency of type pom in the section. It indicates the dependency to be replaced with the effective list of dependencies in the specified POM’s section. Since they are replaced, dependencies with a scope of import do not actually participate in limiting the transitivity of a dependency.

中文解释   
1. compile 默认的范围，编译测试运行都有效。   
2. provided 编译和测试时有效，最后是在运行的时候不会被加入。官方举了一个例子。比如在JavaEE web项目中我们需要使用servlet的API，但是呢Tomcat中已经提供这个jar，我们在编译和测试的时候需要使用这个api，但是部署到tomcat的时候，如果还加入servlet构建就会产生冲突，这个时候就可以使用provided。   
3. runtime 在测试和运行时有效。   
4. test 在测试时有效。   
5. system 与本机系统相关联，可移植性差。编译和测试时有效。   
6. import 导入的范围，它只在使用dependencyManagement中，表示从其他pom中导入dependecy的配置。

[https_www.jianshu.com_p_91655539e0ce]: https://www.jianshu.com/p/91655539e0ce
[https_blog.csdn.net_kimylrong_article_details_50353161]: https://blog.csdn.net/kimylrong/article/details/50353161