Maven多模塊項目架構配置介紹和實戰

中大型項目中，我們都會把項目結構劃分多個模塊。它清晰的定義，便於項目結果維護，同時在日常代碼變更時，各個模塊的隔離也一定程度上保證了變更質量…… ...

原文地址：https://ntopic.cn/p/2023071501/
源代碼先行：

Gitee多模塊項目倉庫：https://gitee.com/obullxl/ntopic-boot
GitHub多模塊項目倉庫：https://github.com/obullxl/ntopic-boot

背景介紹

我們項目採用的是Maven多模塊架構，我發現項目的部分子模塊的pom.xml中重覆引用了相同的JAR包。很明顯，當初在配置Maven模塊的時候，沒有考慮清楚各個模塊的架構職責，同時也不瞭解Maven模塊依賴的傳遞性。本文主要介紹一下Maven多模塊的配置思路和多模塊的配置實操。

Maven多模塊配置

在實操之前，我們先要瞭解配置概覽，配置大致可分為三大步：確定項目需要哪幾個模塊，項目中的每個模塊的依賴關係如何，最後根據依賴關係配置。

第一步：確定項目的模塊劃分

模塊的劃分沒有任何強制要求，一般的劃分思路如下：

test 集成測試模塊：該模塊除了測試用例代碼外，沒有實際業務邏輯。項目中我們用junit和Mockito測試框架比較多，Mockito集成測試框架和SpringBoot集成可我之前的博客：https://ntopic.cn/p/2023052001/
facade 對外服務介面模塊（如果有的話，一般業務類項目較小，服務類較大）：主要是對外提供服務介面、請求參數和返回結果等JAR包，其他項目需要依賴項目JAR包，因此需要單獨一個模塊
client 集成外部服務介面模塊：和facade對應，如果依賴了外部服務的話
lang 基礎公用模塊：各個模塊都會依賴的公共類模塊，比如常用工具類、通用枚舉等
das 數據訪問模塊：接入DB層的代碼，包括DO/DAO等
service 領域核心服務模塊：各個業務領域的核心服務邏輯
web/biz 業務模塊：業務邏輯模塊。如果業務比較複雜，可進一步拆分，如web-user/web-order等

根據上面說明，https://gitee.com/obullxl/ntopic-boot的模塊劃分如下：

ntopic-test 集成測試模塊
ntopic 業務邏輯模塊，包括SpringBoot啟動類、Web模塊、業務模塊等
ntopic-servcie 領域核心服務
ntopic-client 外部伺服器集成
ntopic-das DB操作
ntopic-lang 公共模塊

IDEA代碼結構	GitHub代碼樣例

第二步：確定各個模塊的依賴關係

Maven模塊的依賴具備傳遞性，即：若模塊A依賴了模塊B，模塊B依賴了模塊C，則模塊A自動依賴了模塊C（有點類似於數學中數值大小的傳遞性，A>B且B>C，則A>C）。
https://gitee.com/obullxl/ntopic-boot項目的各個模塊依賴關係說明：

ntopic-test 集成測試模塊：因為集成測試包括了所有的代碼邏輯，所以它處於最上層
ntopic 業務模塊，業務邏輯依賴service模塊提供核心服務
ntopic-service 核心服務模塊，它依賴DB數據讀寫和引入外部服務
ntopic-lang 公共邏輯模塊，它進一步依賴其他統一模塊，如commons模塊等

第三步：Maven多模塊實操

多模塊的核心在pom.xml文件中，任何一個pom.xml模塊，都需要指定五個核心配置元素：

groupId 代表大分組，一般都是公司的功能變數名稱，如 cn.ntopic / com.aliaba 等
artifactId 代表具體的JAR包名，如 sequence-jdbc / fastjson 等
version 代表JAR包版本，如 1.0.1 / 1.2.76 等
packaging 代表模塊打包方式，預設都是jar，對於多模塊的總模塊或者父模塊為pom
name 代表模塊名稱，可選配置，建議配置

