Spring Cloud微服务多模块架构：父子工程搭建实践

一、前言

在现代微服务架构中，Spring Cloud 提供了一整套工具和技术栈来简化分布式系统的开发。为了更好地组织和管理复杂的微服务项目，使用 Maven 多模块（父子工程） 是一种高效的方法。

‍

父子工程 是 Maven 中的一种项目结构，通过一个父项目（Parent Project）管理和多个子项目（Module）。父项目定义了所有子项目的通用配置和依赖，而子项目则继承这些配置并实现具体的功能模块。

主要优点

统一管理依赖: 所有子项目共享相同的依赖版本。
集中配置: 集中管理插件、属性和其他配置。
简化构建过程: 使用一个命令即可构建所有子项目。
提高可维护性: 修改配置或依赖只需在一个地方进行。

‍

本文将详细介绍如何使用 Maven 创建一个 Spring Cloud 父子工程，并展示其结构和配置方法。

‍

二、项目结构概述

假设你要创建一个 Spring Cloud 项目，其中有一个父工程和多个子工程。项目结构大致如下：

bash 复制代码

spring-cloud-parent
│
├── pom.xml               # 父模块 POM 文件
├── spring-cloud-api      # 子模块：共享 API
│   └── pom.xml
├── spring-cloud-service  # 子模块：微服务模块
│   └── pom.xml
└── spring-cloud-config   # 子模块：配置模块
    └── pom.xml

‍

版本选择

Spring Cloud spring.io/projects/sp...

由于Spring Cloud管理的微服务架构众多，为了让自己不用在项目后期解决环境冲突问题，请严格按照官网给出的 boot 与cloud 对应关系进行选型。

粗略

‍

详细版本查看

Spring Cloud spring.io/projects/sp...

‍

由官网可知，与2023.0.4 最为搭配的是Spring Boot 3.2.12 版本

‍

‍三、创建步骤

3.1 创建父工程

新建项目

使用IDEA开发工具

‍

选择一个最简单的 site模板

‍

初始化

‍

删除src等目录

创建完成后，删除src等目录，只留下pom文件(父工程只起一个聚合子项目的作用，实际过程中并不会打包运行)

‍

配置父 `pom.xml`

父工程中pom.xml 文件将会作为所有子模块的父 POM，管理共享依赖和插件配置。

‍

添加打包类型标签，注意设置 <packaging> 为 pom，表示这是一个聚合项目。

xml 复制代码

 <packaging>pom</packaging>

‍

添加依赖

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>org.example</groupId>
  <artifactId>spring-cloud-demo</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <modules>
    <module>spring-cloud-org</module>
    <module>spring-cloud-finance</module>
    <!-- 添加其他模块 -->
  </modules>

  <dependencyManagement>
    <dependencies>
      <!-- 定义Spring Boot版本 -->
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>3.2.12</version> <!-- 根据需要调整版本号 -->
        <type>pom</type>
        <scope>import</scope>
      </dependency>

      <!-- 定义Spring Cloud版本 -->
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>2023.0.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>

‍

参考：

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>spring-cloud-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>modules/module-service-a</module>
        <module>modules/module-service-b</module>
        <!-- 添加其他模块 -->
    </modules>

    <dependencyManagement>
        <dependencies>
            <!-- 定义Spring Boot版本 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>3.1.5</version> <!-- 根据需要调整版本号 -->
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- 定义Spring Cloud版本 -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>2022.0.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>

‍

3.2 子项目创建

创建子项目

‍

子pom添加依赖

xml 复制代码

   <parent>
     <groupId>org.example</groupId>
     <artifactId>spring-cloud-demo</artifactId>
     <version>1.0-SNAPSHOT</version>
   </parent>   


    <dependencies>
        <!-- 添加特定于服务的依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 更多依赖项 -->
    </dependencies>

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

‍

完整参考：

xml 复制代码

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.example</groupId>
    <artifactId>spring-cloud-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>

  <groupId>org.example</groupId>
  <artifactId>spring-cloud-org</artifactId>
  <version>1.0-SNAPSHOT</version>

  <name>spring-cloud-org</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>




  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.release>17</maven.compiler.release>
  </properties>


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

    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter-api</artifactId>
      <scope>test</scope>
    </dependency>
    <!-- Optionally: parameterized tests support -->
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter-params</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.4.0</version>
        </plugin>
        <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.3.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.13.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>3.3.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.4.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>3.1.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>3.1.2</version>
        </plugin>
        <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
        <plugin>
          <artifactId>maven-site-plugin</artifactId>
          <version>3.12.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-project-info-reports-plugin</artifactId>
          <version>3.6.1</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

‍

修改主启动类

‍

typescript 复制代码

@SpringBootApplication
public class OrgApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrgApplication.class, args);
    }
}

‍

新增配置文件application.yml

新建resource资源目录

‍

新增配置文件application.yml

‍

yaml 复制代码

server:
  port: 9922

spring:
  application:
    name: spring-cloud-org

‍

子项目启动测试

‍

至此一个子项目搭建完成，同理根据需要搭建其它模块，完成一个微服务父子项目的搭建

‍

通过本文的介绍，我们已经深入了解了如何在 Spring Cloud 中创建父子工程结构，并探讨了这种结构的优势。利用父子工程，开发者能够更好地管理微服务项目的依赖关系、共享配置，并且可以通过统一的版本管理减少版本冲突和重复劳动。如果你有更多关于 Spring Cloud 或微服务架构的问题，欢迎继续探索和讨论！

‍

Spring Cloud微服务多模块架构：父子工程搭建实践

一、前言

二、项目结构概述

版本选择

‍三、创建步骤

3.1 创建父工程

新建项目

删除src等目录

配置父 pom.xml​

3.2 子项目创建

创建子项目

子pom添加依赖

修改主启动类

新增配置文件application.yml

子项目启动测试

配置父 `pom.xml`