Maven中optional和scope元素

optional元素

optional：可选的，用来控制依赖是否向下传递；默认为false，表示依赖向下传递，如果设置为true，表示不向下传递；

例如热部署依赖：

<!--devtools 热部署-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <optional>true</optional>
</dependency>

在Maven项目中，恰当的使用optional配置，可以在很大程度上减少jar包的大小，提升编译和发布速度。

scope元素

scope元素是用来控制依赖的使用范围和传递性，常见的可选值有：compile, test，runtime，provided, system等。

一、scope元素的使用范围

1、compile（编译）

默认值。compile表示对应依赖会参与当前项目的编译、测试、运行等，是一个比较强的依赖。打包时通常会包含该依赖，部署时会打包到lib目录下。比如：spring-core这些核心的jar包。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2、test（测试）

表示该依赖仅参与测试环节，在编译、运行、打包时不会使用。最常见的使用就是单元测试类了：

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>

类似单元测试这样的依赖，如果不设置scope为test，它们会被打包、发布，但其实真是环境中并无什么作用。

3、runntime（运行时）

runntime仅仅适用于运行和测试环节，在编译环境下不会被使用。比如编译时只需要JDBC API的 jar，而只有运行时才需要JDBC驱动实现。

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.20</version>
    <scope>runtime</scope>
</dependency>

4、provided（已提供）

provided适合在编译和测试的环境，和compile功能相似，但provide仅在编译和测试阶段生效，provide不会被打包，也不具有传递性。比如：上面讲到的spring-boot-devtools、servlet-api等，前者是因为不需要在生产中热部署，后者是因为容器已经提供，不需要重复引入。

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

5、system

system范围依赖与provided类似，不过依赖项不会从maven仓库获取，而需要从本地文件系统提供。使用时，一定要配合systemPath属性。不推荐使用，尽量从Maven库中引用依赖。

<dependency>
  <groupId>sun.jdk</groupId>
  <artifactId>tools</artifactId>
  <version>1.5.0</version>
  <scope>system</scope>
  <systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency>

二、scope元素传递性

B依赖A，C依赖B，传递性的关键是B依赖A时所设置的scope值，当B采用不同的值时对应的依赖关系如下：当B通过test或provided依赖A时，C不依赖A；当B通过runtime或compile依赖A时，C依赖A；

三、总结【2022-09-04 新增】

scope	编译	测试	运行	是否向下传递
compile	✔	✔	✔	✔
test	✖	✔	✖	✖
runntime	✖	✔	✔	✔
provided / system	✔	✔	✖	✖

参考：https://www.choupangxia.com/2020/12/01/maven-optional-scope