如何将布尔参数传递给函数以充当开关？

Question

如果标题不清楚，我深表歉意，但我觉得这很难描述。基本上，我有一个函数可以在给定班级 ID 号和日期的情况下查找班级（学校类型）的实例。如果需要，该函数还可以创建一个新的类实例。

function get_class_instance($class_id, $date, $create)

函数内部是对 class_instances 表的数据库选择，使用 class_id 和 date 作为参数。如果找到匹配的 class_instance，则返回其 ID。如果没有找到，则 create 参数有一个条件。如果为真，则使用数据库插入创建一个新的 class_instance，并返回其 ID。如果为 false，则数据库中没有任何更改并返回 false。

我仍然是 PHP 和编码的初学者，所以我认为可能有更好的方法。问题是在调用函数时，有人可能不清楚为什么要传递一个布尔值。

$original_cinstance_id = get_class_instance($original_class_id, $original_date, 1);

Answer 1

在Robert Martin 的Clean Code book 中将布尔标志传递给函数以使它们执行两件不同的事情而不仅仅是一件事情被视为Code Smell。建议的更好的选择是有两个函数get_whatever 和create_whatever。

虽然代码气味取决于上下文，但我认为布尔标志气味确实适用于这种情况，因为创建某些东西与仅仅阅读它是不同的。前者是命令，后者是查询。 So they should be separated。一个改变状态，另一个不改变。它有助于更​​好的语义和separation of concerns 拆分它们。此外，它会将函数的Cyclomatic Complexity 减少一个分支，因此您将需要更少的单元测试来覆盖它。

引用https://martinfowler.com/bliki/FlagArgument.html

布尔参数大声声明函数做不止一件事。它们令人困惑，应该消除。

引用http://www.informit.com/articles/article.aspx?p=1392524

我的理由是，单独的方法更清楚地传达了我拨打电话时的意图。当我看到book(martin, false) 时不必记住标志变量的含义，我可以轻松阅读regularBook(martin)。

其他讨论和阅读材料：

• https://softwareengineering.stackexchange.com/questions/147977/is-it-wrong-to-use-a-boolean-parameter-to-determine-behavior
• https://medium.com/@amlcurran/clean-code-the-curse-of-a-boolean-parameter-c237a830b7a3
• https://8thlight.com/blog/dariusz-pasciak/2015/05/28/alternatives-to-boolean-parameters.html

Answer 2

您可以使用默认值进行创建，因此如果您将任何内容传递给它，它将充当数据库的正常“获取”操作。像这样：

function get_class_instance($class_id, $date, $create = false);

您可以这样查询您的 ID：

$class_id = get_class_instance(1, "18-10-2017");

然后，您可以在需要在数据库上创建它时将“true”传递给它：

$class_id = get_class_instance(1, "18-10-2017", true);

Answer 3

您可以像这样传递一个真正的布尔值，而不是传递一个数字值：

$original_cinstance_id = get_class_instance($original_class_id, $original_date, true);

同样在你的函数声明中，你可以指定一个默认值来避免每次都传递布尔值：

function get_class_instance($class_id, $date, $create = false)

Answer 4

一种选择是像这样创建一个枚举器：

abstract class create_options {
    const no_action = 0;
     const create = 1;
}

所以现在你的函数调用看起来像这样：

$original_cinstance_id = get_class_instance($original_class_id, $original_date, create_options::no_action);

在实践中，只要您的代码被很好地注释，那么这不是布尔标志的主要问题，但是如果您有十几个可能的选项具有不同的结果，那么这可能会很有用。

正如其他人所提到的，在许多语言中，您还可以将参数设为可选，并具有默认行为，除非调用者明确定义了该参数。