Java Pom兩個模組需要互相引用怎麼辦

TechSynapse發表於2024-09-20
Java

1. Java POM模組化是什麼

在Java專案中，特別是在使用Maven作為構建工具時，"POM模組化"是一個重要的概念，它指的是將大型專案拆分成多個更小、更易於管理的模組（或稱為子專案）。每個模組都有自己的pom.xml檔案，該檔案定義了模組的構建配置，包括依賴關係、外掛、目標平臺等。

1.1 POM（Project Object Model）

POM是Maven專案管理和構建的核心檔案，它通常是一個名為pom.xml的XML檔案。POM檔案包含了專案的所有配置資訊，Maven透過這些資訊來構建專案、管理依賴以及執行其他構建任務。

1.2 模組化

模組化是一種將軟體分解成一組獨立但可互操作的模組的技術。在Maven專案中，模組化意味著將大型應用程式或庫拆分成更小的元件，每個元件都負責一組特定的功能或業務邏輯。這些元件（即模組）可以透過Maven的依賴管理機制相互依賴，從而形成一個完整的應用程式或庫。

1.3 Maven模組化專案的優點

（1）可重用性：模組可以被多個專案共享和重用。

（2）易於管理：大型專案拆分成多個小模組後，每個模組都可以獨立構建和測試，從而簡化了整個專案的構建和測試過程。

（3）清晰的依賴關係：透過POM檔案中的依賴宣告，可以清晰地看到模組之間的依賴關係。

（4）團隊協作：不同的模組可以由不同的團隊或開發者並行開發，提高了開發效率。

（5）靈活性：模組化使得專案更加靈活，可以更容易地新增、刪除或替換模組。

1.4 Maven模組化專案的結構

一個Maven模組化專案通常包含一個父POM檔案和多個子模組。父POM檔案定義了所有子模組共享的構建配置和依賴管理策略。子模組則繼承父POM的配置，並根據需要新增特定的配置或依賴。

1.5 示例

假設有一個名為MyProject的Maven模組化專案，它包含三個子模組：common、module-a和module-b。專案的目錄結構可能如下所示：

MyProject/  
|-- pom.xml (父POM)  
|-- common/  
|   |-- pom.xml  
|   |-- src/  
|       |-- main/  
|           |-- java/  
|               |-- com/example/common/  
|-- module-a/  
|   |-- pom.xml  
|   |-- src/  
|       |-- main/  
|           |-- java/  
|               |-- com/example/modulea/  
|-- module-b/  
    |-- pom.xml  
    |-- src/  
        |-- main/  
            |-- java/  
                |-- com/example/moduleb/

在這個例子中，MyProject/pom.xml是父POM檔案，它定義了所有子模組共有的配置和依賴。common、module-a和module-b是子模組，它們分別包含自己的pom.xml檔案和原始碼。這些子模組可以透過Maven的依賴機制相互依賴，也可以依賴外部庫。

透過模組化，MyProject專案變得更加清晰、易於管理和維護。開發者可以獨立地構建和測試每個模組，而不必擔心它們之間的依賴關係。同時，模組化的結構也使得專案更加靈活，可以更容易地根據需求進行擴充套件或修改。

2. Java Pom兩個模組需要互相引用方法示例

在Maven專案中，當兩個模組（或稱為子專案）需要互相引用時，通常意味著這兩個模組之間存在緊密的依賴關係。然而，Maven的常規依賴管理並不直接支援迴圈依賴（即A依賴B，B又依賴A），因為這會導致構建過程中的死鎖。不過，大多數情況下，可以透過重新設計模組結構或利用Maven的特性（如聚合和繼承）來避免直接的迴圈依賴。

但假設我們的場景是合理的，比如兩個模組分別負責不同的業務邏輯，但確實需要共享一些公共的類或介面，而這些類或介面又分佈在兩個模組中。這種情況下，我們可以考慮將共享的部分提取到一個新的模組中，然後讓這兩個模組都依賴於這個新模組。

我將展示一個簡化的例子，其中兩個模組module-a和module-b透過Maven的聚合（Aggregation）和繼承（Inheritance）機制來組織，並假設它們透過共享一個公共的父POM來管理依賴，而不是直接互相引用。

2.1 專案結構

my-project/  
|-- pom.xml (父POM)  
|-- module-a/  
|   |-- pom.xml  
|   |-- src/  
|       |-- main/  
|           |-- java/  
|               |-- com/example/modulea/ModuleA.java  
|-- module-b/  
|   |-- pom.xml  
|   |-- src/  
|       |-- main/  
|           |-- java/  
|               |-- com/example/moduleb/ModuleB.java  
|-- common/  
    |-- pom.xml  
    |-- src/  
        |-- main/  
            |-- java/  
                |-- com/example/common/SharedClass.java

2.2 父POM (my-project/pom.xml)

<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
    <groupId>com.example</groupId>  
    <artifactId>my-project</artifactId>  
    <version>1.0-SNAPSHOT</version>  
    <packaging>pom</packaging>  
  
    <modules>  
        <module>module-a</module>  
        <module>module-b</module>  
        <module>common</module>  
    </modules>  
