What is a magic number, and why is it bad? [closed]

by

A magic number is a direct usage of a number in the code.

For example, if you have (in Java):

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

This should be refactored to:

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");
         }
    }
}

It improves readability of the code and it’s easier to maintain. Imagine the case where I set the size of the password field in the GUI. If I use a magic number, whenever the max size changes, I have to change in two code locations. If I forget one, this will lead to inconsistencies.

The JDK is full of examples like in Integer, Character and Math classes.

PS: Static analysis tools like FindBugs and PMD detects the use of magic numbers in your code and suggests the refactoring.

More Related Contents:

  1. What is the difference between currying and partial application?
  2. What is Type-safe?
  3. Difference between parameter and argument [duplicate]
  4. Making a system call that returns the stdout output as a string
  5. Arguments or parameters? [duplicate]
  6. What is a Lambda?
  7. What’s the term for the part of the URL after the question mark?
  8. What are “magic numbers” in computer programming?
  9. What is dependency injection?
  10. Expression Versus Statement
  11. Why should hash functions use a prime number modulus?
  12. Prefer composition over inheritance?
  13. Singletons: good design or a crutch? [closed]
  14. How to explain callbacks in plain english? How are they different from calling one function from another function?
  15. Test loops at the top or bottom? (while vs. do while) [closed]
  16. Solving “Who owns the Zebra” programmatically?
  17. Try to describe polymorphism as easy as you can [closed]
  18. Pass by reference or pass by value? [closed]
  19. How do I assess the hash collision probability?
  20. When to use unsigned values over signed ones?
  21. When is it okay to check if a file exists?
  22. Private vs. Public members in practice (how important is encapsulation?) [closed]
  23. Why is writing a closed TCP socket worse than reading one?
  24. How to deal with constructor over-injection in .NET
  25. How to calculate distance from a point to a line segment, on a sphere?
  26. Followup: Finding an accurate “distance” between colors
  27. Is bit shifting O(1) or O(n)?
  28. How to design extensible software (plugin architecture)? [closed]
  29. XOR of three values
  30. String Compare “Logic”

Leave a Comment