Spring Modulith：我们是否达到了模块化的成熟度？

小咪咪 2024-03-30 17:45 23阅读 0赞

## Spring Modulith：我们是否达到了模块化的成熟度？ ##

*本文译自：[Spring Modulith: Have We Reached Modularity Maturity?][Spring Modulith_ Have We Reached Modularity Maturity]*

#### 微服务强制实施强大的模块边界，但微服务的缺点很大。在这篇文章中，学习实现相同结果的可管理方法。 ####

设计微服务的主要原因之一是它们强制实施[强大的模块边界][Link 1]。然而，微服务的缺点是如此之大，以至于就像砍掉你的右手来学习用左手写作一样;有更易于管理（和更少痛苦！）的方法来实现相同的结果。

即使自微服务热潮开始以来，一些冷静的头脑也占了上风。特别是，Spring框架的开发人员[Oliver Drotbohm][]长期以来一直是[moduliths][]替代方案的支持者。这个想法是保留一个整体，但围绕模块设计它。

许多人涌向微服务，因为他们使用的应用程序类似于意大利面拼盘。如果他们的应用程序设计得更好，微服务的吸引力就不会那么强。

### 为什么选择模块化？ ###

模块化是一种减少更改对代码库影响的方法。这与设计（大型）船舶的方式非常相似。

当水不断泄漏到船上时，后者通常会因为阿基米德推力的减小而下沉。为了避免一次泄漏使船沉没，它围绕多个水密[舱][Link 2]设计。如果发生一次泄漏，它包含在一个隔间中。虽然它并不理想，但它可以防止船沉没，允许它改道到最近的港口，在那里可以修理它。

模块化的工作方式类似：它为代码的某些部分设置了边界。这样，更改的影响仅限于零件，并且不会超出其边界。

在Java中，这些部分被称为包。与船舶的平行线止步于此，因为包裹必须协同工作才能达到预期的结果。包装不能“水密”。Java 语言提供了跨包边界工作的可见性修饰符。有趣的是，最著名的一个，允许完全交叉包。`public`

设计遵循最小特权原则的边界是一项持续的努力。很有可能，在项目在初始开发的压力下或随着维护期间的时间，努力会下滑，边界会衰减。

我们需要一种更先进的方法来加强边界。

### 模块，模块无处不在 ###

在Java的悠久历史中，“模块”一直是强制边界的解决方案。问题是，即使在今天，模块也有很多定义。

[OSGi][]始于2000年，旨在提供可以在运行时安全部署和取消部署的版本化组件。它保留了 JAR 部署单元，但在其清单中添加了元数据。OSGi功能强大，但开发OSGi*捆绑包*（模块的名称）很复杂。开发人员支付了更高的开发成本，而运营团队则享受了部署优势。DevOps 尚未诞生;它并没有使OSGi像它本来应该的那样受欢迎。

与此同时，Java的架构师们也在寻找模块化JDK的途径。与OSGI相比，该方法要简单得多，因为它避免了部署和版本控制问题。Java 9 中引入的 Java 模块将自身限制为以下数据：名称、公共 API 和对其他模块的依赖关系。

Java模块在JDK上运行良好，但由于鸡和蛋的问题，对于应用程序来说效果要差得多。为了对应用程序有所帮助，开发人员必须模块化库 - 而不是依赖于自动模块。但是，只有当足够多的应用程序开发人员使用它时，库开发人员才会这样做。[上次我检查时][Link 3]，20 个公共库中只有一半是模块化的。

在构建方面，我需要引用 Maven 模块。它们允许将一个人的代码拆分为多个项目。

JVM上还有其他模块系统，但这三个是最知名的。

### 强制实施边界的试探性方法 ###

如上所述，微服务在开发和部署过程中提供了最终边界。在大多数情况下，它们是矫枉过正的。另一方面，不可否认的是，项目会随着时间的推移而腐烂。即使是最精美的，重视模块化，如果没有持续的照顾，也一定会变得一团糟。

我们需要规则来强制执行边界，并且需要将它们视为测试：当测试失败时，必须修复它们。同样，当一个人违反规则时，他必须修复它。[ArchUnit][] 是一种创建和执行规则的工具。一个配置规则并将其作为测试进行验证。不幸的是，配置非常耗时，必须不断维护以提供价值。下面是遵循六边形体系结构原则的示例[应用程序][Link 4]的代码片段：

HexagonalArchitecture.boundedContext("io.reflectoring.buckpal.account")
                         .withDomainLayer("domain")
                         .withAdaptersLayer("adapter")
                         .incoming("in.web")
                         .outgoing("out.persistence")
                         .and()
                             .withApplicationLayer("application")
                             .services("service")
                             .incomingPorts("port.in")
                             .outgoingPorts("port.out")
                         .and()
                             .withConfiguration("configuration")
                             .check(new ClassFileImporter()
                             .importPackages("io.reflectoring.buckpal.."));

请注意，该类是 ArchUnit API 上的自定义 DSL 外观。`HexagonalArchitecture`

总的来说，ArchUnit总比没有好，但只是勉强如此。它的主要好处是通过测试实现自动化。如果可以自动推断出架构规则，它将大大改善。这就是Spring Modulith项目背后的想法。

