maven dependency中scope=compile 和 provided区别

最新推荐文章于 2024-06-10 21:48:06 发布

转载最新推荐文章于 2024-06-10 21:48:06 发布 · 置顶 · 4.7w 阅读

Maven 专栏收录该内容

9 篇文章

订阅专栏

本文详细解析了Maven项目中pom.xml文件内的dependency标签中scope属性的作用，特别是provided与compile的区别。通过实例展示了不同scope设置如何影响项目的编译、测试及运行过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

转自：http://supercharles888.blog.51cto.com/609344/981316

问题再现：

上次这边朋友问我一个问题，就是他们在pom.xml中的dependency中，看到有一些是<scope>provided</scope>的情况，比如如下：

<dependency> 
   <groupId>com.liferay.portal</groupId> 
   <artifactId>portal-impl</artifactId> 
   <version>6.1.0</version> 
   <scope>provided</scope> 
</dependency>

他们问我scope在何种情况下要设置为provided,以及和scope设置为compile的区别。

解释：

其实这个问题很简单。

对于scope=compile的情况（默认scope),也就是说这个项目在编译，测试，运行阶段都需要这个artifact对应的jar包在classpath中。

而对于scope=provided的情况，则可以认为这个provided是目标容器已经provide这个artifact。换句话说，它只影响到编译，测试阶段。在编译测试阶段，我们需要这个artifact对应的jar包在classpath中，而在运行阶段，假定目标的容器（比如我们这里的liferay容器）已经提供了这个jar包，所以无需我们这个artifact对应的jar包了。

听起来很玄乎，对吧，其实一点也不难理解。举个scope=provided的例子。

比如说，假定我们自己的项目ProjectABC 中有一个类叫C1,而这个C1中会import这个portal-impl的artifact中的类B1，那么在编译阶段，我们肯定需要这个B1，否则C1通不过编译，因为我们的scope设置为provided了，所以编译阶段起作用，所以C1正确的通过了编译。测试阶段类似，故忽略。

那么最后我们要吧ProjectABC部署到Liferay服务器上了，这时候，我们到$liferay-tomcat-home\webapps\ROOT\WEB-INF\lib下发现，里面已经有了一个portal-impl.jar了，换句话说，容器已经提供了这个artifact对应的jar,所以，我们在运行阶段，这个C1类直接可以用容器提供的portal-impl.jar中的B1类，而不会出任何问题。

实际插件的行为：

刚才我们讲述的是理论部分，现在我们看下，实际插件在运行时候，是如何来区别对待scope=compile和scope=provided的情况的。

做一个实验就可以很容易发现，当我们用maven install生成最终的构件包ProjectABC.war后，在其下的WEB-INF/lib中，会包含我们被标注为scope=compile的构件的jar包，而不会包含我们被标注为scope=provided的构件的jar包。这也避免了此类构件当部署到目标容器后产生包依赖冲突。