@ResponseBody 注解的详解

最新推荐文章于 2026-03-29 04:23:17 发布

原创最新推荐文章于 2026-03-29 04:23:17 发布 · 1.1k 阅读

7 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#java #spring #spring boot

这篇文章详细介绍了SpringMVC框架中的@ResponseBody注解如何将方法返回值转换为HTTP响应体，包括如何通过MessageConverter处理不同格式的数据，以及在实际代码中的应用示例。

@ResponseBody 是Spring MVC框架中的一个注解，它用于方法级别或控制器类级别。当我们在处理HTTP请求的方法上使用此注解时，意味着该方法的返回值将直接写入HTTP响应体中，并转换为对应的响应内容类型（如JSON、XML、纯文本等）。

具体来说：

当客户端发起一个HTTP请求到服务器端的一个标注了 @ResponseBody 的方法时，Spring MVC会调用MessageConverter对象（如MappingJackson2HttpMessageConverter、StringHttpMessageConverter等）来将方法返回的对象转换成适合HTTP响应的数据格式。
如果你的应用已经配置了JSON库（如Jackson或Gson），那么对于大多数Java对象，@ResponseBody 注解的方法默认会将其转换为JSON格式发送给客户端。

例如：

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

@RestController
@RequestMapping("/api")
public class MyController {

    @PostMapping("/submit-form")
    @ResponseBody
    public MyResponseObject submitForm(@RequestBody MyRequestObject request) {
        // 处理请求数据并生成响应...
        return new MyResponseObject("Success", "Form submitted successfully");
    }
}

class MyRequestObject {
    // 请求对象的属性和方法
}

class MyResponseObject {
    private String status;
    private String message;

    // 构造函数、getter和setter...

    // ...
}

在这个例子中，submitForm 方法接收一个请求体中的MyRequestObject实例，并返回一个MyResponseObject实例。由于标注了 @ResponseBody 注解，Spring MVC会自动将返回的MyResponseObject转换成JSON格式并作为HTTP响应的主体发送给客户端。