ResponseEntity详解

一、ResponseEntity的概念

在Spring框架中，ResponseEntity是一种非常重要的数据传输对象。它是用于从Controller返回结果到客户端的包装类型。

这种类型可以封装了一些HTTP状态码，HTTP headers以及要返回的Body数据。

ResponseEntity是用于在Controller层进行结果返回时对返回数据进行包装的一种类型。同时也可以在Service层中使用，但是使用响应实体的时候一定要慎重考虑，如果不考虑好的话可能会增加系统的负担。

二、ResponseEntity的应用场景

在Spring MVC中，我们可以使用ResponseEntity将数据以指定的格式返回给客户端。

ResponseEntity能够帮助我们非常方便地控制HTTP响应对象的各个部分（状态码、Header、Body等），极大地增强了我们的开发效率。

常见的应用场景有：

1、返回json数据；

2、下载文件；

3、返回html页面；

4、返回自定义的响应消息等。

三、ResponseEntity常用的API

1、of方法

of方法是ResponseEntity的工厂方法，可以使用该方法创建一个ResponseEntity对象，该对象的Body部分就是我们要返回的数据对象。

示例代码：

@GetMapping("/user/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
    User user = userService.getUserById(id);
    return ResponseEntity.ok(user);
}

在上面的示例中，我们在Controller的方法内部使用ResponseEntity的工厂方法of方法创建一个包装了返回数据的响应对象。

2、ok方法

ok方法是of方法的简化版，仅仅是创建了一个状态码为OK（200）的ResponseEntity对象。

示例代码：

@GetMapping("/user")
public ResponseEntity
在上面的示例中，我们在Controller的方法内部使用ResponseEntity的工厂方法ok方法创建一个包装了返回数据的响应对象。

3、status方法
status方法允许我们指定一个HTTP状态码来创建响应Entity对象。同时，我们还可以通过链式编程设置响应Entity的header和body等信息。
示例代码：

@PostMapping("/user")
public ResponseEntity addUser(@Valid @RequestBody User user) {
    userService.addUser(user);
    HttpHeaders headers = new HttpHeaders();
    headers.setLocation(ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}").buildAndExpand(user.getId()).toUri());
    return ResponseEntity.status(HttpStatus.CREATED).headers(headers).build();
}

在上面的示例中，我们在Controller的方法内部使用ResponseEntity的工厂方法status方法创建一个包装了HTTP状态码和响应header信息的响应对象。

四、ResponseEntity返回错误信息

当发生错误时，我们可以使用ResponseEntity返回错误信息。在返回的响应Entity中设置一个状态码和错误信息即可。
示例代码：


@GetMapping("/user/{id}")
public ResponseEntity getUserById(@PathVariable Long id) {
    User user = userService.getUserById(id);
    if(user == null) {
        throw new UserNotFoundException("id-" + id);
    }
    return ResponseEntity.ok(user);
}

@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity handleUserNotFoundException(UserNotFoundException ex) {
    return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
}

在上面的示例中，我们在Controller方法内部判断当查询不到用户时，抛出一个UserNotFoundException异常。
同时，我们在Controller中定义了一个异常处理器方法handleUserNotFoundException，用于捕获UserNotFoundException异常并返回错误信息。

五、总结
本文详细讲解了ResponseEntity的概念、应用场景、常用API以及如何利用它来返回错误信息。
ResponseEntity是Spring框架中非常重要的数据传输对象，我们可以使用它来方便地控制HTTP响应对象的各个部分。使用ResponseEntity不仅能够增强我们的开发效率，而且还可以帮助我们快速构建安全可靠的web应用程序。