代码简洁性

推理与选择

2020年8月7日作者：Max Kanat-Alexander

任何软件系统最重要的特性之一就是能够在无需运行的情况下理解它将做什么。这个概念通常被称为"对系统进行推理"的能力。基本上，你希望能够在不先看到系统运行的情况下，对系统的结构、行为和结果做出陈述。

为了理解为什么这很重要，想象一个有100个不同部件的系统。为了简化，我们假设这是一个实际的物理系统，而不是计算机。假设我们有一个生产汽车的自动化工厂，从原材料到成品车有100个步骤。每个部件都对输入材料进行某种改变以产生输出产品。

我们可以通过多种方式配置这个系统及其每个部件：我们可以让每个部件执行多个动作，根据采取的动作不同，我们选择的下一个机器实际上也不同。例如，假设我们正在将金属转换为圆棒。每辆车需要不同数量的圆棒，我们的圆棒可以由5种不同的金属制成。所以机器有一个程序，每次收到钢条时决定制造哪种圆棒。这取决于一天中的时间和当前对我们汽车的需求。然后，根据制造的圆棒类型，该圆棒会进入五个不同下一机器中的一个。

现在想象整个系统中的每台机器都是这样——它接受一组复杂的输入，产生一组可能的复杂输出，这些输出又进入一组可能的复杂下一机器。不仅人类不可能在任何给定时间对整系统的确切行为做出陈述（即推理），甚至对单个部件的行为进行推理也会很困难。

现在想象一个不同的设置，其中每台机器接受一个输入，提供一个输出，每台机器只与另一台机器"对话"（即它的输入总是来自一个特定的机器，它的输出总是去往另一个单一机器）。虽然一次性思考整个系统可能很困难，因为它仍然有100台机器，但查看每个单独的部件很容易，并从中推理出单个部件和整个系统的逻辑行为。

这是简洁性的核心部分——能够对这样的系统进行推理。当你查看软件系统的任何单个部件时，你应该能够在不运行该部件的情况下对其行为、保证、结构和潜在结果做出陈述。应该清楚该部件如何与系统的其余部分交互——要么我们应该确切知道什么调用它以及它调用什么，要么我们应该理解创建该部件使用边界的结构。

例如，这就是为什么许多编程语言中"私有"和"公共"函数的概念增强了系统推理能力——它们是告诉我们什么可能发生和什么不可能发生的边界。当你看函数或类的实际实现时，应该能够通过阅读代码和注释轻松理解它正在采取的动作。例如，这就是为什么命名对函数和变量如此重要——因为良好的命名允许读者推理系统的行为和边界。

选择

不过，要使系统具备这种品质，还有另一个非常重要的组成部分。为了解释这部分，想象我们假想汽车工厂中的每台机器不是自动化的，而是由一个人操作。这更像是一个软件工程师在输入实际代码，“运行"他们的IDE、计算机、编译器、编程语言等机器。

在我们第一个例子中，有做出复杂决策的复杂机器，想象所有自动化机器之前做出的选择，现在必须由人类做出。也就是说，每次一块金属进入我们的机器时，一个人必须查看它，决定它是什么类型的金属，决定制造什么棒材，所有这些都基于查找当前汽车需求并注意时间。在真实工厂中，其中一些可能实际上是可以接受的。至少它为一个人创造了一个有趣的工作。但即使在那里，你也可以看到你会为许多错误和不良结果打开大门。

将其与我们后一个例子进行比较，在那里我们有简单的机器，具有简单的输入和输出。它们对一个人来说操作起来如此简单，以至于你可能可以让一个人操作多台机器，并且你几乎消除了所有错误或不良结果的可能性。

现在考虑到在编程中，程序员通常操作数十或数百个这样的"机器”，就他们维护的类和函数而言。所以对复杂汽车工厂的更好类比是让一个人操作所有一百台机器。如你所见，如果系统的每个部分向操作员提供太多必须做出的决定，制造我们的"汽车"很快变得不可能。即使你能做到，你制造汽车的速度也会非常慢，并且会让操作机器的人精疲力尽。瞧，这正是必须维护具有那种复杂度的软件系统的团队所发生的情况。

不过，当我们将人类添加到我们的"工厂"时，我们引入的关键点是什么？我们引入了决策（人类用头脑做的事情）和选择（呈现给人类的选项）的因素。

有些思想流派认为，所有开发人员应该始终被授权对其软件系统做出所有可能的决定。这听起来很棒，因为它听起来像是为聪明人提供智力自由——这是我们所有人都想要的。然而，如果你把这个原则推得太远，你实际上会为你的开发人员创造复杂的汽车工厂——一个系统中有如此多的选择要做出，以至于他们要么变得瘫痪，要么保证做错，要么开发出其他人难以理解的极其不一致的系统。

