Microservices Architectures - Non Functional Requirements - Maintainability


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?

Non Functional Requirements and Microservices

This is the part of a series of articles on Non Functional Requirements:

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
  • Extensibility

Maintainability

Maintainability is all about how easy it is to fix a bug found in the application.

Extensibility

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.

Enhancing Maintainability

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:

image info

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

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?

image info

Summary

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.

10 Step Reference Courses

Image Image Image Image Image

in28Minutes is helping 300,000 Learners across the world reach their learning goals. Click here for the complete catalogue of 30 Courses.

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring and Spring Boot Video Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. Here's a list of video tutorials and courses for you

Software Design - Separation Of Concerns - with examples

Software architects and programmers love having Seperation of Concerns. What is it? Why is it important? Let's get started.

Object Oriented Software Design - Solid Principles - with examples

Software design is typically complex. Object oriented design takes it to the next level. There are a number of design patterns and other stuff to be aware of. Can we make things simple? What are the goals to aim for when you are doing object oriented design? SOLID Principles is a great starting point for Object Oriented Design.

Software Design - Open Closed Principle - with examples

Open Closed Principle is one of the SOLID Principles. You want your code to be easily extended. How do you achieve it with minimum fuss? Let's get started.

Software Design - What is Dependency Inversion Principle?

Dependency Inversion Principle is one of the important SOLID Principles. Dependency Inversion Principle is implemented by one of the most popular Java frameworks - Spring. What is it all about? How does it help you design good applications?

Introduction to Four Principles Of Simple Design

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 - Single Responsibility Principle - with examples

For me, Single Responsibility Principle is the most important design principle. What is Single Responsibility Principle? How do you use it? How does it help with making your software better? Let's get started.

REST API Best Practices - With Design Examples from Java and Spring Web Services

Designing Great REST API is important to have great microservices. How do you design your REST API? What are the best practices?

Designing REST API - What is Code First Approach?

Designing Great REST API is important to have great microservices. Code First approach focuses on generating the contract from code. Is it the best possible approach?