language-agnostic - 什么是神奇数字，为什么它不好？

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。 .

已关闭 4 年前。

Improve this question

什么是魔数(Magic Number)？

为什么要避免它？

是否存在合适的情况？

Answer 1

魔数(Magic Number)是在代码中直接使用数字。

例如，如果您有(Java):

public class Foo {
    public void setPassword(String password) {
         // don't do this
         if (password.length() > 7) {
              throw new InvalidArgumentException("password");
         }
    }
}

这应该重构为:

public class Foo {
    public static final int MAX_PASSWORD_SIZE = 7;

    public void setPassword(String password) {
         if (password.length() > MAX_PASSWORD_SIZE) {
              throw new InvalidArgumentException("password");
         }
    }
}

它提高了代码的可读性并且更易于维护。想象一下我在 GUI 中设置密码字段大小的情况。如果我使用魔数(Magic Number)，每当最大大小发生变化时，我都必须在两个代码位置进行更改。如果我忘记了，这将导致不一致。

JDK 中充满了诸如 Integer、Character 和 Math 类中的示例。

PS:FindBugs 和 PMD 等静态分析工具会检测代码中魔数(Magic Number)的使用并提出重构建议。