### 弹簧模量 ###

Spring Modulith是Oliver Drotbohm的[Moduliths项目的][moduliths]继任者（带有尾随S）。它同时使用ArchUnit和[jMolecules][]。在撰写本文时，它*处于实验阶段*。

弹簧模量允许：

*  记录项目包之间的关系
 *  限制某些关系
 *  在测试期间测试限制

它要求一个人的应用程序使用Spring Framework：它利用后者对前者的理解，通过DI组装获得。

默认情况下，Modulith 模块是与 -annotated 类位于同一级别的包。`SpringBootApplication`

纯文本

*  1：应用程序类
 *  2：模数模块
 *  3：不是模块

默认情况下，模块可以访问任何其他模块的内容，但无法访问其他模块的子包。

[C4][]

var modules = ApplicationModules.of(DummyApplication.class);
    new Documenter(modules).writeModulesAsPlantUml();

若要在模块访问常规包时中断生成，请在测试中调用该方法。`verify()`

var modules = ApplicationModules.of(DummyApplication.class).verify();

### 要玩的样本 ###

我创建了一个[示例应用程序][Link 5]：它模拟在线商店的主页。主页是使用 Thymeleaf 在服务器端生成的，并显示目录项和新闻源。后者也可以通过 HTTP API 访问客户端调用（我懒得编码）。商品以价格显示，因此需要定价服务。

每个功能（页面、目录、新闻源和定价）都位于一个包中，该包被视为 Spring 模块。Spring Modulith的文档功能生成以下内容：

![在这里插入图片描述][c54f5037f7e941e0a5240025bb42deb2.png_pic_center]

让我们检查一下定价功能的设计：

![在这里插入图片描述][e62c297f5b12458395cd9a8c86d55eaa.png_pic_center]

当前的设计有两个问题：

*  可在模块外部访问`PricingRepository`
 *  泄漏 JPA 实体```PricingService``Pricing```

我们将通过封装不应公开的类型来修复设计。我们将 and 类型移动到模块的子文件夹中：```Pricing``PricingRepository``internal``pricing```

![在这里插入图片描述][2c597b24be794cb390bfbcb7764629a4.png_pic_center]

如果我们调用该方法，它会抛出并破坏构建，因为无法从模块外部访问：```verify()``Pricing``pricing```

Module 'home' depends on non-exposed type ch.frankel.blog.pricing.internal.Pricing within module 'pricing'!

让我们通过以下更改来修复违规：

![在这里插入图片描述][e2f6590b190e40c4b248f991e67df2ee.png_pic_center]

### 结论 ###

通过玩弄一个示例应用程序，我确实喜欢Spring Modulith。

我可以看到两个突出的用例：记录现有应用程序和保持设计“干净”。后者避免了应用程序随着时间的推移而出现的“腐烂”效应。这样，我们可以保持设计符合预期并避免意大利面条效应。

锦上添花：当我们需要将一个或多个[功能][Link 6][切入][Link 7]他们的部署单元时，这很棒。这将是一个非常直接的举动，不会浪费时间来解开依赖关系。Spring Modulith提供了一个巨大的好处：**将每一个有影响力的架构决策推迟到最后一刻。**

感谢Oliver Drotbohm的评论。

您可以在 GitHub 上找到源代码。

#### **走得更远** ####

*  [弹簧模量简介][Link 8]
 *  [快速入门][Link 9]
 *  [参考文档][Link 10]

[Spring Modulith_ Have We Reached Modularity Maturity]: https://dzone.com/articles/spring-modulith-have-we-reached-modularity-maturit
[Link 1]: https://martinfowler.com/articles/microservice-trade-offs.html#boundaries
[Oliver Drotbohm]: https://twitter.com/odrotbohm
[moduliths]: https://github.com/moduliths/moduliths
[Link 2]: https://en.wikipedia.org/wiki/Compartment_%28ship%29
[OSGi]: https://www.osgi.org/
[Link 3]: https://blog.frankel.ch/update-state-java-modularization/
[ArchUnit]: https://www.archunit.org/
[Link 4]: https://github.com/thombergs/buckpal
[jMolecules]: https://github.com/xmolecules/jmolecules
[C4]: https://c4model.com/
[Link 5]: https://github.com/ajavageek/spring-modulith-sample
[c54f5037f7e941e0a5240025bb42deb2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/e76ad0eeac224156ab4b66f22e41b819.png
[e62c297f5b12458395cd9a8c86d55eaa.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/ea817bd6e0e946ae967527340266c2ee.png
[2c597b24be794cb390bfbcb7764629a4.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/7b621b1332774cd29d33377d3d5ac5f1.png
[e2f6590b190e40c4b248f991e67df2ee.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/e214a0fa5d2c4e838d101d2760103512.png
[Link 6]: https://dzone.com/articles/chopping-the-monolith-the-demo
[Link 7]: https://dzone.com/articles/chopping-the-monolith
[Link 8]: https://spring.io/blog/2022/10/21/introducing-spring-modulith
[Link 9]: https://spring.io/projects/spring-modulith
[Link 10]: https://docs.spring.io/spring-modulith/docs/0.1.0-M1/reference/html/