布尔陷阱及如何避免

最近我接触到了布尔陷阱的概念，由于我因此进行了大量的谷歌搜索，这个概念立即引起了我的共鸣。在本文中，我将尝试解释它是什么，为什么它有点像反模式，如何在代码中发现它，并围绕它进行重构的方法。

布尔陷阱 - 名字中有何含义？

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

如果你坚持这个定义，名字中的陷阱可能会让你感到困惑，但它确实有其目的。让我们看两个简单的例子，以更好地理解这个概念：

// `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 的作用非常明显。请注意，之前的双重否定可能仍然使这个稍微难以阅读，但在这个上下文中使用布尔值是有意义的。为什么呢？嗯，它本质上是一个设置函数，传递属性的实际值并不是一个坏主意。

缓解问题

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

让我们来看一下之前的两个示例以及它们的工作方式：

// 好的，所以重新加载但不立即执行
results.reload({ immediate: false });

// 创建一个没有管理员权限的新用户
const user = new User({ isAdministrator: false });

在不对API进行大幅更改的情况下，我们可以完全避免布尔陷阱。我们只需要一个普通的JavaScript对象即可。这样做的额外好处是使函数在将来更易于扩展。对象非常灵活，因此如果我们想要添加第二个布尔值（例如reload的animate或User的active），我们只需向对象添加一个键。

顺便说一句，虽然注释似乎是一个合适的解决方案，但它们最终会变得过时，并且与API脱节。最好将这种信息留给官方文档或源代码。

结论

总结一下，如果使用不正确，函数中的布尔参数可能会导致大量浪费的时间，并降低代码的可读性。它们有时被认为是一种反模式，因为它们增加了认知负荷并降低了共享代码的可维护性。幸运的是，使用普通的JavaScript选项对象很容易发现和修复这个问题。