Maven項目中將本地依賴庫打包到最終的JAR中的實現(xiàn)

更新時間：2025年05月14日 09:22:03 作者：墨鴉_Cormorant

本文主要介紹了Maven項目中將本地依賴庫打包到最終的JAR中的實現(xiàn),將本地依賴安裝到Maven本地倉庫,可以避免使用system作用域帶來的不可移植性和打包問題,感興趣的可以了解一下

前言

在現(xiàn)代后端開發(fā)中，構(gòu)建高效且可擴展的 Web 應用程序通常依賴于多種第三方庫和內(nèi)部依賴。這些依賴可以來自公共倉庫，也可能是公司內(nèi)部自研的庫或尚未發(fā)布到公共倉庫的 JAR 包。本文將詳細介紹如何在 Maven 項目中處理本地依賴庫，并確保這些依賴能夠正確地打包到最終的可執(zhí)行 JAR 文件中。本文不僅以 Doris 連接器（flink-doris-connector）作為示例，還涵蓋了處理其他本地依賴庫的通用方法。

為什么需要打包本地依賴庫？

通常，依賴庫可以通過 Maven 中央倉庫或其他公共倉庫輕松獲取和管理。然而，有時我們需要使用一些未發(fā)布到公共倉庫的本地 JAR 包，例如：

公司內(nèi)部開發(fā)的庫
第三方提供但未上傳到 Maven 倉庫的庫
特殊版本或定制版的庫
直接引用本地依賴庫可能會引發(fā)一些問題，尤其是在構(gòu)建和部署過程中。為了確保項目的可移植性和一致性，必須將這些本地依賴正確地打包到最終的 JAR 文件中。

常見問題：使用 system 作用域

在 Maven 中，可以使用 system 作用域來引用本地 JAR 包。然而，這種方法有幾個顯著的缺點：
- 不可移植性：system 作用域依賴的路徑是硬編碼的，其他開發(fā)人員在不同的環(huán)境中可能無法找到該路徑。
- 打包問題：使用 system 作用域的依賴默認不會包含在最終打包的 JAR 文件中，導致運行時缺少必要的依賴。
依賴管理的最佳實踐

為了避免上述問題，推薦的做法是將本地依賴庫安裝到 Maven 本地倉庫中，并使用常規(guī)的依賴管理機制進行引用。這樣，可以確保依賴庫的一致性和可移植性，同時也方便后續(xù)的依賴管理和版本控制。
解決方案：將本地依賴庫打包到最終 JAR

詳細步驟

以下是詳細的步驟，展示如何在 Maven 項目中包含本地依賴庫并將其打包到最終的 JAR 文件中。

步驟 1：將本地 JAR 安裝到 Maven 本地倉庫

首先，需要將本地的 JAR 包安裝到 Maven 的本地倉庫中。假設有一個本地的 flink-doris-connector JAR 文件位于項目的 libs 目錄下。

打開終端，執(zhí)行以下命令：

mvn install:install-file \
-DgroupId=org.apache.doris \
-DartifactId=flink-connector-doris_2.12 \
-Dversion=1.14_2.12-1.1.1 \
-Dpackaging=jar \
-Dfile=libs/flink-doris-connector-1.14_2.12-1.1.1.jar

參數(shù)說明：

通過上述命令，將本地的 JAR 包安裝到 Maven 本地倉庫中，使其能夠像其他依賴一樣被 Maven 管理。

-DgroupId：依賴的組織 ID，通常與包名相對應。
-DartifactId：依賴的模塊名。
-Dversion：依賴的版本號。
-Dpackaging：依賴的打包類型，通常為 jar。
-Dfile：本地 JAR 文件的路徑。

步驟 2：修改 pom.xml 文件中的依賴配置

安裝完成后，需要在項目的 pom.xml 文件中引用該依賴。移除之前使用 system 作用域的配置，并改為默認的 compile 作用域。

原始依賴配置（使用 system 作用域）

<dependency>
    <groupId>org.apache.doris</groupId>
    <artifactId>flink-connector-doris_${scala.binary.version}</artifactId>
    <version>1.14_2.12-1.1.1</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/libs/flink-doris-connector-1.14_2.12-1.1.1.jar</systemPath>
</dependency>

修改后的依賴配置

注意：省略了和元素，默認作用域為 compile，這樣 Maven 會自動處理該依賴。

<dependency>
    <groupId>org.apache.doris</groupId>
    <artifactId>flink-connector-doris_${scala.binary.version}</artifactId>
    <version>1.14_2.12-1.1.1</version>
</dependency>