spring boot3多模块项目工程搭建-上（团队开发模板）

在现代软件开发中，多模块项目逐渐成为一种主流的组织方式。尤其是在使用Spring Boot进行开发时，合理的模块划分能够提高项目的可维护性和可扩展性。本文将介绍如何搭建一个Spring Boot 3多模块项目的基本框架，并提供一些代码示例。

一、项目结构概述

多模块项目通常具有以下结构：

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

• parent-module: 父模块，包含所有子模块的共同配置，例如依赖管理和插件管理。
• module-a, module-b, module-c: 子模块，实现具体的业务功能。

二、创建父模块

首先，我们要创建一个父模块，命名为parent-module并添加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-module</artifactId>
    <version>1.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>3.0.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

</project>

三、创建子模块

接下来，我们创建第一个子模块module-a，同样创建一个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>parent-module</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>module-a</artifactId>

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

</project>

在module-a中，我们可以创建一个简单的REST Controller：

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 hello() {
        return "Hello from Module A!";
    }
}

创建其他子模块module-b、module-c的方式类似，只需修改artifactId、添加相关依赖和业务逻辑即可。

四、运行项目

完成上述步骤后，你可以通过在父模块目录下执行以下命令来启动项目：

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

总结

通过创建一个多模块的Spring Boot项目，我们能够将不同的业务逻辑分开，使得项目结构更加清晰，易于维护。在团队开发中，这种模式尤其适合大型项目，可以由不同的开发人员负责不同的模块，提升协作效率。希望本文提供的内容能够帮助你快速搭建多模块项目的基础框架。