</project>

2.3 common 模組 (common/pom.xml)

<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
    <parent>  
        <groupId>com.example</groupId>  
        <artifactId>my-project</artifactId>  
        <version>1.0-SNAPSHOT</version>  
    </parent>  
  
    <artifactId>common</artifactId>  
  
    <dependencies>  
        <!-- 這裡可以新增common模組需要的依賴 -->  
    </dependencies>  
</project>

2.4 module-a 和 module-b 的POM檔案

這兩個模組的POM檔案將非常相似，除了它們的artifactId和可能的一些特定依賴外。它們都將依賴於common模組。

<!-- 以module-a為例 -->  
<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
    <parent>  
        <groupId>com.example</groupId>  
        <artifactId>my-project</artifactId>  
        <version>1.0-SNAPSHOT</version>  
    </parent>  
  
    <artifactId>module-a</artifactId>  
  
    <dependencies>  
        <dependency>  
            <groupId>com.example</groupId>  
            <artifactId>common</artifactId>  
            <version>${project.version}</version>  
        </dependency>  
        <!-- 其他依賴 -->  
    </dependencies>  
</project>

2.5 結論

在這個例子中，module-a和module-b沒有直接互相引用，而是透過共享一個common模組來避免迴圈依賴。這是處理Maven專案中模組間依賴關係的推薦方式。如果確實需要兩個模組直接互相引用，那麼可能需要重新考慮我們的專案結構或設計模式。

3. 如何使用Maven模組化

使用Maven進行模組化是一種將大型專案分解為更小、更易於管理的部分的方法。每個模組都是一個獨立的Maven專案，擁有自己的pom.xml檔案，但可以透過Maven的繼承和聚合特性與其他模組相關聯。以下是如何使用Maven進行模組化的基本步驟：

3.1 建立父POM

首先，我們需要建立一個父POM（pom.xml），它將作為所有子模組的通用配置模板。父POM通常不包含原始碼，而是定義了專案共有的配置，如依賴管理、外掛配置、目標平臺等。

<!-- 父POM (位於專案根目錄) -->  
<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
    <groupId>com.example</groupId>  
    <artifactId>my-project-parent</artifactId>  
    <version>1.0-SNAPSHOT</version>  
    <packaging>pom</packaging>  
  
    <!-- 依賴管理 -->  
    <dependencyManagement>  
        <dependencies>  
            <!-- 這裡定義子模組可能需要的依賴項及其版本 -->  
        </dependencies>  
    </dependencyManagement>  
  
    <!-- 外掛管理 -->  
    <build>  
        <pluginManagement>  
            <!-- 這裡定義構建過程中可能需要的外掛及其配置 -->  
        </pluginManagement>  
    </build>  
  
    <!-- 模組列表 -->  
    <modules>  
        <module>module-a</module>  
        <module>module-b</module>  
        <!-- 其他子模組 -->  
    </modules>  
</project>

注意：<packaging>pom</packaging>表明這是一個聚合POM，它不會構建任何實際的產品，而是用來聚合和管理其他模組。

3.2 建立子模組

然後，我們需要在父POM的同級目錄下（或指定的任何子目錄中）建立子模組。每個子模組都應該有自己的pom.xml檔案，並且通常會繼承自父POM。

<!-- 子模組A的POM (位於module-a目錄) -->  
<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
    <parent>  
        <groupId>com.example</groupId>  
        <artifactId>my-project-parent</artifactId>  
        <version>1.0-SNAPSHOT</version>  
    </parent>  
  
    <artifactId>module-a</artifactId>  
  
    <!-- 依賴項（如果需要的話） -->  
    <dependencies>  
        <!-- 這裡可以宣告具體的依賴項，版本號可以從父POM中繼承 -->  
    </dependencies>  
  
    <!-- 其他配置 -->  
</project>

3.3 構建專案

在父POM所在的目錄下執行Maven命令，Maven會自動找到並構建所有列在<modules>標籤下的子模組。

bash複製程式碼

mvn clean install

這個命令會首先清理之前構建生成的檔案，然後編譯、測試並安裝所有子模組到本地Maven倉庫中。

3.4 依賴管理

在父POM中定義的<dependencyManagement>部分允許我們指定依賴項及其版本號，但不會在父POM中實際引入這些依賴項。子模組可以透過宣告相同的依賴項（不包括版本號）來繼承這些依賴項及其版本號。

3.5 外掛管理

類似地，<pluginManagement>部分允許我們在父POM中定義外掛及其配置，但不會在父POM中實際執行這些外掛。子模組可以透過繼承這些外掛配置來簡化外掛配置過程。

3.6 結論

透過Maven模組化，我們可以將大型專案分解為更小、更易於管理的部分，同時利用Maven的繼承和聚合特性來共享配置和依賴項。這有助於提高專案的可維護性、可重用性和可擴充套件性。

相關文章