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

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

1. 引言


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


2. @RequestBody


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


首先,让我们看一看Spring控制器方法:

 
 
  1. @PostMapping("/request")

  2. public ResponseEntity postController(

  3.  @RequestBody LoginForm loginForm) {

  4.    exampleService.fakeAuthenticate(loginForm);

  5.    return ResponseEntity.ok(HttpStatus.OK);

  6. }


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


Tips:

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


 
 
  1. public class LoginForm {

  2.    private String username;

  3.    private String password;

  4.    // ...

  5. }


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


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

 
 
  1. curl -i \

  2. -H "Accept: application/json" \

  3. -H "Content-Type:application/json" \

  4. -X POST --data

  5.   '{"username": "johnny", "password": "password"}' "https://localhost:8080/.../request"


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


3. @ResponseBody


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


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


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

 
 
  1. public class ResponseTransfer {

  2.    private String text;

  3.    // standard getters/setters

  4. }


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

 
 
  1. @Controller

  2. @RequestMapping("/post")

  3. public class ExamplePostController {

  4.    @Autowired

  5.    ExampleService exampleService;

  6.    @PostMapping("/response")

  7.    @ResponseBody

  8.    public ResponseTransfer postResponseController(

  9.      @RequestBody LoginForm loginForm) {

  10.        return new ResponseTransfer("Thanks For Posting!!!");

  11.     }

  12. }


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

 
 
  1. {

  2.    "text": "Thanks For Posting!!!"

  3. }


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


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


4. 总结


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


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



原文发布时间为:2018-09-16
本文作者:JackieTang
本文来自云栖社区合作伙伴“程序猿DD”,了解相关信息可以关注“程序猿DD”。
相关文章
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值(如 GET 请求的 URL 参数或 POST 请求的表单数据),而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性,如 `required` 和 `defaultValue`,并展示了如何用实体类封装大量表单参数以简化处理流程。最后,结合 Postman 测试工具验证了接口的功能。
1071 0
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解,用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如,前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据,后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景,简化了数据解析过程。与表单提交不同,它主要用于接收 JSON 格式的实体数据。
1737 0
|
前端开发 Java 微服务
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@PathVariable
`@PathVariable` 是 Spring Boot 中用于从 URL 中提取参数的注解,支持 RESTful 风格接口开发。例如,通过 `@GetMapping("/user/{id}")` 可以将 URL 中的 `{id}` 参数自动映射到方法参数中。若参数名不一致,可通过 `@PathVariable("自定义名")` 指定绑定关系。此外,还支持多参数占位符,如 `/user/{id}/{name}`,分别映射到方法中的多个参数。运行项目后,访问指定 URL 即可验证参数是否正确接收。
1114 0
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestMapping
@RequestMapping 是 Spring MVC 中用于请求地址映射的注解,可作用于类或方法上。类级别定义控制器父路径,方法级别进一步指定处理逻辑。常用属性包括 value(请求地址)、method(请求类型,如 GET/POST 等,默认 GET)和 produces(返回内容类型)。例如:`@RequestMapping(value = "/test", produces = "application/json; charset=UTF-8")`。此外,针对不同请求方式还有简化注解,如 @GetMapping、@PostMapping 等。
1113 0
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RestController
本文主要介绍 Spring Boot 中 MVC 开发常用的几个注解及其使用方式,包括 `@RestController`、`@RequestMapping`、`@PathVariable`、`@RequestParam` 和 `@RequestBody`。其中重点讲解了 `@RestController` 注解的构成与特点:它是 `@Controller` 和 `@ResponseBody` 的结合体,适用于返回 JSON 数据的场景。文章还指出,在需要模板渲染(如 Thymeleaf)而非前后端分离的情况下,应使用 `@Controller` 而非 `@RestController`
708 0
|
12月前
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
前端开发 Java API
Spring Cloud Gateway Server Web MVC报错“Unsupported transfer encoding: chunked”解决
本文解析了Spring Cloud Gateway中出现“Unsupported transfer encoding: chunked”错误的原因,指出该问题源于Feign依赖的HTTP客户端与服务端的`chunked`传输编码不兼容,并提供了具体的解决方案。通过规范Feign客户端接口的返回类型,可有效避免该异常,提升系统兼容性与稳定性。
981 0
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容,涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中,我了解到 IOC 是控制反转,把对象控制权交容器;DI 是依赖注入,有三种实现方式。Bean 有五种作用域,单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP,有失效场景和七种传播行为。AOP 是面向切面编程,动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心,还有那些常用注解的用法。 MyBatis 里,#{} 和 ${} 的区别很关键,获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
456 0
|
JSON 前端开发 Java
第05课:Spring Boot中的MVC支持
第05课:Spring Boot中的MVC支持
513 0
|
SQL Java 数据库连接
对Spring、SpringMVC、MyBatis框架的介绍与解释
Spring 框架提供了全面的基础设施支持,Spring MVC 专注于 Web 层的开发,而 MyBatis 则是一个高效的持久层框架。这三个框架结合使用,可以显著提升 Java 企业级应用的开发效率和质量。通过理解它们的核心特性和使用方法,开发者可以更好地构建和维护复杂的应用程序。
1102 29