Code Quality Basics - What Is Legacy Code?


If you are working in a large software application or project, you will often hear the term legacy code quite a lot. What does this term mean, and how can you avoid legacy code?

You will learn

  • What Is Legacy Code?
  • What are the challenges with Legacy Code?
  • How do you improve Legacy Code?

Article Series

This is last article in a series of 6 articles on important code quality terminology:

What Is Legacy Code?

The popular definition of legacy code going around is

Old code - built in old technology.

I would add one more element to it

Any code which is difficult to understand and improve the design is legacy code.

In other words, any code which does not have great design, which does not have the support of good unit tests, is legacy code. That’s because you cannot refactor it to improve its design, as you are unsure if you break functionality.

What Make Code A Legacy?

  • Old code in outdated technologies
  • Code without tests
  • Code with a lot of technical debt

Challenges With Legacy Code

Unexpected Impact

One of the biggest problems caused due to legacy code, is that changes in one part can lead to impact in other parts. This could lead to long release cycles.

Extreme Caution During Maintenance

Every time a change is made in one part of the code, the entire code base needs to be tested extensively to check for unexpected impact. This attaches a large cost in time and manpower across the team.

Dealing With Legacy Code

Have Good Code Review Processes

Make sure that the code in the application is reviewed at regular intervals during the development cycle, to identify maintainability issues.

Refactor Code

It is impossible to refactor and improve every part of a large legacy application.

To start with, identify critical areas that frequently change and improve their design. Try and build good unit tests as you refactor.

Perform Static Analysis

Make sure you use static analysis tools such as Sonar. Put them in continuous integration. Have processes to monitor new violations

Have Automated Regression Testing

In general, it is difficult to write good unit tests for legacy code.

A more practical optionis to write good automated integration and regression tests.

Develop New Functionality in a New Component

Start exploring new avenues. Instead of building everything into your legacy application, start thinking about creating new components and/or services and integrating with them.

Do check out our video on the same topic:

image info

Summary

In this article, we saw that any code that is difficult to maintain, is legacy code. We had a look at what factors contribute to legacy code, and what challenges developers face due to it. We then explored different ways to deal with legacy code in a project.

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?