Spring MVC常用注解--“姐妹花”@RequestBody和@ResponseBody

作者：baeldung

译者： helloworldtang

1. 引言

在这篇短文中，我们简要地介绍了Spring MVC中常用的注解 @RequestBody和@ResponseBody。

2. @RequestBody

简单地说，在@RequestBody注解的帮助下，Spring MVC会自动将HttpRequest body反序列化为一个Java对象，通常会将HttpRequest body映射到一个DTO或DO。

首先，让我们看一看Spring控制器方法：

@PostMapping("/request")
public ResponseEntity postController(
  @RequestBody LoginForm loginForm) {

    exampleService.fakeAuthenticate(loginForm);
    return ResponseEntity.ok(HttpStatus.OK);
}

如果HttpRequest body携带了正确的JSON，Spring MVC会自动将这个JSON反序列化为一个Java对象。通常情况下，我们必须将使用了@RequestBody标注的Java类与客户端发送的JSON相对应。

Tips: bug高发区：Java类中的属性名与JSON中的键名必须完全一样，不一样的键值对是不会序列化到Java对象中的(⊙o⊙)哦。

public class LoginForm {
    private String username;
    private String password;
    // ...
}

在这个例子中，我们将HttpRequest body映射到上面的这个LoginForm 对象。

让我们使用CURL来测试下这个接口：

curl -i \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-X POST --data 
  '{"username": "johnny", "password": "password"}' "https://localhost:8080/.../request"

这就是一个Spring REST API以及使用@RequestBody 注解将Angular客户端发送的JSON自动序列化成Java对象所需要的全部内容了！

3. @ResponseBody

@ResponseBody注解告诉控制器，返回的对象需要自动序列化成JSON，并通过HttpResponse body返回给客户端。

Tips: 使用@ResponseBody注解修饰后，这个接口返回的将不是一个页面。

假设我们有一个自定义的Response对象，如下所示：

public class ResponseTransfer {
    private String text; 

    // standard getters/setters
}

接下来实现相应的控制器：

@Controller
@RequestMapping("/post")
public class ExamplePostController {

    @Autowired
    ExampleService exampleService;

    @PostMapping("/response")
    @ResponseBody
    public ResponseTransfer postResponseController(
      @RequestBody LoginForm loginForm) {
        return new ResponseTransfer("Thanks For Posting!!!");
     }
}

在浏览器的开发者控制台或者使用像Postman这样的工具，我们可以看到以下的响应：

{
    "text": "Thanks For Posting!!!"
}

请记住，如果控制器使用了@RestController注解，就不需要再使用 @ResponseBody了，因为它已经默认添加的。

Tips: @RestController是一个组合注解，组合了@Controller和@ResponseBody。

4. 总结

我们已经为Spring应用构建了一个简单的Angular客户端，并演示了如何使用@RestController和@ResponseBody注解。

像往常一样，示例代码在GitHub上可以找到。