Maven：浅析依赖（dependency）关系中 scope 的含义

朱雀 2022-06-09 04:52 320阅读 0赞

在 Pom4 中，dependency 元素中引入了 scope 元素，这是一个很重要的属性。在Maven 项目中 Jar 包冲突、类型转换异常的很大原因是由于 scope 元素使用不当造成的。  
scope 元素的作用：控制 dependency 元素的使用范围。通俗的讲，就是控制 Jar 包在哪些范围被加载和使用。  
scope 包含五个值，具体含义如下：

### compile（编译） ###

含义：compile 是默认值，如果没有指定 scope 值，该元素的默认值为 compile。被依赖项目需要参与到当前项目的编译，测试，打包，运行等阶段。打包的时候通常会包含被依赖项目。

### provided（已提供的） ###

含义：被依赖项目理论上可以参与编译、测试、运行等阶段，相当于compile，但是再打包阶段做了exclude的动作。  
适用场景：例如， 如果我们在开发一个web 应用，在编译时我们需要依赖 servlet-api.jar，但是在运行时我们不需要该 jar 包，因为这个 jar 包已由应用服务器提供，此时我们需要使用 provided 进行范围修饰。

### runtime（运行时） ###

含义：表示被依赖项目无需参与项目的编译，但是会参与到项目的测试和运行。与compile相比，被依赖项目无需参与项目的编译。  
适用场景：例如，在编译的时候我们不需要 JDBC API 的 jar 包，而在运行的时候我们才需要 JDBC 驱动包。

### test（测试） ###

含义： 表示被依赖项目仅仅参与测试相关的工作，包括测试代码的编译，执行。  
适用场景：例如，Junit 测试。

### system（系统） ###

含义：system 元素与 provided 元素类似，但是被依赖项不会从 maven 仓库中查找，而是从本地系统中获取，systemPath 元素用于制定本地系统中 jar 文件的路径。也就是说，在编译时使用 systemPath 元素指定的 jar 包，在运行时由应用服务器提供 jar 包。  
适用场景：项目中存在自定义的基础组件服务时使用。例如：

<dependency>
        <groupId>org.open</groupId>
        <artifactId>open-core</artifactId>
        <version>1.5</version>
        <scope>system</scope>
        <systemPath>${basedir}/WebContent/WEB-INF/lib/open-core.jar</systemPath>
    </dependency>