【Spring Boot】033-使用 `@ResponseBody` 注解代替`ServletResponse`？

【Spring Boot】033-使用 @ResponseBody 注解代替ServletResponse？

0、全局总结

1. 可以使用 @ResponseBody 注解将响应直接返回给客户端；
2. 使用@RestController注解，默认为每个方法加了@ResponseBody注解；
3. ServletResponse 可以进行更复杂的响应处理(设置响应头、状态码等)，可以结合 @ResponseBody 注解和 ServletResponse 一起使用。

一、@ResponseBody 注解与 ServletResponse 比较

1、ResponseBody 注解

- 用于Spring MVC控制器方法,表示该方法的返回值应该直接写入HTTP响应正文中。
- Spring会自动转换返回值到响应格式(如JSON,XML等)。
- 简化了向响应写数据的代码。

2、ServletResponse

- 表示客户端的HTTP响应,允许访问响应的输出流或设置响应标头等。
- 需要手动转换对象为响应格式并写入输出流。
- 代码较为繁琐。

3、总结

- 如果只是简单地在响应中返回字符串/对象, @ResponseBody 注解更加方便。
- 如果需要更复杂的响应处理(设置响应头、状态码等), ServletResponse 会更加灵活。
- 可以根据需要同时使用两者。例如使用 @ResponseBody 返回主体数据,并且使用 HttpServletResponse 设置响应头。

二、使用 @ResponseBody 注解代替ServletResponse

1、概述

在Spring框架中，你可以使用@ResponseBody注解来替代ServletResponse，以便将响应直接返回给客户端，而无需显式地操作ServletResponse对象。@ResponseBody注解通常与控制器方法一起使用。

2、使用@ResponseBody注解

示例

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MyController {

    @GetMapping("/hello")
    @ResponseBody
    public String hello() {
        return "Hello, World!";
    }
}

解释

在上述示例中，@ResponseBody注解被应用在hello()方法上。它告诉Spring将方法的返回值直接作为响应体返回给客户端。在这种情况下，返回的是字符串"Hello, World!"。

使用@ResponseBody注解的好处是，它将自动处理将响应转换为适当的格式（如JSON、XML等），而无需手动编写转换代码。这样，你可以更方便地返回对象、集合或其他类型的数据。

3、使用 @RestController 注解

如果你使用@RestController注解标记控制器类，它会自动为每个处理方法添加@ResponseBody注解，因此你无需显式地使用@ResponseBody注解。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

三、@ResponseBody 注解与 HttpServletResponse 结合使用案例

1、代码示例

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletResponse;

@Controller
public class MyController {

    @GetMapping("/hello")
    @ResponseBody
    public String hello(HttpServletResponse response) {
        // 设置响应头
        response.setHeader("Custom-Header", "Value");

        // 返回主体数据
        return "Hello, World!";
    }
}

2、说明

在上述示例中，hello()方法中添加了一个HttpServletResponse参数，该参数由 Spring 自动注入。我们可以使用该参数来设置自定义的响应头。

在方法体内部，我们使用response.setHeader()方法设置了一个名为"Custom-Header"的响应头，并为其指定了一个值。

然后，使用@ResponseBody注解返回了字符串"Hello, World!"作为响应的主体数据。

通过这种方式，我们可以同时利用@ResponseBody返回主体数据和使用HttpServletResponse设置响应头，以满足不同的需求。