那么这里的解决方案是什么，是消除所有人的所有选择，让他们成为执行你首席架构师意志的无意识自动机吗？嗯，我确信有一些软件架构师会喜欢那样，但实际上，这是一个有点极端的解决方案。答案是转而认识到哪些选择对开发人员能够做出很重要，哪些不重要。

这取决于你在软件团队中的角色以及你在软件生命周期中所处的阶段。例如，如果你刚刚创办一家新公司并且你是第一个开发人员，你能够选择公司将在其上运行的基本平台的几乎所有内容——你使用的语言、框架、库等——这很重要。但即使在那时，你也不希望那些框架和库向你呈现你不需要做出的决定。想象一下，如果编译器停下来问你它应该如何优化每段代码。这会帮助你或提高你的生产力吗？这实际上对你公司或你试图实现的目标是净收益吗？我不这么认为。

然后，在项目生命周期的不同阶段，一旦你已经标准化了你正在使用的语言和特定框架，你通常不会允许随机初级开发人员为你的代码库的他们的部分选择不同的语言或框架。这是一个他们不需要花时间做出的决定——对他们来说，随波逐流更有效率。即使有更好的语言或框架他们可以使用，重写你的整个系统只是为了实现这个初级开发人员的一个功能似乎不是对你资源的良好利用。

总的来说，如果你能消除开发人员不需要拥有的足够多的选择，你实际上可以在整个公司范围内节省相当多的开发人员时间。想象一下，如果你公司中的每个团队在开始开发系统之前必须花两周时间审查不同的框架。现在想象你标准化了一个好的框架（也就是说，它能够满足所有将要使用它的人的所有业务需求）即使不完美，没有人必须再做那个决定。你为整个公司节省了多少工程时间？这是巨大的——从长远来看，比你几乎任何其他生产力改进都要大。

现在，重要的是要记住，有些决定是开发人员需要做出的。他们绝对需要能够决定他们系统的业务逻辑如何运作——这是他们能够完成工作的核心要求。过去有一些框架和库根本不允许人们实际编写他们需要的系统，这是对生产力有害的限制级别。例如，想象你的公司标准化了一个支持HTTP但基本上不支持SSL（即没有HTTPS）的框架。当你为了安全目的需要加密连接时，那将是灾难性的。所以那将是一个非常糟糕的限制。

有时这是一条非常棘手的路线，但总的来说，我发现从长远来看，在删除选择方面犯错实际上让开发人员更快乐，因为它使他们更有效率。当你从人们那里拿走某些选择时，一开始非常困难，因为他们觉得你在影响他们的个人自由。在某种程度上，在短期内，你确实在这样做。但事实是，你正在试图提供更多的创造自由——开发人员实际上从根本上想要的那种自由。限制选择的目的应该始终是提高创建系统的能力。你不是在扼杀生产，而是在删除分散注意力、障碍和困惑，以某人根本不需要做出的选择的形式。

-Max

Steven Gordon, PhD 说： 2020年8月7日下午2:11

在实践中，几乎总是存在对不透明遗留子系统的一些依赖，这使得推理和选择目标在实践中完全实现不切实际。理论上很好的目标，但你需要足够的容错能力，以便不完全满足这些目标不会威胁导致你陷入欺骗性推理或选择政策过于僵化。

就推理而言，我宁愿有一套组织良好的自动化测试来理解，而不是整个代码库。自动化测试使得实际验证你推理所基于的假设变得微不足道，而不是被可能早已离开或隐藏在对不透明遗留子系统依赖的过于聪明的开发人员所困扰。

Max Kanat-Alexander 说： 2020年8月8日晚上11:54

我理解你在说什么，但我确实认为单个开发人员通常有能力实际使他们正在工作的系统部分足够简单以进行推理。底层平台的复杂性确实可能使这非常具有挑战性，特别是当它们设计时没有考虑这些原则时。但在实际应用中，可以设计系统的那些部分能够以合理准确性进行推理的系统。

即使是容错点理想情况下也涉及对系统进行推理的能力——它在错误条件下的行为。

能够通过测试对系统进行推理是可以的，这是一个非常有用的工具，我同意。它们在验证你所拥有的推理方面也做得很好，这是真的。但我希望代码本身，当你看它时，是预期读者能够推理的东西，并且当集成到更大系统中时，不会向用户呈现他们不需要做出的选择。

-Max

Kursith 说： 2020年10月10日上午12:33

然而现在一切都在自动化。我想知道工程师们做什么？这个博客对我很有帮助，技术正在通过人类的创造力成长。感谢分享知识。它确实使具有机械知识的软件开发人员受益。