spring boot多模块项目构建

原创

mob64ca12de62a6 2024-11-23 04:47:14 ©著作权

文章标签 多模块 xml 可维护性 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12de62a6的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot多模块项目构建

在开发大型企业级应用时，单一模块的设计往往难以应对复杂的业务需求。为了提升开发效率和可维护性，Spring Boot 提供了多模块项目的构建方式。本文将给出多模块项目的基本概念、构建步骤及代码示例，以帮助开发者快速上手。

什么是多模块项目？

多模块项目是指将项目的功能划分为多个独立的模块，每个模块负责特定的功能，可以单独开发、测试和部署。这种结构，提高了代码的可复用性和可维护性，同时可以根据实际需求灵活地组合各个模块。

项目结构

我们以一个简单的电商系统为例，构建以下模块：

ecommerce-api：定义接口和实体类。
ecommerce-service：处理业务逻辑。
ecommerce-web：负责控制层，接收请求并返回响应。

项目的结构如下：

ecommerce-parent
|-- ecommerce-api
|-- ecommerce-service
|-- ecommerce-web
|-- pom.xml

pom.xml文件配置

首先，在根目录的 pom.xml 中设置父级模块，其中可以定义项目的整体依赖和版本信息：

<project xmlns="
         xmlns:xsi="
         xsi:schemaLocation=" 
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>ecommerce-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>ecommerce-api</module>
        <module>ecommerce-service</module>
        <module>ecommerce-web</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>
</project>

各模块具体配置

1. ecommerce-api模块

该模块包含接口定义及实体类。以下是一个简单的商品实体类：

package com.example.ecommerce.api.model;

public class Product {
    private Long id;
    private String name;
    private Double price;

    // getters and setters
}

在 ecommerce-api/pom.xml 中添加如下依赖：

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>ecommerce-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>ecommerce-api</artifactId>
    <dependencies>
        <!-- 这里可以添加相应的依赖 -->
    </dependencies>
</project>

2. ecommerce-service模块

该模块实现具体的业务逻辑，示例代码如下：

package com.example.ecommerce.service;

import com.example.ecommerce.api.model.Product;
import org.springframework.stereotype.Service;

@Service
public class ProductService {
    public Product findProductById(Long id) {
        // 模拟查找商品逻辑
        return new Product(id, "Sample Product", 19.99);
    }
}

在 ecommerce-service/pom.xml 中添加 ecommerce-api 的依赖：

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>ecommerce-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>ecommerce-service</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>ecommerce-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

3. ecommerce-web模块

该模块负责接收请求并调用服务层，包括简单的控制器：

package com.example.ecommerce.web.controller;

import com.example.ecommerce.api.model.Product;
import com.example.ecommerce.service.ProductService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ProductController {
    
    @Autowired
    private ProductService productService;

    @GetMapping("/products/{id}")
    public Product getProduct(@PathVariable Long id) {
        return productService.findProductById(id);
    }
}

在 ecommerce-web/pom.xml 中添加对 ecommerce-service 的依赖：

<project>
    <parent>
        <groupId>com.example</groupId>
        <artifactId>ecommerce-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>ecommerce-web</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>ecommerce-service</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

状态图

使用 Mermaid 可以直观地展示模块之间的交互。在下图中，我们可以看到请求流向和模块之间的关系：

stateDiagram
    [*] --> ecommerce-web: 接收请求
    ecommerce-web --> ecommerce-service: 调用业务逻辑
    ecommerce-service --> ecommerce-api: 获取数据
    ecommerce-api --> ecommerce-service: 返回数据
    ecommerce-service --> ecommerce-web: 返回结果
    ecommerce-web --> [*]: 发送响应