HttpMessageNotReadableException in Spring Boot

🎓 Top 15 Udemy Courses (80-90% Discount): My Udemy Courses - Ramesh Fadatare — All my Udemy courses are real-time and project oriented courses.

▶️ Subscribe to My YouTube Channel (178K+ subscribers): Java Guides on YouTube

▶️ For AI, ChatGPT, Web, Tech, and Generative AI, subscribe to another channel: Ramesh Fadatare on YouTube

In this post, we will explore what is HttpMessageNotReadableException, how to reproduce it, and what are the possible solutions.

What is HttpMessageNotReadableException? 

The HttpMessageNotReadableException is thrown when the request payload (body) is not readable. This can happen for various reasons: 

• The JSON sent by the client might be malformed. 
• There might be a type mismatch, such as sending a string where an integer is expected. 
• Missing essential properties that are marked as required in the DTO (Data Transfer Object).

Reproduce Step-By-Step

Create a Student class with the following content:

class Student {
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

Next, let's create a StudentController with the following REST API:

@RestController
@RequestMapping("/api/students")
public class StudentController {

    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<Student> student(@RequestBody Student student) {
        return ResponseEntity.ok(student);
    }
}

Next, let's call the above REST API using Postman and make sure to pass malformed JSON in the request body:

You will encounter the HttpMessageNotReadableException:

Solutions

Proper Client Data

Ensure the client sends data in the correct format. This can be clarified with the proper API documentation. 

Handle the Exception Gracefully

Use Spring's @ExceptionHandler to catch the exception and return a more user-friendly message:

@ExceptionHandler(HttpMessageNotReadableException.class)
public ResponseEntity<String> handleInvalidInput(HttpMessageNotReadableException e) {
    return ResponseEntity.badRequest().body("Invalid request payload.");
}

Utilize Validation

Use Java's built-in validation API along with annotations like @Valid to enforce structured data. 

Descriptive Error Messages

Where possible, provide descriptive error messages. For instance, instead of saying "Invalid Input", you might specify that a certain field was missing or was of the wrong type. 

Conclusion

HttpMessageNotReadableException gives a clear indication that the client has sent data in an unexpected format, and with the right handling, can make the API more robust and user-friendly.

Related Spring Exceptions Posts

• BeanCreationException in Spring Boot
• BeanInstantiationException in Spring Boot
• BeanDefinitionStoreException in Spring
• DataIntegrityViolationException in Spring Boot
• Spring InvalidDataAccessApiUsageException
• NoHandlerFoundException in Spring Boot
• HttpMessageNotReadableException in Spring Boot
• HttpMediaTypeNotSupportedException in Spring Boot
• MethodArgumentNotValidException in Spring Boot
• NoUniqueBeanDefinitionException Spring Boot
• UnsatisfiedDependencyException in Spring Boot
• Unsatisfied Dependency in Spring Boot

My Top and Bestseller Udemy Courses. The sale is going on with a 70 - 80% discount. The discount coupon has been added to each course below:

Build REST APIs with Spring Boot 4, Spring Security 7, and JWT

🆕 High-Demand 80–90% OFF

[NEW] Learn Apache Maven with IntelliJ IDEA and Java 25

🆕 High-Demand 80–90% OFF

ChatGPT + Generative AI + Prompt Engineering for Beginners

🚀 Trending Now 80–90% OFF

Spring 7 and Spring Boot 4 for Beginners (Includes 8 Projects)

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Building Real-Time REST APIs with Spring Boot - Blog App

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Building Microservices with Spring Boot and Spring Cloud

🌟 Top Rated 80–90% OFF
Available in Udemy for Business

Java Full-Stack Developer Course with Spring Boot and React JS

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Build 5 Spring Boot Projects with Java: Line-by-Line Coding

🌟 Top Rated 80–90% OFF

Testing Spring Boot Application with JUnit and Mockito

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Spring Boot Thymeleaf Real-Time Web Application - Blog App

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Master Spring Data JPA with Hibernate

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Spring Boot + Apache Kafka Course - The Practical Guide

🎓 Student Favorite 80–90% OFF
Available in Udemy for Business

Java Testing: Mastering JUnit 5 Framework

🆕 New 80–90% OFF

Reactive Programming in Java: Spring WebFlux and Testing

🌟 Top Rated 80–90% OFF

Spring Boot + RabbitMQ Course - The Practical Guide

🌟 Top Rated 80–90% OFF
Available in Udemy for Business

Functional Programming in Java (Includes Java Collections)

🎓 Student Favorite 80–90% OFF

ChatGPT for Java Developers: Boost Your Productivity with AI

🚀 Trending Now 80–90% OFF