SpringMVC之返回JSON的三种方式

 更新时间:2023年06月06日 11:21:57   作者:ProgrammingAh  
现在都是前后端分离了,后端只需要跟前端提供restful接口,所有接口都返回json格式数据即可,SpringMVC通常有3种方式向前端输出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中线程的创建和启动

    浅析Java中线程的创建和启动

    这篇文章运用实例代码介绍了Java中线程的创建和启动,非常详细,有需要的朋友们可以参考借鉴,下面一起来看看。
    2016-08-08
  • 解决Java 结构化数据处理开源库 SPL的问题

    解决Java 结构化数据处理开源库 SPL的问题

    这篇文章主要介绍了Java 结构化数据处理开源库 SPL的问题,Scala提供了较丰富的结构化数据计算函数,但编译型语言的特点,也使它不能成为理想的结构化数据计算类库,对此内容感兴趣的朋友一起看看吧
    2022-03-03
  • 基于spring同名bean覆盖问题的解决

    基于spring同名bean覆盖问题的解决

    这篇文章主要介绍了spring同名bean覆盖问题的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Spring IOC 注入的3种方式小结

    Spring IOC 注入的3种方式小结

    Spring IoC容器支持多种依赖注入方式,本文主要介绍了Spring IOC 注入的3种方式小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-08-08
  • java由JABXContext注解读取xml配置文件方式

    java由JABXContext注解读取xml配置文件方式

    这篇文章主要介绍了java由JABXContext注解读取xml配置文件方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • Java类库BeanUtils组件使用方法及实例详解

    Java类库BeanUtils组件使用方法及实例详解

    这篇文章主要介绍了Java类库BeanUtils组件使用方法级实例详解,需要的朋友可以参考下
    2020-02-02
  • java 字符串截取的三种方法(推荐)

    java 字符串截取的三种方法(推荐)

    下面小编就为大家带来一篇java 字符串截取的三种方法(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-11-11
  • Spring注解之@Import注解的使用和源码分析

    Spring注解之@Import注解的使用和源码分析

    今天主要介绍Spring @Import注解,在Spring中@Import使用得比较频繁,它得作用是导入bean,具体的导入方式有多种,特别在SpringBoot项目中,很多地方都使用到了@Import注解,感兴趣的小伙伴可以参考阅读
    2023-04-04
  • 如何自定义feign调用实现hystrix超时、异常熔断

    如何自定义feign调用实现hystrix超时、异常熔断

    这篇文章主要介绍了自定义feign调用实现hystrix超时、异常熔断的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • java 画pdf用itext调整表格宽度、自定义各个列宽的方法

    java 画pdf用itext调整表格宽度、自定义各个列宽的方法

    这篇文章主要介绍了java 画pdf用itext调整表格宽度、自定义各个列宽的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01

最新评论