總pom.xml文件

總pom.xml配置了整個項目的所有信息，包括項目的模塊列表、依賴的JAR包、倉庫和打包方式等。

指定父模塊：可選的，可以沒有父模塊。如ntopic-boot是基於SpringBoot框架，所以它的父模塊是SpringBoot的。

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
        <relativePath/>
    </parent>

    <groupId>ntopic</groupId>
    <artifactId>ntopic-parent</artifactId>
    <version>1.0.1</version>
    <packaging>pom</packaging>

    <name>ntopic-parent</name>

指定模塊本項目的模塊列表：

    <modules>
        <module>ntopic-test</module>
        <module>ntopic</module>
        <module>ntopic-service</module>
        <module>ntopic-das</module>
        <module>ntopic-client</module>
        <module>ntopic-lang</module>
    </modules>

模塊依賴管理，各個子模塊中，可以直接使用這裡配置的依賴：

    <dependencyManagement>
      <dependencies>
              <!-- NTopic Modules -->
              <dependency>
                  <groupId>ntopic</groupId>
                  <artifactId>ntopic-lang</artifactId>
                  <version>${ntopic.version}</version>
              </dependency>
              <dependency>
                  <groupId>ntopic</groupId>
                  <artifactId>ntopic-client</artifactId>
                  <version>${ntopic.version}</version>
              </dependency>
        <!-- 其他本項目子模塊忽略 -->

        <!-- SpringBoot Starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
            <version>${springboot.boot.version}</version>
        </dependency>

        <!--  Google Guava -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>30.1.1-jre</version>
        </dependency>

        <!-- 其他省略 -->
        </dependencies>
    </dependencyManagement>

額外的Maven倉庫和打包方式配置：

    <repositories>
        <repository>
            <id>Gitee-obullxl</id>
            <url>https://gitee.com/obullxl/maven-repository/raw/sequence-jdbc</url>
        </repository>
    </repositories>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${springboot.boot.version}</version>
            </plugin>
        </plugins>
    </build>

子模塊pom.xml文件

總模塊配置好了之後，子模塊的配置就簡單多了，只需要配置3個信息塊：父模塊、四元素和依賴其它子模塊。其中依賴的子模塊按照第二步中的依賴關係配置即可：

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>ntopic</groupId>
        <artifactId>ntopic-parent</artifactId>
        <version>1.0.1</version>
    </parent>

    <artifactId>ntopic-service</artifactId>
    <packaging>jar</packaging>
    <version>${ntopic.version}</version>

    <name>ntopic-service</name>

    <dependencies>
        <!-- NTopic Module -->
        <dependency>
            <groupId>ntopic</groupId>
            <artifactId>ntopic-das</artifactId>
        </dependency>
        <dependency>
            <groupId>ntopic</groupId>
            <artifactId>ntopic-client</artifactId>
        </dependency>
    </dependencies>
</project>

編譯項目各個模塊

經過上面的配置，項目Maven多模塊架構已經配置完成，進行項目編譯即可：

mvn compile

編譯成功的結果：

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] ntopic-parent ...................................... SUCCESS [  0.022 s]
[INFO] ntopic-lang ........................................ SUCCESS [  0.873 s]
[INFO] ntopic-das ......................................... SUCCESS [  0.121 s]
[INFO] ntopic-client ...................................... SUCCESS [  0.042 s]
[INFO] ntopic-service ..................................... SUCCESS [  0.055 s]
[INFO] ntopic ............................................. SUCCESS [  0.073 s]
[INFO] ntopic-test ........................................ SUCCESS [  0.114 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.094 s
[INFO] Finished at: 2023-07-15T13:41:57+08:00
[INFO] Final Memory: 35M/448M
[INFO] ------------------------------------------------------------------------

本文作者：奔跑的蝸牛，轉載請註明原文鏈接：https://ntopic.cn