In this article, we explore the important non functional requirement called Maintainability.
What you will learn
- What Is Maintainability?
- Why is Maintainability important?
- How do you improve Maintainability of your system?
Free Courses - Learn in 10 Steps
- FREE 5 DAY CHALLENGE - Learn Spring and Spring Boot
- Learn Spring Boot in 10 Steps
- Learn Docker in 10 Steps
- Learn Kubernetes in 10 Steps
- Learn AWS in 10 Steps
Non Functional Requirements and Microservices
This is the part of a series of articles on Non Functional Requirements:
- 1 - Microservices Architectures - Non Functional Requirements
- 2 - Security
- 3 - Web Application Security And OWASP - Top Ten Security Flaws
- 4 - Maintainability
- 5 - Scalability
- 6 - Performance
- 7 - Reusability
- 8 - Reliability
- 9 - Modularity
- 10 - Availability
- 11 - Portability
What Is Maintainability?
Requirements for a Software Applications often change. When you develop an application, you want to be able to easily enhance it easily in the future.
This could also be in the form of providing fixes to important bugs that are detected over time.
Technically speaking, what we call maintainability is typically two things
Maintainability is all about how easy it is to fix a bug found in the application.
Extensibility of a system describes how easy it is to incorporate new features into it.
Both these concepts are quite deeply related, and are clubbed together under a single umbrella - maintainability. That’s how we address them as well.
The maintainability of an application can be enhanced by following some important guidelines.
Have Great Low-Level Design
It is very important for your application have great low-level design, in order to be maintainable.
Adhering to 4 Principles of Simple Design is a great starting point.
Test Driven Development (TDD) usually leads to great tests and great low level design. With TDD, you first write tests and then write code to make these tests pass. The code is continuously refactored to meet 4 principles of simple design.
Ensure Modular Design
Have a look at the following microservices architecture:
Each of these microservices use common infrastructure components, such as Naming Service and API Gateway. It also makes use the features of common technical components, such as Security and Logging.
Having common components and infrastructure enable the microservices to focus on their specific responsibilities.
If Microservice1 has a need for user authentication or authorization, it interacts with the Security component through a well defined interface. Security component takes care of the inner implementation details.
As Microservice1 has lesser things to take care of, it becomes more maintainable.
In addition, it becomes easier to add additional microservices to the system at a later point in time.
Ensure Great Automation Tests
It is important that all the unit, system, integration and API tests are of good quality, and equally important, are automated. Ideally, they need to be part of a Continuous Integration (CI) process, that is invoked whenever code is committed to the source repository.
The idea is to have immediate feedback on application reliability, while removing the dependency on manual testing.
Automate The Deployment Pipeline
With an automated deployment pipeline, the build moves through different stages such as development, QA, staging and production in a systematic and efficient manner.
Greater visibility of code across the modules in the system makes it easier to detect bugs, and shorten the time line in addressing them.
Having great traceability across microservices in a microservices architecture helps us understand what’s happening in the background with a specific request
- Which microservices are involved?
- What are the requests and responses?
- How much time was taken at each hop?
In this article, we took a closer look at maintainability. We saw that it is a measure of two things : the amount of effort needed to fix bugs in the system, and the amount of effort needed to incorporate additional features into the application (also called extensibility).
We then looked at a few ways to enhance the maintainability of an application. The important ones are to have good low-level design, ensure a modular architecture, be equipped with great automation tests, have good system visibility.