SpringMVC之返回JSON的三种方式
一、方法上加注解@ResponseBody
需求
使用 springmvc 提供一个接口，以 json 格式输出用户列表。
step1：maven 配置引入 jackjson
jackjson 用于将 java 对象转换为 json 格式的字符串，也可以将 json 格式的字符串转换为 java 对象
我们的接口需要将 java 对象转换为 json 格式的字符串输出到客户端，所以我们需要用到这个包。
<dependency>
<groupId>com.fasterxml.jackson.core<groupId>
<artifactId>jackson-core<artifactId>
<version>2.11.4<version>
<dependency>
<dependency>
<groupId>com.fasterxml.jackson.core<groupId>
<artifactId>jackson-databind<artifactId>
<version>2.11.4<version>
<dependency>step2：springmvc 配置文件中添加注解驱动
<mvc:annotation-driven/>
添加了这段代码之后，springmvc 就被赋予了将 java 对象转换为 json 格式字符串输出到客户端的能力。
step3：处理器的方法上添加@ResponseBody 注解
如下代码，我们希望 list()方法用于向客户端以 json 格式输出用户列表。
此时只需要在这个方法上面添加一个@ResponseBody注解，SpringMVC 发现这个方法上有@ResponseBody这个注解，并且方法返回值是一个普通的 java 对象的时候，会将方法的返回值使用 jackson 转换为 json 格式的字符串，然后输出到客户端。
@Controller
public class UserController {
/**
* 用户列表(用户id->用户信息)
*/
Map userDtoMap = new ConcurrentHashMap<>();
{
userDtoMap.put(1L, new UserDto(1L, "路人", 30));
userDtoMap.put(2L, new UserDto(2L, "张三", 20));
userDtoMap.put(3L, new UserDto(3L, "李四", 18));
}
@GetMapping("/user/list.do")
@ResponseBody
public Collection list() {
return this.userDtoMap.values();
}
}验证效果
谷歌浏览器中访问下这个接口
二、Controller 上添加注解ResponseBody
当我们 controller 中方法很多的时候，且所有方法都要求返回 json 格式的数据的时候，如果按照方式 1，我们需要在每个方法上都要添加@ResponseBody注解，此时有更简单的方法，将所有方法上的@ResponseBody注解都去掉，然后在 Controller 上加上@ResponseBody就可以了。
比如下面这段代码，我们可以将 2 个方法上面的@ResponseBody干掉，然后在类上添加@ResponseBody注解就可以了。
@Controller
public class UserController {
Map userDtoMap = new ConcurrentHashMap<>();
{
userDtoMap.put(1L, new UserDto(1L, "路人", 30));
userDtoMap.put(2L, new UserDto(2L, "张三", 20));
userDtoMap.put(3L, new UserDto(3L, "李四", 18));
}
@GetMapping("/user/list.do")
@ResponseBody
public Collection list() {
return this.userDtoMap.values();
}
@GetMapping("/user/{id}.do")
@ResponseBody
public UserDto user(@PathVariable("id") Long id) {
return this.userDtoMap.get(id);
}
}调整之后如下
@Controller
@ResponseBody
public class UserController {
Map userDtoMap = new ConcurrentHashMap<>();
{
userDtoMap.put(1L, new UserDto(1L, "路人", 30));
userDtoMap.put(2L, new UserDto(2L, "张三", 20));
userDtoMap.put(3L, new UserDto(3L, "李四", 18));
}
@GetMapping("/user/list.do")
public Collection list() {
return this.userDtoMap.values();
}
@GetMapping("/user/{id}.do")
public UserDto user(@PathVariable("id") Long id) {
return this.userDtoMap.get(id);
}
}三、Controllers 上使用@RestController
我们回头再看下上面代码，UserController 上有 2 个注解@Controller和@ResponseBody，而 SpringMVC 提供了一个更好的注解@RestController，相当于这 2 个注解的合体，所以可以用来替换这 2 个注解。
四、总结
掌握@ResponseBody 的用法，用来返回 json 格式的数据，注意需要在 springmvc 配置文件中添加注解驱动的配置，否则调用会报错
<mvc:annotation-driven/>
以上就是SpringMVC之返回JSON的三种方式的详细内容，更多关于SpringMVC 返回JSON的资料请关注脚本之家其它相关文章！
相关文章
这篇文章主要介绍了java实体对象与Map之间的转换工具类代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-12-12
这篇文章主要介绍了Java利用Easyexcel动态导出表头列的实例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2025-04-04
VSCode中开发JavaWeb项目的详细过程（Maven+Tomcat+热部署）
这篇文章主要介绍了VSCode中开发JavaWeb项目（Maven+Tomcat+热部署）,本文分步骤通过图文并茂的形式给大家介绍的非常详细，需要的朋友可以参考下2022-09-09
这篇文章主要介绍了如何使用Spring Validation优雅地校验参数,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-07-07
这篇文章主要介绍了Mybatis实体类属性与数据库不一致解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-10-10
这篇文章主要介绍了详解Spring中的@Scope注解,@Scope注解是Spring IOC容器中的一个作用域，在Spring IOC容器中，他用来配置Bean实例的作用域对象,需要的朋友可以参考下2023-07-07
在本文里我们给大家整理了一篇关于Java volatile的适用场景实例内容和知识点，需要的朋友们可以学习下。2019-08-08
Springboot国际化可以帮助使用者在不同语言环境中构建应用程序，这样应用程序可以有效地适应不同语言文化背景下的用户需求。本文主要介绍了SpringBoot实现前后端分离国际化的方法，需要的可以参考一下2023-02-02
当我们在Java应用程序中需要对字典属性进行转换返回给前端时，如何简单、方便、并且优雅的处理是一个重要问题。在本文中，我们将介绍如何使用Java中的序列化机制来优雅地实现字典值的翻译，从而简化开发2023-04-04
这篇文章主要介绍了Spring Boot 定义系统启动任务的多种方式，看看你都会哪几种 ,感兴趣的朋友跟随小编一起看看吧2019-04-04
最新评论