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月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
797 0
|
9月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1373 128
|
9月前
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
444 126
|
10月前
|
XML JSON Java
Spring框架中常见注解的使用规则与最佳实践
本文介绍了Spring框架中常见注解的使用规则与最佳实践,重点对比了URL参数与表单参数的区别,并详细说明了@RequestParam、@PathVariable、@RequestBody等注解的应用场景。同时通过表格和案例分析,帮助开发者正确选择参数绑定方式,避免常见误区,提升代码的可读性与安全性。
|
8月前
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
9月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1007 1
使用Spring的@Retryable注解进行自动重试
|
8月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
735 2
|
9月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
568 12
|
9月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
467 0
探索Spring Boot的@Conditional注解的上下文配置

热门文章

最新文章