Spring MVC 接收与返回 JSON 数据

Spring MVC 接收与返回 JSON 数据

前言

以下内容是通过书籍中学习，做一下笔记，以此来巩固自己的知识

使用 @RequestBody 注解来接收 JSON 格式的数据，并将其转换成对应的数据类型

使用 Jackson 与 Fastjson 来解析和生成 JSON

---

环境

• 系统：macOS 10.12.5
• 开发工具：Eclipse 4.6.2
• Spring 版本：4.3.9
• Jackson 版本：2.8.9
• Fastjson 版本：1.2.35

---

使用 Jackson

导入相关的 jar 包

• jackson-annotations-2.8.9.jar
• jackson-core-2.8.9.jar
• jackson-databind-2.8.9.jar

配置 Spring MVC 配置文件

    <!-- 设置配置方案 -->
    <mvc:annotation-driven />

使用默认配置，Spring MVC 中默认使用的是 Jackson。故在配置文件中只用默认的转换器就可以了。

Controller 相关代码

@Controller
public class JsonController {
    // @RequestBody 根据 JSON 数据，转换成对应的 Object
    @RequestMapping(value="/jsonTest")
    public void setJson(@RequestBody User user,
            HttpServletResponse response) throws Exception {
        // ObjectMapper 类是 Jackson 库的主要类。它提供一些功能将 Java 对象转换成对应的 JSON 格式的数据
        ObjectMapper mapper = new ObjectMapper();
        user.setSex("男");
        response.setContentType("text/html;charset=UTF-8");
        // 将 user 对象转换成  JSON 写出到客户端
        response.getWriter().println(mapper.writeValueAsString(user));
    }
}

---

使用 fastjson

导入相关的 jar 包

fastjson-1.2.35.jar

配置 Spring MVC 配置文件

    <!-- 设置配置方案 -->
    <mvc:annotation-driven>
        <!-- 设置不使用默认的消息转换器 -->
        <mvc:message-converters register-defaults="false">
            <!-- 配置 Spring 的转换器 -->
            <bean class="org.springframework.http.converter.StringHttpMessageConverter" />
            <bean class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter" />
            <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter" />
            <bean class="org.springframework.http.converter.BufferedImageHttpMessageConverter" />
            <!-- 配置 fastjson 中实现 HttpMessageConverter 接口的转换器 -->
            <!-- FastJsonHttpMessageConverter 是 fastjson 中实现了 HttpMessageConverter 接口的类 -->
            <bean id="fastJsonHttpMessageConverter" 
                class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
                <!-- 加入支持的媒体类型：返回 contentType -->
                <property name="supportedMediaTypes">
                    <list>
                        <!-- 这里顺序不能反，一定先写 text/html,不然 IE 下会出现下载提示 -->
                        <value>text/html;charset=UTF-8</value>
                        <value>application/json;charset=UTF-8</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

Controller 相关代码

@Controller
public class JsonController {
    // @RequestBody 根据 JSON 数据，转换成对应的 Object
    @RequestMapping(value="/fastjsonTest")
    public void setJson(@RequestBody User user,
            HttpServletResponse response) throws Exception {
        // 使用 JSONObject 将 user 对象转换成 json 输出
        user.setSex("男");
        response.setContentType("text/html;charset=UTF-8");
        // 将 user 对象转换成 json 写出到客户端
        response.getWriter().println(JSONObject.toJSONString(user));
    }
}

在实际开发中，更多使用的是 fastjson。

同时，通过 @RequestBody 可以让我们更方便的接收与返回 JSON 数据。（以上两个例子都是通过 @RequestBody 从前台接收数据，下面将举例单纯返回数据）

---

@RequestBody 返回 JSON 数据

环境配置

环境配置同上面的 fastjson 例子

Controller 相关代码

@Controller
public class JsonController {
    @RequestMapping(value="/testRequestBody")
    // @ResponseBody 会将集合数据转换为 json 格式并将其返回客户端
    @ResponseBody
    public Object getJson() {
        List<User> list = new ArrayList<User>();
        list.add(new User("张三","男", 22));
        list.add(new User("李四","男", 33));
        return list;
    }
}

前台通过 ajax 之类的进行交互

---

后记

本文基于个人的学习
分享出来纯当给大家参考一下，也当作自己的笔记

编辑：HochenChong
时间：2017-07-30