With agile and extreme programming, the focus is on keeping your design simple. How do you keep your design simple? How do you decide whether your code is good enough?
Software Design Principles
This is the first article in a series of articles on important Software Design Principles:
- 1 - Introduction to Four Principles Of Simple Design
- 2 - Software Design - Separation Of Concerns - with examples
- 3 - Object Oriented Software Design - Solid Principles - with examples
- 4 - Software Design - Single Responsibility Principle - with examples
- 5 - Software Design - Open Closed Principle - with examples
- 6 - Software Design - What is Dependency Inversion Principle?
What is Simple Design?
It is very important to keep the design of your application simple.
In almost all agile projects, the aim is to meet today’s requirements, with clean code.
You go for complex design, only when simple design does not solve your problem.
The Four Principles Of Simple Design
A software application is said to have a simple design if it:
- Runs all tests
- Contains no duplication
- Expresses intent of programmers
- Minimizes number of classes and methods
Let’s now look at these aspects a little closely, by turn.
Runs All Tests
We want to keep running all the tests continuously, because we want the code to work, at all times.
An important corollary of this principle is you need to have a large number of automation tests. All unit, integration and API tests must be automated.
You should launch these tests as part of your build, and they should also be a part of Continuous Integration (CI).
With CI, you commit code into the repository, all the tests are run, and immediate feedback is there for you to act on.
Since the software is being tested all the time, it is stable.
Contains No Duplication
The second principle stresses on the fact that your code should have as little duplication as possible.
A good example is to create common components, whereever possible, in the design of large applications. This helps centralize the logic and allow other applications to reuse them.
Why do we hate duplication?
If there is a need for a change, the same change needs to repeated at all these locations. The result : More effort and also possibilities of more defects when you miss making the change in every location. That is a sign of bad design.
Expresses Intent Of Programmers
Your code should be easy to read, and your design, simple to understand. This principle is also called Clarity Of Code.
Have a look at the following piece of code:
Do you understand what it does?
Now look at the following version of the same program:
Do you understand what it’s trying to do?
Actually, Example-01 v2 results from applying the Four Principles of Simple Design to Example-01 v1.
Start with creating good names for variables, methods and classes. That improves clarity.
Minimize number of classes and methods
You should have
- Small methods
- Small classes
- Minimum number classes and methods
Isn’t it simple.
Lesser code you have, lesser code you have to maintain.
Always aim to keep things simple.
Do check out our video on this:
In this article, we looked at the four principles of simple design. These are the first steps to ensure that the design of your application remains simple. It lays the foundation for applying more advanced principles to improving your design.