Spring Boot + Maven 多模組專案開發詳解

自足發表於2024-07-25
Spring BootMaven

Spring Boot + Maven 多模組專案開發詳解

在現代軟體開發中，模組化開發是一種非常重要的設計思想。它不僅能提高程式碼的可維護性，還能促進團隊協作。今天，我們就來聊聊如何使用 Spring Boot 和 Maven 來構建一個多模組專案。

為什麼要使用多模組？

在開始之前，我們先來討論一下為什麼要使用多模組。假設你正在開發一個大型的企業級應用，這個應用可能包含多個功能模組，比如使用者管理、訂單處理、支付系統等等。如果把所有程式碼都放在一個專案中，程式碼量會非常龐大，維護起來也非常困難。而使用多模組的方式，可以將不同的功能模組拆分成獨立的子模組，每個子模組負責一個特定的功能，這樣不僅程式碼結構更加清晰，還能提高開發效率。

專案結構

首先，我們來看一下一個典型的 Spring Boot + Maven 多模組專案的結構：

my-multi-module-project
│
├── pom.xml
├── module-a
│   └── pom.xml
├── module-b
│   └── pom.xml
└── module-c
    └── pom.xml

在這個專案結構中，my-multi-module-project 是父專案，module-a、module-b 和 module-c 是子模組。每個子模組都有自己的 pom.xml 檔案，而父專案的 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>

    <groupId>com.example</groupId>
    <artifactId>my-multi-module-project</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>module-a</module>
        <module>module-b</module>
        <module>module-c</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.5.4</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

在這個 pom.xml 檔案中，我們定義了三個子模組 module-a、module-b 和 module-c，並且引入了 Spring Boot 的依賴管理。

建立子模組

接下來，我們需要為每個子模組建立 pom.xml 檔案。以 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-multi-module-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>module-a</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
</project>

在這個 pom.xml 檔案中，我們透過 <parent> 標籤指定了父專案，並引入了 Spring Boot 的依賴。

編寫程式碼

現在，我們可以開始編寫程式碼了。以 module-a 為例，我們建立一個簡單的 Spring Boot 應用。

首先，在 module-a 中建立一個 Application.java 檔案：

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);
    }
}

接下來，我們在 module-a 中建立一個簡單的控制器：

package com.example.modulea.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello from Module A!";
    }
}

執行專案

最後，我們可以透過 Maven 來執行整個專案。在父專案的根目錄下執行以下命令：

mvn clean install
mvn spring-boot:run -pl module-a

透過瀏覽器訪問 http://localhost:8080/hello，你應該能看到 "Hello from Module A!" 的輸出。

總結

透過這篇文章，我們詳細介紹瞭如何使用 Spring Boot 和 Maven 來構建一個多模組專案。我們從專案結構、父專案配置、子模組配置到程式碼編寫，一步一步地進行了講解。希望這篇文章能對你有所幫助，讓你在實際專案中更加得心應手。

如果你有任何問題或建議，歡迎在評論區留言，我們一起交流學習！

Happy coding!

百萬大學生都在用的AI寫論文工具，篇篇無重複👉: AI寫論文

相關文章