当前位置：首页 > news >正文

Maven 中 scope=provided 和 optional=true 的区别

news 来源：原创 2025/6/18 0:23:07

先说效果，maven依赖声明中加了<scope>provided</scope>，或者加了<optional>true</optional>，从效果上看是一样的，都会中断依赖传递，观察下图：

图中，项目B分别依赖了C和D，只不过一个声明了optional=true，一个声明了scope=provided，然后项目A再声明了B的依赖，此时在项目A环境中，既没有C，也没有D，所以在效果上看，它们是一样的。

那它们有哪些区别呢？

先看一下maven官方文档上对二者的描述：

optional:

If project Y depends on project Z, the owner of project Y can mark project Z as an optional dependency, using the “optional” element. When project X depends on project Y, X will depend only on Y and not on Y’s optional dependency Z. The owner of project X may then explicitly add a dependency on Z, at her option. (It may be helpful to think of optional dependencies as “excluded by default.”)

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. A dependency with this scope is added to the classpath used for compilation and test, but not the runtime classpath. It is not transitive.

大概意思是说，在A项目依赖B项目提供了一些特性，但又不想让这些特性默认提供，而是作为可以选择的附加功能，默认不提供，需要声明后（主动添加B项目的依赖）才生效，这时用optional；而对于provided，文档侧重提到了运行环境概念，强调只在编译时存在，而运行时不存在的依赖，也就是说，provided的主要用途不是为了考虑依赖是否传递，而是要看项目运行时是不是不应该有这个依赖（是不是需要jvm或者运行容器提供）。

经常拿scope=provided来举例的经典场景之一，就是servlet-api这个依赖了，在代码coding阶段需要使用到它的一些api，而在实际运行时，它的作用要由具体的运行容器来实现，因此编译时可以有它，而打成war包放到tomcat环境下运行时，war包里面不应该有这个servlet-api.jar，否则就会报错了。

在实际的spring-boot项目中，由于大部分使用了内置的undertow或者tomcat容器，已经不需要特别声明这个jar的provided属性了。事实上，日常中更经常需要被用到的，应该主要就是这个optinal了，比如你要提供一组基础jar包，供项目组中的其他同事在他们的项目中引入依赖使用时，如果你提供的某些依赖了其他jar包来做的功能并不一定会被使用到，便可以用到这个optinal了。特别是用到诸如@ConditionalOnClass这种检测项目中是否存在某个class的判断条件时，更是用optional的好时机。

而provided的使用场景，除了servlet-api，lombok也很适合：A项目使用lombok做了一些代码生成，完成开发需要deploy到私服仓库之前，记得要将lombok的依赖加上<scope>provided</scope>，因为它的作用周期已经在A项目打包完成时结束了，对于依赖A项目的其他项目，不需要用到lombok这个玩意儿，它们需要的是A项目提供的功能，而不是附带的帮助自己生成代码的额外功能；也不应该用optional，因为没什么好选择的，它并不是A项目提供的可选功能之一。

（END）

相关文章：