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的资料请关注脚本之家其它相关文章!

相关文章

  • IDEA:Error running,Command line is too long.解决方案

    IDEA:Error running,Command line is too&n

    这篇文章主要介绍了IDEA:Error running,Command line is too long.解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • Java阻塞延迟队列DelayQueue原理及使用详解

    Java阻塞延迟队列DelayQueue原理及使用详解

    这篇文章主要介绍了Java阻塞延迟队列DelayQueue原理及使用详解,阻塞队列是一个支持两个附加操作的队列,这两个附加的操作是:在队列为空时,从队列中获取元素的消费者线程会一直等待直到队列变为非空,需要的朋友可以参考下
    2023-12-12
  • 基于Process#waitFor()阻塞问题的解决

    基于Process#waitFor()阻塞问题的解决

    这篇文章主要介绍了Process#waitFor()阻塞问题的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Java HtmlEmail 邮件发送的简单实现代码

    Java HtmlEmail 邮件发送的简单实现代码

    下面小编就为大家带来一篇Java HtmlEmail 邮件发送的简单实现代码。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • Spring AOP利用切面实现日志保存的示例详解

    Spring AOP利用切面实现日志保存的示例详解

    最近领导让写个用切面实现日志保存,经过调研和亲测,以完美解决。在这里分享给大家,给有需要的码友直接使用,希望对大家有所帮助
    2022-11-11
  • Spring中@DependsOn注解的使用代码实例

    Spring中@DependsOn注解的使用代码实例

    这篇文章主要介绍了Spring中@DependsOn注解的使用代码实例,Spring中@DependsOn,主要是使用在类和方法上, 作用是当前对象要依赖另外一些对象,被依赖的对象会先注册到Spring的IOC容器中,需要的朋友可以参考下
    2024-01-01
  • Spring的UnsatisfiedDependencyException异常的解决

    Spring的UnsatisfiedDependencyException异常的解决

    在使用Spring框架开发应用程序时,我们经常会遇到各种异常,本文主要介绍了Spring的UnsatisfiedDependencyException异常的解决,感兴趣的可以了解一下
    2023-11-11
  • 解决在IDEA下使用JUnit的问题(解决过程)

    解决在IDEA下使用JUnit的问题(解决过程)

    很多朋友跟小编反馈在IDEA下使用JUnit进行实例测试的时候出现很多奇葩问题,今天小编通过本文给大家分享idea使用JUnit出现问题及解决过程,感兴趣的朋友跟随小编一起看看吧
    2021-05-05
  • 深入学习Java 热部署的知识

    深入学习Java 热部署的知识

    对于Java应用程序来说,热部署就是在运行时更新Java类文件。在基于Java的应用服务器实现热部署的过程中,类装入器扮演着重要的角色。大多数基于Java的应用服务器,包括EJB服务器和Servlet容器,都支持热部署。,需要的朋友可以参考下
    2019-06-06
  • 解决spring中redistemplate不能用通配符keys查出相应Key的问题

    解决spring中redistemplate不能用通配符keys查出相应Key的问题

    这篇文章主要介绍了解决spring中redistemplate不能用通配符keys查出相应Key的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11

最新评论