Code Smell 07 - Boolean Variables

22 September, 2022

Contributors

Maxi Contieri

@mcsee

Using boolean variables as flags, exposes accidental implementation and pollutes the code with Ifs.

TL;DR: Don't use boolean variables, they force you to write Ifs. Create polymorfic states instead.

Problems

•

Extensibility

•

Comparison in some languages

Solutions

•

If Boolean maps to a real world entity is safe. Otherwise, model as a State to favor Extensibility. This also follows Open/Closed Principle.

Examples

•

Flags

Sample Code

Wrong

Right

Detection

Automatic detection can warn for boolean usage, but this can yield false positives.

Exceptions

•

Real world true/false rules

Relations

Some languages have issues with boolean comparators.

In these coupled with accidental complexity languages, booleans are a common error source.

More info

New Title

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

Conclusion

Take extra care when declaring something boolean. Flags are difficult to maintain and extend. Learn more about the domain. Try migrating to state design pattern. Use polymorphism instead of ifs/switch/cases.

Also Known as

•

Flag Abuser

Credits

Photo by Phil Hearing on Unsplash

These tweets inspired this code smell:

This article is part of the CodeSmell Series.

https://maximilianocontieri.com/how-to-find-the-stinky-parts-of-your-code

refactoring

code

cleancode

smells