SpringMVC 返回json的两种方式

时间 2019-12-01

标签 springmvc 返回 json 两种方式栏目 Spring 繁體版

原文原文链接

先后台数据交互使用json是一种很重要的方式.本文主要探讨SpringMVC框架使用json传输的技术.html

请注意,本文所提到的项目使用Spring 版本是4.1.7,其余版本在具体使用上可能有不同的状况.java

1、最多见——使用@RequestBody的注解返回一个实体对象;jquery

使用方式以下:ajax

1:引入jar包：json

jackson-core、jackson-databind、jackson-annotion;浏览器

Spring4以上的版本这么配置,须要jackson的版本在2以上.tomcat

maven依赖mvc

<properties>
    <jackson.version>2.7.3</jackson.version>
</properties>


<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>${jackson.version}</version>
        </dependency>

2:Spring配置:app

<mvc:annotation-driven/>

Spring4以上版本使用 <mvc:annotation-driven/>即包含了默认的配置,可以转化json,其余版本可能须要额外配置.框架

3:后台:

@RequestMapping("/entity")
    public @ResponseBody Entity returnJson(){
        return new Entity("chentao","A handsome man");
    }

关键就是@ResponseBody注解,不然Spring会去映射与路径匹配的jsp文件

4:前台

这个路径是能够直接调用的,结果会直接输出到,可是通常来讲,会使用jquery Ajax来获取数据:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Welcome Page</title>
    <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations -->
    <script
            src="https://code.jquery.com/jquery-3.2.1.min.js"
            integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="
            crossorigin="anonymous"></script>
</head>
<body>
     <h2>Hello World!</h2>
<div id="div1">
</div>
</body>
<script> $.get("/json/entity",function (data) { $("#div1").html(data); }) </script>
</html>

结果

a:不添加@ResponseBody注解的状况,经过连接注解访问:

能够看到Spring MVC框架这个时候去找/json/entity.jsp这个文件的.

b:添加@ResponseBody注解后:

json数据能正确返回了.

2、更加灵活的方式——将json数据放进Request中交互。

Spring MVC使用@ResponseBody的方式确实很简单，可是咱们有时也会遇到这样的场景，就是访问一个新页面时，可能既要找到新的页面又要拿到新的数据去绘制页面。

这种时候若是使用@ResponseBody这种方式，那么就须要使用ajax技术，向后台请求两次，一次请求页面，一次请求数据。

若是但愿经过一次请求就完成这个目标，那么就应该返回一个ModelAndView的对象，这样SpringMVC既能够跳转到一个页面，也能把数据传输到Request中。

使用方式：

1：相关jar包：

使用对象转化为Json的相关jar包，通常来讲使用的时json-lib，实际上相似的框架和技术还有不少，好比上面的jackson就能作，不过笔者习惯于使用json-lib，使用起来会更方便和顺手一点。

maven:

<!-- https://mvnrepository.com/artifact/net.sf.json-lib/json-lib -->
        <dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <version>2.4</version>
        </dependency>

2：Spring 配置：无

3：后台：

@RequestMapping("/page")
    public ModelAndView returnView(){
        ModelAndView mv = new ModelAndView();
        mv.setViewName("showJson");

        Entity entity = new Entity("chentao","a handsome man");

        JSONObject entityJson = JSONObject.fromObject(entity);

        mv.addObject("entityJson",entityJson);
        return mv;
    }

关键是JSONObject.fromObject()方法。

4：前台：

<script>
    var json = ${entityJson};
    alert(json);
</script>

注意这里的El表达式写法${entityJson},浏览器在进行渲染以前，tomcat已经将${entityJson}替换为json字符串。这个时候json直接就是一个可使用的对象而再也不须要进行转化

结果以下；

注意，这种方式只有在jsp页面中才有效果，若是不是jsp页面，只能乖乖使用第一种方式了。

3、总结

	@Response注解的方式	返回ModelAndView方式
优势	编写简单；适合当前ajax方式；	更加灵活，页面和数据一同返回。
缺点	灵活性不足	须要手动转化json；前台接受数据只能用在jsp页面里。
实现要点	@ResponseBody;jackson-jar包；ajax；	JsonObject.fromObject();El表达式：${}.

4、扩展

本文档使用的是SpringMVC框架，实际上第一种方式本质上是使用Response的writer对象来传递数据，而第二种方式使用request传递数据。因此若是使用原生servlet或者其余框架也是可以实现相似的功能的。