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”。
相关文章
|
9月前
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解,用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如,前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据,后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景,简化了数据解析过程。与表单提交不同,它主要用于接收 JSON 格式的实体数据。
806 0
|
9月前
|
JSON 前端开发 Java
Spring MVC常用的注解
@RequestMapping:用于处理请求 url 映射的注解,可用于类或方法上。用于类上,则表示类中 的所有响应请求的方法都是以该地址作为父路径。 @RequestBody:注解实现接收http请求的json数据,将json转换为java对象。 @ResponseBody:注解实现将conreoller方法返回对象转化为json对象响应给客户。 @Controller:控制器的注解,表示是表现层,不能用用别的注解代替 @RestController : 组合注解 @Conntroller + @ResponseBody @GetMapping , @PostMapping , @Put
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
630 4
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
1267 2
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
357 2
|
前端开发 Java 开发者
Spring MVC中的控制器:@Controller注解全解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序控制层的核心。它不仅简化了控制器的定义,还提供了灵活的请求映射和处理机制。本文将深入探讨`@Controller`注解的用法、特点以及在实际开发中的应用。
909 0
|
前端开发 Java 应用服务中间件
我以为我对Spring MVC很了解,直到我遇到了...
所有人都知道Spring MVC是是开发的,却鲜有人知道Spring MVC的理论基础来自于1978 年提出MVC模式的一个老头子,他就是Trygve Mikkjel Heyerdahl Reenskaug,挪威计算机科学家,名誉教授。Trygve Reenskaug的MVC架构思想早期用于图形用户界面(GUI) 的软件设计,他对MVC是这样解释的。MVC 被认为是解决用户控制大型复杂数据集问题的通用解决方案。最困难的部分是为不同的架构组件想出好的名字。模型-视图-编辑器是第一个。
266 1
我以为我对Spring MVC很了解,直到我遇到了...
SpringMVC入门到实战------3、@RequestMapping注解(超详细基础知识+实际代码案例)
该博客文章详细介绍了SpringMVC中`@RequestMapping`注解的使用方法,包括其功能、位置、value属性、method属性、params属性、headers属性以及支持的路径风格和占位符,并通过实际代码案例展示了如何建立请求与控制器方法之间的映射关系。
SpringMVC入门到实战------3、@RequestMapping注解(超详细基础知识+实际代码案例)
|
XML 前端开发 Java
Spring MVC接收param参数(直接接收、注解接收、集合接收、实体接收)
Spring MVC提供了灵活多样的参数接收方式,可以满足各种不同场景下的需求。了解并熟练运用这些基本的参数接收技巧,可以使得Web应用的开发更加方便、高效。同时,也是提高代码的可读性和维护性的关键所在。在实际开发过程中,根据具体需求选择最合适的参数接收方式,能够有效提升开发效率和应用性能。
360 3
|
XML 前端开发 Java
Spring MVC接收param参数(直接接收、注解接收、集合接收、实体接收)
Spring MVC提供了灵活多样的参数接收方式,可以满足各种不同场景下的需求。了解并熟练运用这些基本的参数接收技巧,可以使得Web应用的开发更加方便、高效。同时,也是提高代码的可读性和维护性的关键所在。在实际开发过程中,根据具体需求选择最合适的参数接收方式,能够有效提升开发效率和应用性能。
614 2