SpringMVC：@ResponseBody注解与HttpServletResponse对象

在Spring MVC框架中，@ResponseBody注解和HttpServletResponse对象都扮演着将处理结果发送回客户端的重要角色，但它们的使用方式和目的有所不同。

@ResponseBody

@ResponseBody注解用于将方法的返回值绑定到web响应体（response body）上。当你使用@ResponseBody注解一个方法的返回值时，Spring会自动选择一个合适的HttpMessageConverter，将返回值转换为对应的格式（如JSON、XML等），并写入HTTP响应体中。这通常用于RESTful Web服务中，当你需要直接返回数据（如JSON或XML）给客户端时。

使用示例

@RestController
public class MyController {

    @GetMapping("/greeting")
    @ResponseBody // 通常与@RestController一起使用时可以省略
    public String greeting() {
        return "Hello, World!";
    }

    // 使用@RestController时，下面的@ResponseBody可以省略
    @GetMapping("/jsonGreeting")
    public MyResponseObject jsonGreeting() {
        MyResponseObject response = new MyResponseObject();
        response.setMessage("Hello in JSON");
        return response; // Spring将自动使用HttpMessageConverter转换为JSON
    }
}

HttpServletResponse

HttpServletResponse是Servlet API的一部分，它代表了Servlet对客户端的响应。你可以通过它来直接控制HTTP响应的各个方面，包括状态码、响应头以及响应体。当你需要更细粒度的控制响应时（比如设置特定的响应头、发送二进制文件等），HttpServletResponse就显得非常有用。

使用示例

@Controller
public class MyServletController {

    @GetMapping("/customResponse")
    public void customResponse(HttpServletResponse response) throws IOException {
        response.setContentType("text/plain");
        response.setCharacterEncoding("UTF-8");
        response.getWriter().write("Custom response using HttpServletResponse");
    }

    @GetMapping("/fileDownload")
    public void fileDownload(HttpServletResponse response) throws IOException {
        // 设置响应头
        response.setContentType("application/pdf");
        response.setHeader("Content-Disposition", "attachment; filename=\"example.pdf\"");

        // 假设你有一个获取文件输入流的方法
        InputStream inputStream = getFileAsStream("path/to/example.pdf");

        // 使用ServletOutputStream将文件内容写入响应
        ServletOutputStream outputStream = response.getOutputStream();
        IOUtils.copy(inputStream, outputStream); // 使用Apache Commons IO库来复制流

        outputStream.flush();
    }
}

总结

• @ResponseBody主要用于将方法的返回值自动转换为JSON、XML等格式，并写入HTTP响应体中，适用于RESTful Web服务。
• HttpServletResponse提供了对HTTP响应的细粒度控制，适用于需要直接操作响应头、响应体等场景。
• 在Spring MVC中，@RestController注解已经隐式地为所有处理方法的返回值应用了@ResponseBody注解，因此在@RestController注解的控制器中，你可以省略@ResponseBody。