Spring Boot 項目新增 Module 完整指南

1. 模塊化開發的重要性

在軟件開發中，隨著項目規模的不斷擴大，??模塊化設計??已成為提高代碼可維護性和可復用性的關鍵實踐。通過將大型項目拆分為多個獨立模塊，開發團隊可以??并行開發??不同功能組件，降低代碼耦合度，并提高整體開發效率。Spring Boot框架提供了良好的支持，使開發者能夠輕松創建和管理多模塊項目。

模塊化開發允許每個模塊專注于特定業務功能或技術層面，例如將數據訪問層、業務邏輯層和Web層分離為獨立模塊。這種架構使得代碼組織更加清晰，測試更加方便，并且有利于團隊協作。

2. 創建父項目（Parent Project）

創建多模塊項目首先需要建立一個??父項目??作為整個項目的基礎容器。父項目不包含具體業務代碼，而是負責統一管理所有子模塊的依賴和配置。

2.1 初始化父項目

使用Spring Initializr創建父項目，選擇Maven作為構建工具，Java作為開發語言，并選擇最新的Spring Boot穩定版本。創建完成后，需要修改父項目的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>parent-project</artifactId><version>1.0-SNAPSHOT</version><packaging>pom</packaging><modules><module>moduleA</module><module>moduleB</module></modules><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.2.0</version><relativePath/></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build>
</project>

關鍵配置說明：

? ??packaging類型??：必須設置為pom，表示這是一個父項目

? modules標簽??：包含所有子模塊的列表

? ??parent標簽??：繼承Spring Boot官方父項目，獲得默認配置

2.2 清理父項目結構

由于父項目不包含實際代碼，需要刪除不必要的文件和文件夾：

? 刪除.mvn文件夾和src目錄

? 刪除mvnw和mvnw.cmd文件

? 只保留pom.xml文件進行依賴管理

3. 新增子模塊（Module）

3.1 創建子模塊步驟

在父項目基礎上新增子模塊的流程如下：

在IDE中右鍵點擊父項目，選擇"New" → “Module”
選擇Spring Initializr作為模塊模板
設置子模塊的GroupId和ArtifactId（不要與父項目重復）
選擇所需的Spring Boot起步依賴
指定模塊名稱和存儲路徑

3.2 子模塊pom.xml配置

每個子模塊需要有獨立的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><artifactId>moduleA</artifactId><packaging>jar</packaging><parent><groupId>com.example</groupId><artifactId>parent-project</artifactId><version>1.0-SNAPSHOT</version></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId></dependency><!-- 其他模塊依賴 --><dependency><groupId>com.example</groupId><artifactId>common-module</artifactId><version>1.0-SNAPSHOT</version></dependency></dependencies>
</project>

子模塊配置要點：

? ??parent配置??：必須指向父項目

? packaging類型??：通常設置為jar

? 依賴聲明??：添加模塊特定需要的依賴

4. 模塊間的依賴管理

4.1 統一依賴管理

在父項目中可以統一管理所有子模塊的依賴版本，避免版本沖突：

<!-- 父項目pom.xml中 -->
<properties><java.version>17</java.version><lombok.version>1.18.30</lombok.version><mysql.version>8.0.33</mysql.version><!-- 統一管理項目版本號 --><parentProject.version>1.0-SNAPSHOT</parentProject.version>
</properties><dependencyManagement><dependencies><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${lombok.version}</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>${mysql.version</version></dependency></dependencies><!-- 子模塊版本管理 --><dependency><groupId>com.example</groupId><artifactId>moduleA</artifactId><version>${parentProject.version}</version></dependency>
</dependencyManagement>

4.2 模塊間依賴引用

一個模塊可以依賴其他模塊，只需在pom.xml中添加對應模塊的依賴：

<dependency><groupId>com.example</groupId><artifactId>moduleA</artifactId><version>1.0-SNAPSHOT</version>
</dependency>

這樣，moduleB就可以使用moduleA中定義的類和服務了。

5. 模塊配置與自定義屬性

5.1 模塊特定配置

每個模塊可以有自己獨立的配置文件（application.yml或application.properties），用于設置模塊特定的屬性：

# moduleA/src/main/resources/application.yml
server:port: 8081spring:datasource:url: jdbc:mysql://localhost:3306/moduleA_dbusername: rootpassword: passwordcustom:module:setting: value-specific-to-moduleA

5.2 跨模塊配置共享

使用Spring Boot的@ConfigurationProperties注解，可以創建能夠在多個模塊間共享的配置類：

// 在common模塊中定義
@Component
@ConfigurationProperties(prefix = "sky.aa")
@Data
public class AA {private String name;private String age;
}

在其他模塊中，只需在配置文件中設置相應屬性即可注入使用：

# 在使用模塊的application.yml中
sky:aa:name: zhanage: 12

這種機制使得配置能夠在模塊間共享和重用。

6. 代碼實現示例

6.1 創建模塊服務類

在每個模塊中，可以創建特定的服務類實現業務邏輯：

package com.example.moduleA;import org.springframework.stereotype.Service;@Service
public class MyService {public String getGreeting() {return "Hello from Module A!";}
}

6.2 創建REST控制器

package com.example.mymodule.controller;import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api/hello")
public class HelloController {@GetMappingpublic String sayHello() {return "Hello from My Module!";}
}

6.3 主應用類

每個可獨立運行的模塊需要有自己的主應用類：

package com.example.moduleA;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

7. 構建與測試

7.1 項目構建

使用Maven命令構建整個項目：

# 在父項目目錄下執行
mvn clean install

此命令會編譯所有模塊，運行測試，并安裝到本地Maven倉庫。

7.2 運行特定模塊

要運行特定模塊，可以進入模塊目錄并使用Spring Boot插件：

cd moduleA
mvn spring-boot:run

或者直接在IDE中運行模塊的主應用類。

7.3 測試模塊間依賴

在依賴其他模塊的模塊中，可以測試依賴是否正常工作：

import com.example.modulea.ServiceA;@Service
public class ServiceB {private final ServiceA serviceA;public ServiceB(ServiceA serviceA) {this.serviceA = serviceA;}public void performAction() {serviceA.action();}
}