返回资讯中心
外部精选
软件工程
#开发者实时流

用架构测试守护Java单体应用的模块边界

来源标题:Checking Module Boundaries in a Java Monolith

文章介绍如何将模块边界约定转化为架构测试,防止开发者在编译和测试通过的情况下引入跨模块内部依赖。示例使用开源库Modulith Rules提供的预置ArchUnit规则,通过故意破坏规则再修复依赖的方式演示验证流程。该库核心功能不依赖Spring即可运行。

Hacker News 最新fksubs2026/11/10 · 8 天前28 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

模块边界往往始于一个看似完全合理的约定:ordering 可以使用 payments 的 API,而 payment 的实现细节则留在 payments 模块内部。所有人都理解这个约定,架构图看起来整洁清晰,团队继续开发应用。

几个功能之后,有人在 payments.internal 中的一个 public 类上发现了一个有用的方法。使用它能省一点事,编译器不会报错,测试也依然通过。包名本身在默默提出异议,但它在构建过程中没有投票权。这个依赖看起来可能无害,直到 payments 团队更改了实现,才发现 ordering 已经对实现细节产生了依赖。到那时,最初的决策就需要从一次对话、一张架构图,或者从任何还记得当初为什么在那里划定边界的人那里重新找回。

我更希望在引入这个依赖的时候就进行那场讨论。在本文中,我们将把 ordering 和 payments 之间的约定变成一个架构测试,故意破坏它,然后更改依赖关系使测试通过。

示例使用了 Modulith Rules,这是一个由我维护的开源库,提供预构建的 ArchUnit 规则。它的核心不依赖 Spring,在 test scope 中运行,与应用程序的其他测试一起执行。

我们的应用在 com.shop 下包含两个业务模块:ordering 和 payments。Payments 在其 API 包中暴露以下接口:

// src/main/java/com/shop/payments/api/PaymentGateway.java package com.shop.payments.api; public interface PaymentGateway { void pay();

实现位于 payments 内的一个独立包中:

// src/main/java/com/shop/payments/internal/PaymentGatewayImpl.java package com.shop.payments.internal; import com.shop.payments.api.PaymentGateway; public class PaymentGatewayImpl implements PaymentGateway { public void pay() {}

我把方法留空了,这样我们可以专注于依赖关系。一个什么都不做的支付实现会让演示相当轻松,不过我会让它远离结账流程。

该实现是 public 的,允许 payments 内的其他包使用它。同样的可见性也让 ordering 可以直接访问该实现:

// src/main/java/com/shop/ordering/internal/OrderService.java package com.shop.ordering.internal; import com.shop.payments.internal.PaymentGatewayImpl; public class OrderService { private final PaymentGatewayImpl payments; public OrderService(PaymentGatewayImpl payments) { this.payments = payments; public void placeOrder() { payments.pay();

这段代码能编译,因为该类及其方法是 public 的。对 Java 编译器来说,internal 只是包名的另一部分。我们表达了一个开发者可以读懂的意图,却没有给构建过程任何可检查的东西。

当某个类型只需要在一个包内使用时,包级私有可见性是有帮助的。然而,一个业务模块通常跨越多个包,一些实现类型需要是 public 的,以便这些包可以协作。我们仍然希望阻止其他模块的调用方接触这些实现细节。在这里,ordering 应该使用 payments 的 API,而不去碰它的内部实现。

GitHub 上的完整示例包含两个 Maven 项目,分别是修改前和修改后,其中包含下面使用的源文件和构建配置。你需要 Java 17 或更高版本。

对于架构测试,在 test scope 中添加核心库和 JUnit:

<dependency> <groupId>io.modularmonolith</groupId> <artifactId>modulith-rules-core</artifactId> <version>0.2.0</version> <scope>test</scope> </dependency> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter</artifactId> <version>6.1.2</version> <scope>test</scope> </dependency>

然后我们可以使用包名注册这两个模块,并选择保护 internal 包的规则。基于约定的配置从根包和模块名推导出 com.shop.ordering 和 com.shop.payments:

// src/test/java/com/shop/architecture/ArchitectureTest.java package com.shop.architecture; import com.tngtech.archunit.core.importer.ClassFileImporter; import io.modulith.rules.ModulithRules; import org.junit.jupiter.api.Test; class ArchitectureTest { void modulesDoNotAccessEachOthersInternals() { var classes = new ClassFileImporter().importPackages("com.shop"); ModulithRules.forPackage("com.shop", "ordering", "payments") .boundaryRules() .internalsShouldNotBeAccessedFromOutside() .check(classes);

运行包含直接实现依赖的版本:

cd boundary-example/before mvn test

测试报告 OrderService 跨模块边界访问了 payments.internal.PaymentGatewayImpl。其诊断信息标识了涉及的类,并建议通过 payments API 暴露一个服务接口。我们已经有那个接口了,这使得修改变得相当小。

Java 已经检查了它的可见性规则,架构测试检查了我们为模块约定的额外限制。审查者现在有一个具体的依赖可以在变更旁边讨论。记住应用中的每一个边界对于进行有用的代码审查来说变得不那么必要了。

ordering 服务可以通过更改其 import、字段类型和构造方法参数来依赖 PaymentGateway:

package com.shop.ordering.internal; import com.shop.payments.api.PaymentGateway; public class OrderService { private final PaymentGateway payments; public OrderService(PaymentGateway payments) { this.payments = payments; public void placeOrder() { payments.pay();

同样的架构测试现在通过了。Ordering 使用了 payments 暴露的契约,因此该契约背后的变更更有空间留在 payments 模块内。当然,我们仍然需要仔细设计接口;如果调用方需要理解实现才能使用它,那么把接口放在 api 包里几乎没有什么好处。

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →