【早阅】如何编写复杂的软件

作者：@Grant Slatton
原文：https://grantslatton.com/how-to-software

背景

本文探讨了如何开发复杂软件系统，提出了一种从顶层到底层的分层开发方法。作者建议通过编写微型驱动程序来了解物理约束，并从用户界面或 API 开始，逐步向下实现每一层，同时定义下一层的 API。这种方法强调在开发过程中保持代码的可读性和模块化，并建议仅在涉及 IO 操作的部分使用模拟接口。

【第3436期】再见Postman，你好Insomnia：更快的 API 测试方式

从顶层到底层的分层开发方法步骤

其主要步骤如下：

1、界定问题

• 首先通过编写简单的测试程序来了解硬件的性能限制，例如数据库每秒能处理多少请求、硬盘读写速度、CPU 每秒能计算多少校验码等。

• 在实际编写任何软件之前，我们想找到可能的解决方案空间的界限。你应该编写一些微型基准测试程序来找到这些问题的答案。

2、自顶而下

• 从软件的最顶层开始，例如用户界面或 API。

• 我提出的方法正好相反。你从堆栈的顶部开始编码，让每一层定义下一层的 API。

3、分层实现

• 将软件分层实现，每层只处理必要的逻辑，并将其余复杂性委託给下一层。

• 你的软件的每一层都应该易于阅读。如果它不易读，这意味着它剥离了太多的逻辑。

4、定义接口

• 在编码某一层时，将下一层的 API 定义为实现当前层所需的完美领域特定语言 (DSL)。

5、填充下一层

• 在编码当前层时，填充下一层的 stub。

• 一旦你编码了一层，你需要实现你想像的 API。你应该从简单地填充它们开始。

6、递归实现

• 当前层完成后，递归地使用相同方法实现下一层。

7、IO 抽象化

• 只为执行 IO 的代码部分实现可模拟的抽象接口，其他所有部分都应该是具体的。

问题

1、如何开始构建复杂的软件项目？

• 首先，通过编写一些小型测试程序，了解你的解决方案空间的物理限制。例如，如果你正在构建数据库，测试每秒可以解析多少请求，磁盘可以处理多少次读写，CPU 每秒可以计算多少次校验和等等。

• 接下来，从软件栈的顶层开始，通常是用户界面或 API。

• 将你的软件实现为多层结构，每一层只剥离最少的逻辑，并将剩馀的複杂性委託给下一层。

• 在编写每一层时，将下一层的 API 定义为实现当前层的完美领域特定语言。

• 在编写当前层时，先将下一层的代码填充为占位符。

• 当前层完成后，递归地使用相同的方法实现下一层。

• 持续这个过程，直到完成整个软件。

• 只为执行 I/O 操作的代码部分实现可模拟的抽象接口，其他所有代码都应该是具体的。

2、什么时候应该使用这种方法？

当你构建的软件项目规模很大，不可避免地需要数万甚至数十万行代码时，这种方法才适用。对于小型软件项目，例如少于 5000 行代码的项目，使用单个文件和最小化抽象可能更有效率。

3、为什么要从顶层开始，而不是从底层开始？

从底层开始构建软件的缺点是，你在编写上层代码之前就锁定了底层的设计。当你实现上层时，你可能会发现底层 API 并不完美，但你却不愿意修改它，因为你已经花了很多时间来实现它。

从顶层开始，让每一层定义下一层的 API，可以确保每一层的 API 都完美地满足上层的需求。此外，这种方法还可以在开发过程中始终保持一个半可运行的软件，方便展示和测试。

4、如何实现一个软件层？

每个软件层的代码应该易于阅读。如果它不易读，则意味著它剥离了太多的逻辑。

在编写代码之前，先假设下一层的 API 已经存在，并以最佳的方式使用它来实现当前层的功能。

然后，再开始实现下一层的 API。

5、如何填充下一层的代码？

最初，你可以使用简单的占位符来填充下一层的代码，例如返回固定值，抛出异常或直接崩溃。

随着开发的进展，你可以使用更完整的 mock 对象来填充下一层，例如模拟数据库查询或文件读写操作。
尽量减少在实现占位符和 mock 对象上花费的时间，因为你很快就会实现真正的代码。

6、什么时候应该使用真正的 mock 对象？

只有在测试 I/O 操作时才需要使用真正的 mock 对象。例如，在测试数据库时，你可以使用 mock 对象来模拟底层数据存储层，例如硬盘或文件系统。这样可以使测试快速且确定性，避免网络调用或其他不确定因素的影响。

7、如何进行团队合作？

一旦你开始了这个过程，就可以很自然地让不同的人实现不同的 API。
每个软件层通常都有多个子层，每个子层都可以分配给不同的工程师进行开发。

这种方法需要项目开始时由一名开发人员负责编写最顶层代码，但这也有好处，因为它可以为整个项目设定基调。

8、使用这种方法可能遇到哪些陷阱？

有时你可能会以无法实现的 API 来编写某一层代码。

如果发生这种情况，不要强迫它工作或调整代码，而是应该删除代码，回溯到上一层，并使用新的 API 重新实现该层。

9、分层的优缺点

“分层” 方法指的是将软体分解成多个层级，每一层都负责处理特定的一部分逻辑，并将其余的性委託给下一层。这种方法有以下优点：

• 始终拥有可运作的软体：由于是从顶层开始开发，所以开发者总是有可以展示或测试的半成品软件。

• 每一层的 API 都完美符合需求：从顶层开始，让每一层定义下方一层的 API，可以确保每一层的 API 都完美符合上一层的需求。

• 易于协作：每个子层都可以委派给不同的工程师开发，提高效率。

然而，这种方法也有一些缺点：

• 需要花时间实现存根和模拟：在开发过程中，需要花费一些时间来实现虚拟的佔位符实现。

• 可能需要回溯修改：在极少数情况下，可能会遇到无法实现的 API，需要回溯到上层修改。

总体而言，“分层” 方法是一种有效开发复杂软体的方法，但开发者需要根据实际情况权衡其优缺点，并灵活运用。

分析

本文提出的方法与传统自底向上的开发方式形成鲜明对比。传统方法通常从底层基础设施开始，逐步向上构建，但这种方法容易导致设计僵化，难以适应上层需求的变化。而本文建议的自顶向下方法则更具灵活性，允许开发者在实现每一层时根据实际需求定义下一层的 API，从而避免过早锁定设计。

此外，本文强调了模拟和占位实现的重要性。通过使用简单的占位实现，开发者可以快速验证上层逻辑，而无需等待底层功能的完全实现。这不仅提高了开发效率，还使得团队能够并行工作，从而加速项目进展。

然而，这种方法也存在一些挑战。例如，开发者可能会设计出难以实现的 API，或者在分层过程中引入不必要的复杂性。因此，作者建议在遇到问题时及时回溯并重新设计，而不是强行推进。

影响

这种自顶向下的开发方法对软件工程实践具有重要影响。它鼓励开发者更加关注用户体验和需求，而不是过早陷入技术细节。这种方法特别适用于大型复杂项目，尤其是在团队协作和快速迭代的场景中。

此外，随着人工智能和大型语言模型（LLM）在软件开发中的应用日益广泛，这种分层开发方法可能为 AI 驱动的开发工具提供新的思路。通过将复杂任务分解为更小的模块，AI 可以更高效地生成和优化代码。

结论

本文提出的自顶向下分层开发方法为复杂软件系统的构建提供了一种灵活且高效的策略。它强调从用户需求出发，逐步向下实现每一层，并通过模拟和占位实现加速开发进程。尽管这种方法需要开发者具备较高的设计能力和经验，但其在大型项目中的优势显而易见。未来，随着 AI 技术的进一步发展，这种方法可能会在自动化软件开发中发挥更大的作用。

😀 每天只需花五分钟即可阅读到的技术资讯，加入【早阅】共学，可联系 vx：zhgb_f2er

5 分钟技术速览：了解技术资讯的一种方式。

🚀可直接通过阅读原文了解详细内容。