建筑师的喜悦：使用 Nx 加强层和项目边界

我不是女神ヾ 2024-03-16 18:03 46阅读 0赞

### 介绍 ###

当我开始作为软件开发人员的旅程时，我深入研究了软件架构。诸如“Clean Architecture”和“Domain-Driven Design (DDD)”等著名书籍提供了对项目边界和软件层（垂直和水平）等概念的宝贵见解。然而，最缺少的是一种快速有效的工具来执行这些原则。

然后，我发现了 Nx，特别是它的`@nx/enforce-module-boundaries`ESLint 插件，它彻底改变了我执行这些边界的方式。

### 冰山的隐藏面 ###

有趣的是，虽然`@nx/enforce-module-boundaries`ELLint 插件嵌入在每个集成的 Nx-Monorepo 的生成代码中，但当谈话转向 Nx 的优点时，它似乎在雷达之下飞行，这些优点确实很多。甚至 Nx 的视频“The Nx Iceberg”也没有提及它，尽管它着重介绍了该工具鲜为人知的功能。

包括 Manfred Steyer、[Lars Gyrup Brink Nielsen][]和我在内的几位作者都深入研究了这个主题。尽管如此，许多使用 Nx 的开发人员并没有尽可能多地利用此功能。这激发了我写这篇文章来强调 Nx 在执行项目边界方面的力量。

### 什么是项目边界和层？ ###

在我们深入研究强制执行项目边界之前，了解它们是什么至关重要。这些规则或原则决定了我们软件的不同部分如何交互。

例如，软件架构师经常使用洋葱架构和干净架构等哲学来定义水平层。然后使用领域驱动设计中的战略设计等原则将这些层分组为垂直切片或边界。

但是，如果没有自动化工具，维护这些边界就会变得很棘手。开发人员可能会无意中跨越这些边界，从而导致可维护性和可扩展性问题。

### 使用 Nx 创建项目和边界 ###

首先，在我们开始执行边界限制之前，我们必须有项目和边界。Nx 通过其可快速创建应用程序和库的生成器简化了此过程。这是生成库的简单命令：

<code>nx generate @nrwl/js:library feature-booking
 </code>

但是缺少主要成分；Nx 项目标签在这里至关重要。它们充当我们边界的书面定义。例如：

<code>// project.json
 {
 ...
 "tags": ["bounded-context:booking", "type:feature"],
 ...
 }
 </code>

在当前示例中，我们基于包含库的限界上下文定义了一个垂直切片或垂直层：The **booking**限界上下文。不仅如此，我们还根据库的类型定义了一个水平层：**特征**类型。

![99c2d82b49a4c4d661f33eb25bfef202.png][]

此外，我们可以使用带有 Nx 的分组文件夹来进一步简化结构。我相信标签和分组文件夹之间应该有直接联系。我在我的文章[“使用 Nx 对文件夹进行语义分组”中广泛讨论了这些模式。][Lars Gyrup Brink Nielsen]

### 使用 Nx 强制执行项目边界 ###

有了我们的项目和边界，我们可以利用 Nx `@nx/enforce-module-boundaries`ESLint 插件的强大功能来设置层之间的限制。

**例如，如果我们想限制它，属于预订**限界上下文的库只能从相同的限界上下文导入库。或者换句话说，如果我们想要强制执行由限界上下文标签定义的垂直边界，我们可以执行以下操作：

![df83f73552985f866516152d5d823a91.png][]

我们的水平层也可以这样做。在以下示例中，我们将执行以下操作：

*  具有类型**特征的**库只能导入具有类型**特征**、**域**、**用户界面的库**
 *  **ui**类型的库只能依赖**ui**类型和**域的库**
 *  **domain**类型的库只能依赖**domain**类型的库。

<code> "@nx/enforce-module-boundaries": [
 "error",
 {
 "enforceBuildableLibDependency": true,
 ...
 "depConstraints": [
 ...
 {
 "sourceTag": "type:feature",
 "onlyDependOnLibsWithTags": ["type:feature", "type:domain", "type:ui"]
 },
 {
 "sourceTag": "type:ui",
 "onlyDependOnLibsWithTags": ["type:domain", "type:ui"]
 },
 {
 "sourceTag": "type:domain",
 "onlyDependOnLibsWithTags": ["type:domain"]
 },
 ...
 ]
 }
 ]
 </code>

有了这些限制，如果您尝试导入一个打破这些强制边界之一的库，您将收到 ESLint 错误。这是一个假设情况：

<code>// File: libs/boundary/domain/types.ts
 import { Button } from '@my-org/ui';
 </code>

<code>error A project tagged with "type:domain" can only depend on libs tagged with "type:domain" @nx/enforce-module-boundaries
 </code>

此错误消息表示我们试图跨越边界，从而帮助我们维护架构的完整性。

这还不是全部；我们甚至可以按照[文档][Link 1]中的描述限制外部导入。我找到了这个。该工具在使用类似 React、Qwik 和 SolidJS 的技术时非常有用；甚至像 Angular 和 NestJS 这样的后端和前端。

### 结论 ###

轻松实施项目边界和层次是我认为太过分的梦想。

Nx 的`@nx/enforce-module-boundaries`ESLint 插件提供了一个强大的解决方案。我们越了解它的潜力并学会利用它的力量，我们就越会朝着创建健壮、可扩展和可维护的软件解决方案的方向努力。Nx 真正引领

[Lars Gyrup Brink Nielsen]: https://zhifj.com
[99c2d82b49a4c4d661f33eb25bfef202.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f075433f78b040ad8ca9917b678ec071.png
[df83f73552985f866516152d5d823a91.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/6ec8fb52456e464f905bbd59da1a31d9.png
[Link 1]: http://telegeram1.com