我最近遇到了布尔陷阱的概念，在本文中，我将尝试解释它是什么，为什么它在某种程度上是一种反模式，如何在代码中发现它以及围绕它进行重构的方法。

布尔陷阱 - 名字里有什么？

虽然布尔陷阱这个名字对某些人来说可能不熟悉，但我很确定它所代表的概念并不陌生。布尔陷阱的最简单形式是接受布尔参数的函数。

如果我们坚持这个定义，名字中的陷阱可能会让我们失望，但它达到了它的目的。让我们看两个简单的例子来更好地理解它：

// `false`代表什么？

results.reload(false);

//`true`代表什么？

const user = new User(true);

由于矛盾很明显，第一个示例在可读性方面受到影响。一个名为reload的函数需要一个布尔参数。false情况下，肯定意味着不应该发生重新加载，除非情况并非如此。这个论点可能是从立即执行操作（即immediate）到某些副作用（例如动画）甚至是我们怀疑的无操作。过去，我在许多图书馆中偶然发现了类似的模棱两可的论点。

如果不查看一些文档，第二个示例也很难破译。在这里，构造函数需要一个布尔参数，它可能意味着任何字面意思。我们是否已经猜到这是一个指示用户是否应该具有管理权限的标志？也许可能不是。关键是如果不查看文档，就无法说出这个论点的含义。

红旗还是红鲱鱼？

此时，我们可能会问自己为什么，这实际上很糟糕。预计我们会通读文档才能理解它的含义。毕竟，这就是它的目的。如果您正在使用开源库并一遍又一遍地在文档中查找布尔参数说明，因为它并不明显，这会变得有点麻烦。

此外，代码被许多人多次阅读。作者可能熟悉开源库和 API，完全不需要文档。但是下一个出现的人将不得不访问相同的文档并自己弄清楚它的含义。由于一个布尔参数，从长远来看，这会损害可读性并浪费我们大量时间。

这里的一个优点是通过增加认知负荷进一步降低可读性的潜力。布尔参数有一些有效的用例，但在某些情况下，函数的名称本身是负数，具有负（即假）值会使读者停下来分析正在发生的事情。例如：

//很快：这是有效的还是无效的？

input.setInvalid(false);

并非所有布尔值都会让您陷入困境。

与大多数事情一样，这里没有通用的最佳实践。尽管我经常发现布尔参数难以阅读，但我知道在某些情况下您可能想要使用它们。

//很明显，`true` 使元素被禁用

element.setProperty('disabled', true);

// 可能相当于

`element.disabled = true;`

在这个例子中，true做什么很简单。注意，之前的双重否定可能仍然会有点难以阅读，但在这种情况下使用布尔值是有意义的。为什么？它本质上是一个 setter 函数，传递属性的实际值并不是一个坏主意。

缓解问题

我们已经确定了布尔陷阱是什么以及它为什么不好。但是我们该如何解决呢？即使我们能够发现反模式，在它影响到大量代码和开发人员之前，也可能很难对其进行更改。一些语言支持命名参数，这通常很容易解决问题。另一方面，JavaScript 没有，但总是可以选择传递选项对象。

让我们看一下之前的两个示例以及它是如何工作的：

//重新加载但不是立即

results.reload({ immediate: false });

//创建没有管理员权限的新用户

const user = new User({ isAdministrator: false });

如果不对 API 进行重大更改，我们本可以完全避免布尔陷阱。我们所需要的只是一个普通的 JavaScript 对象。这还具有使该功能在未来更具可扩展性的额外好处。对象非常灵活，所以如果我们想添加第二个布尔值（例如animateforreload或activefor User），我们只需要为对象添加一个键。

附带说明一下，虽然注释似乎是一个合适的解决方案，但它们不可避免地会变得陈旧并且与 API 脱节。最好将此类信息留给官方文档或源代码。

结论

总而言之，函数中的布尔参数可能是浪费我们大量时间的根源，如果使用不当，也会导致代码可读性低。它们有时被认为是一种反模式，因为它们会增加认知负担并降低共享代码的可维护性。幸运的是，使用纯 JavaScript 选项对象很容易发现和修复它们。