@RequestBody in Spring Boot: What It Is and How It Works

@RequestBody in Spring Boot is an annotation that tells the framework to take the data sent in the body of an HTTP request and convert it into a Java object. It helps your controller methods receive JSON or XML data directly as Java objects for easy processing.

How It Works

Imagine you receive a letter with a form filled out by someone. Instead of reading the letter yourself, you hand it to a helper who fills out a form in your system for you. @RequestBody works like that helper. It takes the raw data sent in the HTTP request body, usually in JSON format, and converts it into a Java object you can use directly in your code.

This conversion is done automatically by Spring Boot using a tool called HttpMessageConverter. It reads the request body, understands the format, and creates the matching Java object based on the class you specify. This saves you from manually parsing the data.

Example

This example shows a simple Spring Boot controller that uses @RequestBody to receive user data in JSON format and print it.

java

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    static class User {
        public String name;
        public int age;
    }

    @PostMapping("/users")
    public String addUser(@RequestBody User user) {
        return "Received user: " + user.name + ", age " + user.age;
    }
}

Output

If you send a POST request to /users with JSON {"name":"Alice","age":30}, the response will be: Received user: Alice, age 30

When to Use

Use @RequestBody when your application needs to accept data from clients in the body of HTTP requests, especially for POST, PUT, or PATCH methods. It is ideal for APIs that receive JSON or XML data representing objects like users, orders, or settings.

For example, when a mobile app sends user registration details or when a web client submits a form with complex data, @RequestBody helps convert that data into Java objects automatically, making your code cleaner and easier to maintain.

Key Points

• @RequestBody binds HTTP request body to a Java object.
• It works with JSON, XML, or other formats supported by Spring's converters.
• Commonly used in REST APIs for POST, PUT, PATCH requests.
• Requires a matching Java class to map the incoming data.
• Helps avoid manual parsing and simplifies controller code.

Key Takeaways

@RequestBody automatically converts HTTP request body data into Java objects.

It is mainly used in REST controllers to handle JSON or XML input.

Use it when your API needs to accept complex data from clients.

Spring Boot uses HttpMessageConverters behind the scenes for this conversion.

It simplifies your code by removing the need for manual parsing.