6.1 转换 JSON 数据
Spring MVC 提供了处理 JSON 格式请求/响应的 HttpMessageConverter：
- MappingJackson2HttpMessageConverter 利用 Jackson 开源类包处理 JSON 格式的请求或响应信息。
因此只需要在 Spring Web 容器中为 RequestMappingHandlerAdapter 装配处理 JSON 的 HttpMessageConverter，并在交互过程中通过请求的 Accept 指定 MIME 类型，Spring MVC 就可以使服务端的处理方法和客户端 JSON 格式的消息进行通信了，开发者几乎无需关心通信层数据格式的问题，可以将精力集中到业务处理上面。
org.springframework.web.bind.annotation.RequestBody 注解用于读取 Request 请求的 body 部分数据，使用系统默认配置的 HttpMessageConverter 进行解析，然后把相应的数据绑定到 Controller 中方法的参数上。
当前台页面使用 GET 或 POST 方式提交数据时，数据编码格式由请求头的 ContentType 指定。可以分为一下几种情况：
- application/x-www-form-urlencoded ，这种情况的数据 @RequestParam、@ModelAtrribute 也可以处理，并且很方便，当然 @RequestBody 也能处理。
- multipart/form-data，@RequestBody 不能处理这种格式的数据。
- application/json、application/xml 等格式的数据，必须使用 @RequestBody 来处理。
在实际开发工作中，使用 @RequestBody 注解可以很方便地接收 JSON 格式的数据，并将其转换成对应的数据类型。
在 Spring 官方文档中，Spring MVC 默认使用 MappingJackson2HttpMessageConverter 转换 JSON 格式的数据。
6.1.1 接收 JSON 格式的数据
创建好项目后，在 WEB-INF/lib 目录下加入 Jackson 的 jar 文件，并在 web 目录下创建一个 js 目录，加入 jquery 和 json2 的 js 文件。
1. 创建一个 jsp 页面，通过 jquery 发送 json 数据。
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>测试接收JSON格式的数据</title>
<!-- 引入 jquery 和 json2 的 js 文件 -->
<script type="text/javascript" src="js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="js/json2.js"></script>
<script type="text/javascript">
$(document).ready(function(){
testRequestBody();
});
// 发送异步请求到“json/testRequestBody”
function testRequestBody(){
$.ajax("${pageContext.request.contextPath}/json/testRequestBody",// 发送请求的URL字符串。
{
dataType : "json", // 预期服务器返回的数据类型。
type : "post", // 请求方式 POST或GET
contentType:"application/json", // 发送信息至服务器时的内容编码类型
// 发送到服务器的数据。
data:JSON.stringify({"id" : 1, "name" : "Spring MVC企业应用实战"}),// 发送一个 json 数据
async: true , // 默认设置下，所有请求均为异步请求。如果设置为false，则发送同步请求
// 请求成功后的回调函数。
success :function(data){
// 将接受的返回数据设置到页面的<span>中
console.log(data);
$("#id").html(data.id);
$("#name").html(data.name);
},
// 请求出错时调用的函数
error:function(){
alert("数据发送失败");
}
});
}
</script>
</head>
<body>
编号：<span id="id"></span><br>
书名：<span id="name"></span><br>
作者：<span id="author"></span>
</body>
</html>
2. 创建一个 Controller 类负责接收 json 数据。
package controller;
import javax.servlet.http.HttpServletResponse;
import domain.Book;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.codehaus.jackson.map.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/json")
public class BookController {
private static final Log logger = LogFactory.getLog(BookController.class);
// @RequestBody根据json数据，转换成对应的Object
@RequestMapping(value="/testRequestBody")
public void setJson(@RequestBody Book book,
HttpServletResponse response) throws Exception{
// ObjectMapper类是Jackson库的主要类。它提供一些功能将Java对象转换成对应的JSON格式的数据
ObjectMapper mapper = new ObjectMapper();
// 将book对象转换成json输出
logger.info(mapper.writeValueAsString(book) );
book.setAuthor("肖文吉");
response.setContentType("text/html;charset=UTF-8");
// 将book对象转换成json写出到客户端
response.getWriter().println(mapper.writeValueAsString(book));
}
}
使用 @RequestBody 注解获取到 json 数据后，将 json 数据设置到对应的 Book 对象的属性当中。第二个参数是 HttpServletResponse 对象，用来输出响应数据到客户端。
3. 创建 Book 类。
用于接收 jsp 页面传入的 json 数据。toString 方法用来输出获取到的数据对象信息。
package domain;
import java.io.Serializable;
public class Book implements Serializable {
private Integer id;
private String name;
private String author;
public Book(){
super();
}
public Book(Integer id , String name , String author){
super();
this.id = id;
this.name = name;
this.author = author;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
@Override
public String toString() {
return "Book [id=" + id + ", name=" + name + ", author=" + author + "]";
}
}
4. 修改 mvc 配置文件。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.2.xsd">
<!-- spring可以自动去扫描base-pack下面的包或者子包下面的java文件，
如果扫描到有Spring的相关注解的类，则把这些类注册为Spring的bean -->
<context:component-scan base-package="org.fkit.controller"/>
<!-- 设置配置方案 -->
<mvc:annotation-driven/>
<!-- 使用默认的Servlet来响应静态文件 -->
<mvc:default-servlet-handler/>
<!-- 视图解析器 -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix">
<value>/WEB-INF/content/</value>
</property>
<!-- 后缀 -->
<property name="suffix">
<value>.jsp</value>
</property>
</bean>
</beans>
<mvc:annotation-driven/> 会自动注册 RequestMappingHandlerMapping 与 RequestMappingHandlerAdapter 两个 Bean，这是 Spring MVC 为 @Controllers 分发请求所必需的，并提供了数据绑定支持、@NumberFormatannotation 支持、@DateTimeFormat 支持、@Valid 支持、读写 XML 的支持（JAXB） 和读写 JSON 的支持（默认 jackson）等功能。
<mvc:default-servlet-handler/> 使用默认的 Servlet 来响应静态文件，因为在 web.xml 中使用了 DispatcherServlet 截获所有请求 url ， 而引入 <script type="text/javascript" src="js/jquery-1.11.0.min.js"/> 的时候，DispathcerServlet 会将 “/” 看成请求路径，找不到它的时候就会报 404 错误。而当配置文件加上这个默认 Servlet 的时候，Servlet 在找不到它时会去找静态的内容，即 js 目录。
6.1.2 自定义 HttpMessageConverter 接收 JSON 格式的数据
Spring 默认使用 Jackson 处理 json 数据。在实际开发中，也可以使用其他开源类包处理 json 数据。
以使用阿里巴巴的 fastjson 为例：
创建好项目后，在 WEB-INF/lib 目录下加入 fastjson的 jar 文件，并在 web 目录下创建一个 js 目录，加入 jquery 和 json2 的 js 文件。
package controller;
import com.alibaba.fastjson.JSONObject;
import domain.Book;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpServletResponse;
@Controller
@RequestMapping(value = "/json")
public class BookController {
public BookController(){}
private static final Log logger = LogFactory.getLog(BookController.class);
@RequestMapping(value = "/testRequestBody")
public void setJson(@RequestBody Book book , HttpServletResponse response) throws Exception{
//JSONObject-lib 包是一个beans，collections，map，java arrays 和 xml 和 JSON 互相转换的包
//使用 JSONObject 将 book 对象转换成 json 输出
logger.info(JSONObject.toJSONString(book));
System.out.println(book.toString());
response.setContentType("text/html;charset=UTF-8");
//将 book 对象转换成 json 写出到客户端
response.getWriter().print(JSONObject.toJSONString(book));
}
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:content="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<content:component-scan base-package="controller"/>
<!-- 使用默认的 Servlet 来响应静态文件 -->
<mvc:default-servlet-handler/>
<!-- 设置配置方案 -->
<mvc:annotation-driven>
<!-- 设置不使用默认的消息转换器 -->
<mvc:message-converters register-defaults="false">
<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>
<!-- 这里顺序不能反，不然 IE 下会出现下载提示 -->
<value>text/html;charset=UTF-8</value>
<value>application/json;charset=UTF-8</value>
</list>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<!-- 视图解析器 -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix">
<value>/WEB-INF/content/</value>
</property>
<!-- 后缀 -->
<property name="suffix">
<value>.jsp</value>
</property>
</bean>
</beans>
以上配置文件和之前的配置文件重点的区别在于，之前使用的时 Spring 中默认的 MappingJackson2HttpMessageConverter，这样只需要配置默认的 <mvc:annotation-driven/> 就可以了。而现在使用了第三方的 fastjson 处理 json 数据，则需要另行配置 HttpMessageConverter。
<mvc:message-converters register-defaults="false"> 设置不使用默认的消息转换器，因为 Spring MVC 默认使用 MappingJsckson2JsonView 转换器，所以必须加入 Jackson 这个库的第三方类文件。其他文件和 6.1.1 基本一致。
总结： 处理 json 格式的开源类包使用 Jackson 和 fastjson，只是需要使用不同的 HttpMessageConverter 罢了。org.springframework.web.bind.annotation.ResponseBody 注解用于将 Controller 的方法返回的对象，通过适当的消息转换器转换为指定格式后，写入到 Response 对象的 body 数据区。通常当返回的数据不是 html 标签的页面，而是其他某种格式的数据时（如 json、xml等）使用它。
496
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
