Maven pom.xml scope屬性

在 Maven 中，scope 屬性用于定義依賴關(guān)系在不同生命周期階段的行為。

scope 會影響依賴關(guān)系在構(gòu)建過程中的哪些階段會被下載和使用，以及是否會傳遞到依賴于當(dāng)前項目的其他項目中。

理解 scope 的設(shè)置對于優(yōu)化構(gòu)建過程和管理依賴關(guān)系非常重要。

scope 的常見值及含義

Maven 支持以下幾種常見的 scope 值：

compile（默認(rèn)）

• 對應(yīng)于整個構(gòu)建生命周期，表示這個依賴對編譯、測試和運(yùn)行都是可用的。
• 會被包含在最終的打包中。
• 會傳遞給依賴當(dāng)前項目的其他項目。

provided

• 類似于 compile，但是它假定在運(yùn)行時會由容器或類路徑中的其他方式提供。
• 一般用于那些由容器提供的類庫，如 Servlet 容器提供的 JAR 文件。
• 不會被包含在最終的打包中。
• 不會傳遞給依賴當(dāng)前項目的其他項目。

runtime

• 表示這個依賴在運(yùn)行和測試階段是需要的，但在編譯階段不需要。
• 會被包含在最終的打包中。
• 會傳遞給依賴當(dāng)前項目的其他項目。

test

• 表示這個依賴僅在測試編譯和測試運(yùn)行階段是需要的。
• 不會被包含在最終的打包中。
• 不會傳遞給依賴當(dāng)前項目的其他項目。

system

• 類似于 provided，但是需要顯式地提供一個本地路徑到 JAR 文件。
• 已經(jīng)很少使用，通常不推薦使用。

示例解釋

<dependency>
    <groupId>org.apache.flink</groupId>
    <artifactId>flink-clients</artifactId>
    <version>${flink.version}</version>
    <scope>provided</scope>
</dependency>

在這個示例中：

• groupId 是 org.apache.flink，表示依賴的組織或庫。
• artifactId 是 flink-clients，表示具體依賴的庫或模塊。
• version 是 ${flink.version}，表示依賴的版本，這里使用了一個屬性 ${flink.version}，該屬性需要在 POM 文件的其他地方定義。
• scope 是 provided，表示這個依賴假定在運(yùn)行時會被容器或其他方式提供。

使用場景

• 當(dāng)你開發(fā)的應(yīng)用程序運(yùn)行在一個容器環(huán)境中（如 Tomcat、Jetty 等），而該容器已經(jīng)提供了某些類庫（如 JSP API、Servlet API 等），這時就可以將這些類庫的依賴設(shè)置為 provided。
• 如果你開發(fā)的應(yīng)用程序運(yùn)行在一個已經(jīng)包含了 Flink 客戶端的環(huán)境中，比如 Flink 集群本身，那么可以將 flink-clients 設(shè)置為 provided。

注意事項

• 使用 provided 時，需要確保運(yùn)行時的確有相應(yīng)的類庫可用，否則應(yīng)用程序會因為找不到必要的類而拋出 ClassNotFoundException。
• 如果你不確定運(yùn)行時環(huán)境是否會提供這些類庫，或者這些類庫在不同的環(huán)境中可能不一致，那么最好不要使用 provided，而使用 compile 或 runtime。
• provided 適用于那些由運(yùn)行時環(huán)境提供的類庫，可以減少最終打包的大小，同時也減少了傳遞依賴的風(fēng)險。

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。