何时使用常量作为参数而不是魔法值

Question

我读过（并且普遍同意），为了提高代码的可读性，您应该使用常量而不是幻数作为方法参数。例如，使用 PHP：

// no constants ////////////////////
function updateRecord($id) {
    if ($id == -1) {
        // update all records
    } else {
        // update record with "id = $id"
    }
}

updateRecord(-1); // future maintainer says: "wtf does -1 do?"
                  // and then has to jump to the function definition

// with constants: /////////////////

define('UPDATE_ALL', -1);

function updateRecord($id) {
    if ($id == UPDATE_ALL) {
        // update all records
    } else {
        // update record with "id = $id"
    }
}

updateRecord(UPDATE_ALL); // future maintainer says: "woot"

_{是的，这不是一个很好的例子，我知道...}

所以，我可以看到这是一个更好的事情，但它提出了一个问题您应该多久执行一次此操作？如果它适用于每个函数，那么您最终会得到大量的常量定义。

你会在哪里划清界限？始终坚持使用常量而不是幻数，还是根据相关函数的使用情况采取混合方法？

Answer 1

所以，我可以看出这是一件更好的事情，但它提出了一个问题：您应该多久这样做一次？如果它适用于每个函数，您最终会得到大量的常量定义。

如果每个函数都采用“神奇参数”，那么你就已经做错了。

我总是使用常量。如果您认为这意味着您有太多常量，那么这只是反映了您设计中的其他缺陷。

Answer 2

正如您已经指出的，未来的维护者将感谢您清晰的命名。这个维护者甚至可能是你，我一次又一次地惊讶于我忘记了我自己的代码，并且当我有一段时间没有处理它时再次理解它是多么困难。

只要范围大于单个简短方法，我肯定会一直使用常量。一旦开始传递这些值，恕我直言，它们必须被定义为常量。在方法内部，注释可能会起作用。然而，这并不能帮助任何看不到该注释的代码调用者。即使同一类中的另一个方法也应该被视为“API 客户端”，它不应该知道它在这方面调用的其他方法的实现细节。

使用支持“真实”枚举的语言（例如 Java 5 中引入的 Java enum 关键字），您甚至可以获得类型安全性，并且不会面临基于整数的常量等可能出现的唯一性问题的风险。

Answer 3

我会在需要的地方使用它..

• 提高可读性
• 可以帮助您记住
• 让您一目了然您作为参数传递的内容

以 PHP 的 sort() 例如。这是有道理的：

sort($array, SORT_NUMERIC);

但这会吗？

sort($array, 2); // Haven't actually dug in to see what it matches, but you get the point

Answer 4

如果你将东西包装在类中并且使用类常量，那么这就不是什么问题了。除了事物路径之外，我很少使用全局常量。

Answer 5

您应该尝试将代码中的文字保持在绝对最低限度：每个文字都是一个潜在的问题，因为您的环境可能会发生变化，并且其他开发人员可能不知道它的含义。

当我开始一个项目时，我总是专用一个仅用于命名常量的文件，通常包装在专用于此类的类中，并且我自由地使用它们，因为我的工作性质需要它。所有命名常量都驻留在该文件中，并由该文件进行控制，从而为您提供对命名常量的出色组织和控制。您还可以使用注释或代码区域将它们组织成组，并根据语言进行嵌套和构建。

这种做法多年来对我帮助不已。