Code Quality Basics - What Is Readability Of Code?


NEW COURSE RELEASED! - 21 HOURS, 200+ VIDEOS - Master DevOps with Docker, Kubernetes and Azure DevOps


One activity that you be doing a lot as a programmer, is reading code. That’s where the concept of readability comes into the picture. How do you ensure that code written in a project is easily understandable?

You will learn

  • What is readability Of code?
  • What are the challenges with having bad code?
  • How do you improve readability of code?

Free Courses - Learn in 10 Steps

Article Series

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

Readability Of Code - Example

Have a look at the following code example:

Example Code-1


	public Lock isLockAvailableForFile(long clientID, String status, boolean firstScreen, User user, List list) {
		Date sysTime = new Date();
		Lock lock = new Lock();
		if(list.size() > 0 && list.get(0) != null) {
			Object[] o1 = (Object[]) list.get(0);
			String userId = (String) o1[0];
			Date lockTimestamp = (Date) o1[1];
		
			if(userId != null) {
				//The message shown to the user
				String lockMsg = Constants.LOCK_REASON.replaceAll("@@[email protected]@", userId);

				//if userId is present, then lockTimestamp will also be present
				//72000000 milliseconds equals to 2 hours
				if(sysTime.gettime() - locktimestamp.getTime() > 7200000) {
					//The new user should attain lock only in the first screen
					//If 2 hours expires when user is not present on 1st screen, then user Id...
					if(firstScreen 
						|| userId.equalsIgnoreCase(user.getUserId())) {
						//to set the file access to write mode
						lock.setReadAccess(false);
						Logger.debug(
									 "Write access is permitted to the User for client {0}",
									clientId);
						return lock;
					}

					/*   ...  BLAH BLAH BLAH !!!  ...   */
				}
			}
		}
	}

Try and spend some time to see, whether this code is readable.

Would you like to see such code as part of your application?

Would you enjoy maintaining an applicaton that has code such as this?

Example Code-2


	public Lock isLockAvailableForFile(boolean isFirstScreen, User user, List list) {
		if(isListEmpty(list)) {
			return lockWithWriteAccess();
		}
		Object[] lockObject = (Object[]) list.get(0);
		String userId = (String) lockObject[0];
		Date lockTimestamp = (Date) lockObject[1];

		if(userId == null) {
			return lockWithWriteAccess();
		}

		boolean userHasLockedEarlier = userId.equalsIgnoreCase(user.userId);
		boolean lockPeriodExceeded = new Date().getTime() -
									 lockTimeStamp.getTime > 2 * 60 * 60 * 1000;

		if(userHasLockEarlier)
			return lockWithWriteAccess();
		if(lockPeriodExceeded && isFirstScreen)
			return lockWithWriteAccess();

		return lockWithReadAccess(userId);
	}

The second example is refactored from the first example.

You can immediately see, that the second code is much more readable than the first.

Improving Readability of Code

What is the difference between these two examples?

Readability Is About Proper Naming

Readability of code is all about giving proper names. In general, the readability of code can be improved by 75% by properly naming variables, methods and classes.

For example, have a look at the extracted methods lockWithWriteAccess() and lockWithReadAccess(). With proper names such as these, you can identify the functionality very easily. There is almost no need to peek into the implementation details of the method to understand what it does.

Single Responsibility Principle

The next important factor is to ensure that we do only a single thing inside a particular method. If a method or a class does one thing only, then it is quite easy to give it a readable name.

Ensure Great Unit Tests

If you have great unit tests in place, you have the freedom to refactor code. You would no longer be worried about breaking functionality.

Adhere To Test-Driven Development (TDD)

With TDD, you write the tests before you write the code. You start with an outside-in perspective on your code. You are concerned about the interface, and that helps in writing great code.

Do check out our video on the same topic:

image info

Summary

In this article, we discussed readability of code and why it is important. We saw an example of code that has poor readability, and what it looked like after refactoring.

What to Learn Next?

NEW COURSE RELEASED! - 21 HOURS, 200+ VIDEOS - Master DevOps with Docker, Kubernetes and Azure DevOps


350,000 Learners are learning everyday with our Best Selling Courses : Spring Boot Microservices, Spring, Spring Boot, Web Services, Hibernate, Full Stack React, Full Stack Angular, Python, Spring Interview Guide, Java Interview, Java Functional Programming, AWS, Docker, Kubernetes, PCF, AWS Fargate and Azure


85,000 Subscribers are learning from our Free Videos on YouTube : JSP Servlets, Spring, Spring Boot, Spring MVC, Hibernate, Eclipse, Maven, JUnit, Mockito, Full Stack - React, Full Stack - Angular, Docker, Kubernetes, AWS, AWS Fargate, PCF and Azure


Here are the recommend articles to read next : Spring Interview Questions, Spring Boot Interview Questions, Microservices, Hibernate, Spring Security, REST API with Spring Boot, Full Stack with React, SOAP Web Services, Exception Handling, Embedded Servers, Spring Data Rest, Spring vs Spring MVC vs Spring Boot, Building Web Application and Spring Data JPA. You can checkout all our 100+ articles here - All Articles.


Do not know where to start your learning journey? Check out our amazing learning paths: Learning Path 01 - Spring and Spring Boot Web Applications and API Developer, Learning Path 02 - Full Stack Developer with Spring Boot, React & Angular, Learning Path 03 - Cloud Microservices Developer with Docker and Kubernetes, Learning Path 04 - Learn Cloud with Spring Boot, AWS, Azure and PCF and Learning Path 05 - Learn AWS with Microservices, Docker and Kubernetes


Related Posts

Docker Tutorial for Beginners - with Java and Spring Boot

Learn about Docker - What is Docker? Why Is Docker Popular? How to create Docker Image for a Java Spring Boot App?

Devops Tutorial | DevOps with Docker, Kubernetes and Azure DevOps

What is DevOps? How is it different from Agile? What are the popular DevOps Tools? What is the role of Docker, Kubernetes and Azure DevOps in DevOps. Let's get started with a simple usecase.

Deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes

In this article, we focus our attention on the cloud. How to learn the cloud and deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes?

Microservices Architectures - Non Functional Requirements - Performance

In this article, we explore an important non functional requirement called performance.

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.

Microservices with Spring Boot and Java - Part 1 - Getting Started

Let's learn the basics of microservices and microservices architectures. We will also start looking at a basic implementation of a microservice with Spring Boot. We will create a couple of microservices and get them to talk to each other using Eureka Naming Server and Ribbon for Client Side Load Balancing. In part 1 of this series, lets get introduced to the concept of microservices and understand how to create great microservices with Spring Boot and Spring Cloud.

20+ Spring Boot Projects with Code Examples

At in28Minutes, we have created more than 20 projects with code examples on Github. We have 50+ articles explaining these projects. These code examples will you learn and gain expertise at Spring Boot.

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?

Index - 500+ Videos

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