Improve Your Software Design with The CheckAndDo Pattern ๐
Improve Your Software Design with The CheckAndDo Pattern ๐
Abdulcelil Cercenazi
Why another design pattern? ๐
It is a widely common task in Software to perform tests on an object and obtain the result of this process.
In Other Words โ๏ธ
Letโs imagine a pipeline of checks that an entity has to pass before being persisted to a database.
On every step, we want to return the reason for the check failure, if it does. Otherwise, we want to proceed to the next check.
A Real Life Example
Letโs write a function to verify that a given password ๐ meets certain criteria.
Length should be between 8 and 14 characters.
Should have at least one upper case character and one lower case character.
Should have at least 2 digits.
Should have at least one special character.
Typical Solution ๐ก
Letโs do it using Java code
What was wrong with it? ๐ฉ
The implementation above has many flaws, however, the most important two are:
Breaks the single responsibility principle, as this function does more than one check (six ones to be exact).
The function checkPasswordAndSubmit is about 20 lines long, which can be shorter if implemented correctly.
H3he checkAndDo pattern way ๐ข
We add a chain of check functions, each one tests a single aspect.
Note the naming convention of the functions check_*And_ where:
- * is the current check we are performing.
- ** is the final action we want to be done. For example checkPassWordLengthAndSubmit checkPassWordCaseSensitivityAndSubmit checkThatTwoDigitsAreGivenAndSubmit checkThatSpecialCharactersAreGivenAndSubmit
So, should you use this pattern? โโ
if you have a lot of tests to run over an object, and if you want to run a specific action for each testโs result, then this pattern will provide you with a clear, plug-like design to ensure that you wonโt get lost while trying to understand what goes where.
Code on GitHub๐
Upvote
Abdulcelil Cercenazi
I love to learn and teach. Follow me for Software development/Clean coding topics :)

Related Articles