1. 程式人生 > >maven dependency中scope=compile 和 provided區別

maven dependency中scope=compile 和 provided區別

問題再現:

上次這邊朋友問我一個問題,就是他們在pom.xml中的dependency中,看到有一些是provided的情況,比如如下:

<!--lombok-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</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包。這也避免了此類構件當部署到目標容器後產生包依賴衝突