maven dependency中scope=compile 和 provided區別

 

問題再現：

上次這邊朋友問我一個問題，就是他們在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包。這也避免了此類構件當部署到目標容器後產生包依賴衝突。