构建与依赖 / 系统课时

规划多模块示例项目

规划多模块示例项目

多模块项目先解决“谁依赖谁、版本放哪里”再写业务代码。这里用一个订单示例拆成领域、服务和启动三个模块,并用父 POM 统一坐标与版本,使依赖方向能通过 Maven Reactor 直接验证。

学习目标

  • 能按职责拆出父工程、领域层、服务层和启动层,并保持单向依赖。
  • 能在父 POM 中统一模块坐标与内部依赖版本。
  • 能用 Reactor 构建顺序检查模块声明和依赖关系是否正确。

先定模块边界和依赖方向

示例固定使用 Java 17、Maven 3.9.x,坐标统一为 com.example:order-*,版本统一为 1.0.0-SNAPSHOT。模块职责和允许依赖如下,业务依赖只允许从外层指向内层。

模块 packaging 职责 允许依赖
order-parent pom 聚合模块、统一版本 不放业务代码
order-domain jar 订单实体与领域规则 不依赖其他业务模块
order-service jar 用例编排 只依赖 order-domain
order-app jar 启动与接口适配 依赖 order-service

订单多模块依赖方向

目录只需要四个同级 Maven 工程:根目录放父 pom.xml,三个子目录分别为 order-domain、order-service、order-app。如果出现 domain -> service 的反向引用,应移动接口或模型,而不是用循环依赖解决。

写出父 POM 和子模块坐标

父 POM 负责聚合与版本治理,不直接声明业务依赖。内部模块版本放到 dependencyManagement,这样子模块引用同组模块时不再重复写版本。

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

  <groupId>com.example</groupId>
  <artifactId>order-parent</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <!-- 根 POM 只负责聚合,不承载业务代码。 -->
  <modules>
    <module>order-domain</module>
    <module>order-service</module>
    <module>order-app</module>
  </modules>

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

  <!-- 内部模块版本只在父 POM 维护。 -->
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.example</groupId>
        <artifactId>order-domain</artifactId>
        <version>${project.version}</version>
      </dependency>
      <dependency>
        <groupId>com.example</groupId>
        <artifactId>order-service</artifactId>
        <version>${project.version}</version>
      </dependency>
    </dependencies>
  </dependencyManagement>
</project>

order-domain/pom.xml 只继承父工程,不增加业务依赖。

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.example</groupId>
    <artifactId>order-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
  </parent>
  <artifactId>order-domain</artifactId>
  <!-- 领域层不声明其他业务模块依赖。 -->
</project>

order-service/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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.example</groupId>
    <artifactId>order-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
  </parent>
  <artifactId>order-service</artifactId>
  <!-- 内部模块版本由父 POM 的 dependencyManagement 提供。 -->
  <dependencies>
    <dependency>
      <groupId>com.example</groupId>
      <artifactId>order-domain</artifactId>
    </dependency>
  </dependencies>
</project>

order-app/pom.xml 只依赖服务模块,不跨层直接引用领域模块。

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.example</groupId>
    <artifactId>order-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
  </parent>
  <artifactId>order-app</artifactId>
  <!-- 启动层只通过 service 进入业务能力。 -->
  <dependencies>
    <dependency>
      <groupId>com.example</groupId>
      <artifactId>order-service</artifactId>
    </dependency>
  </dependencies>
</project>

这些 POM 的生效结果是:三个子模块继承同一版本,service 和 app 的内部依赖无需再次写 <version>,修改父工程版本即可整体推进。

用 Reactor 验证规划是否成立

在根目录执行下面的完整构建命令。-pl order-app 只选择启动模块,-am 会把它依赖的内部模块一并加入 Reactor;如果依赖方向和模块声明正确,构建顺序应从内到外。

bash
mvn -pl order-app -am validate

预期输出的关键部分如下,Maven 小版本、耗时和本地路径可能不同。

text
[INFO] Reactor Build Order:
[INFO] order-parent
[INFO] order-domain
[INFO] order-service
[INFO] order-app
...
[INFO] BUILD SUCCESS

若 order-service 没有声明对 order-domain 的依赖,Reactor 顺序不会体现这条关系;若模块目录名与 <module> 不一致,则会在读取项目阶段直接报找不到子模块。

用四条规则做最终检查

检查时只看四件事:order-domain 不依赖其他业务模块;每个子模块只声明直接依赖;内部模块版本只在父 POM 管理;order-parent 的 packaging 必须是 pom。例如把 order-domain 同时依赖 order-service 会形成循环,应把共同接口下沉到领域层或独立的新模块,而不是用排除依赖掩盖问题。

按这套结构继续增加 order-infrastructure 或 order-web 时,先写清职责和单向依赖,再把模块加入父 POM;只要 Reactor 顺序与设计一致,后续统一编译、测试和质量门禁就有稳定的落点。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

规划多模块示例项目

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通