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

本是古典何须时尚 2023-10-10 22:02 32阅读 0赞

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

#### 文章目录 ####

*  【Spring Boot】033-使用 \`@ResponseBody\` 注解代替\`ServletResponse\`？
 *  0、全局总结
 *  一、\`@ResponseBody\` 注解与 \`ServletResponse\` 比较
 *   *  1、\`ResponseBody\` 注解
     *  2、ServletResponse
     *  3、总结
 *  二、使用 \`@ResponseBody\` 注解代替\`ServletResponse\`
 *   *  1、概述
     *  2、使用\`@ResponseBody\`注解
     *   *  示例
         *  解释
     *  3、使用 \`@RestController\` 注解
 *  三、\`@ResponseBody\` 注解与 \`HttpServletResponse\` 结合使用案例
 *   *  1、代码示例
     *  2、说明

## 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`注解 ###

#### 示例 ####

#### 解释 ####

在上述示例中，`@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`设置响应头，以满足不同的需求。