信息转换
3.1转换JSON数据
SpringMVC提供了处理JSON格式请求/响应的HttpMessageConverter;
- MappingJackson2HttpMessageConverter。利用Jackson开源类包处理JSON格式的请求或响应消息。
因此只需要在Spring Web容器中为RequestMappingHandlerAdapter装配处理JSON的HttpMessageConverter,并在交互过程中通过请求的Accept指定MIME类型,Spring MVC就可以使服务端的处理方法和客户端JSON格式的消息进行通信了,开发者几乎无需关心通信层数据格式的问题,可以将精力集中到业务处理上面。
org.springframework.web.bind.annotation.RequestBody注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到Conteoller中方法的参数上。
当前台页面使用GET或POST方式提交数据时,数据编码格式由请求头的ContentType指定。可以分为以下几种情况:
- application/x-www-form-urlencoded,这种情况的数据@RequestParam, @ModelAttribute也可以处理,并且很方便,当然@RequestBody也能处理。
- multipart/form-data,@RequestBody不能处理这种格式的数据。
- application/json,application/xml等格式的数据,必须使用@RequestBody来处理。
在实际的开发中使用@RequestBody注解可以很方便地接收JSON格式的数据,并将其转换成对应的数据类型。
Spring的官方文档说明,Spring MVC默认使用MappingJackson2HttpMessageConverter转换JSON格式的数据,jackson开源类包可以非常轻松地将Java对象转换成json对象和xml文档,同样也可以将json对象,xml文档转换成Java对象,读者可以自行下载或者在配套的资源文件中找到Jackson的第三方开源类包。
示例:接收JSON格式的数据
创建一个JsonRequestTest项目,在WebContent目录下创建一个js目录,加入jquery的js文件,在WEB-INF/lib目录中加入Jackson的jar文件。
Java下常见的Json类库有Gson、JSON-lib和Jackson等,Jackson相对来说比较高效,在项目中主要使用Jackson进行JSON和Java对象转换,下面给出一些Jackson的JSON操作方法。
首先去官网下载Jackson工具包,下载地址http://wiki.fasterxml.com/JacksonDownload。Jackson有1.x系列和2.x系列,截止目前2.x系列的最新版本是2.2.3,2.x系列有3个jar包需要下载:
jackson-core-2.2.3.jar(核心jar包,下载地址)
jackson-annotations-2.2.3.jar(该包提供Json注解支持,下载地址)
jackson-databind-2.2.3.jar(下载地址)
新建index.jsp :
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>测试接收JSON格式的数据</title>
<script type="text/javascript" src="js/jquery.min.js"></script>
<script type="text/javascript">
$(document).ready(function(){
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企业应用实战"}),
async: true, //默认设置下,所有请求均为异步请求,如果设置为false,则发送同步请求
//请求成功后的回调函数
success:function(data){
console.log(data);
$("#id").html(data.id);
$("#name").html(data.name);
$("#author").html(data.author);
},
//请求出错时调用的函数
error:function(){
alert("数据发送失败");
}
});
}
</script>
</head>
<body>
编号:<span id="id"></span><br>
书名:<span id="name"></span><br>
作者:<span id="author"></span><br>
</body>
</html>
index.jsp页面代码分析如下:
(1)页面使用jquery发送json数据,在页面的<head>部分,引入了jquery的js文件。
(2)页面载入时调用testRequestBody函数。
(3)testRequestBody函数发送异步请求到"json/testReqquestBody",注意加粗的代码contentType:"application/json",其实表示发送的内容编码格式为json类型:data:JSON.stringify({id:1,name:"Spring MVC企业应用实战"}),表示发送一个json数据;请求成功将返回一个json数据,接到返回的数据后将数据设置到页面的<span>当中。
新建BookController类:
package org.fkit.controller;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.fkit.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import com.fasterxml.jackson.databind.ObjectMapper;
@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));
}
}
setJson方法中的第一个参数@RequestBody Book book表示,使用@RequestBody注释获取到json数据后,将json数据设置到对应的Book对象的属性当中。第二个参数是HttpServletResponse对象,用来输出响应数据到客户端。
前台jsp页面的json数据中传入了id和name,为了测试接收数据,使用logger.info(mapper.writeValueAsString(book));代码将接收到的json数据的book对象打印在控制台上。为了测试传入数据到jsp页面,方法中还给book对象的author对象设置了一个值,并将其写出到客户端。
新建Book类:
package org.fkit.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 + "]";
}
}
Book类中定义3个属性:id,name和author,用于接收jsp页面传入的json数据。toString方法用来输出获取到的数据对象信息。
新建springmvc-config.xml文件:
<?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>
以上配置文件增加了如下配置信息:
(1)<mvc:annotation-driven>会自动注册RequestMappingHandlerMapping与RequestMappingHandlerAdapter两个Bean,这是SpringMVC为@Controllers分发请求所必需的,并提供了数据绑定支持,@NumberFormnatannotation支持,@DataTimeFormat支持,@Valid支持,读写XML支持(JAXB)和读写JSON的支持(默认Jackson)等功能。本例处理ajax请求时,就使用到了对JSON的支持功能。
(2)<mvc:default-servlet-handler/>使用默认的Servlet来响应静态文件,因为在web.xml中使用了DispatcherServlet截获所有请求url,而引入<script type="text/javascript" src="js/jquery-1.11.0.min.js"/>的时候,DispatcherServlet会将"/"看成请求路径,找不到它的时候会报404错误。而当配置文件加上这个默认的Servlet时,Servlet再找不到它时会去找静态的内容,即js目录。
此外,还需要在web.xml文件中配置Spring MVC的前端控制器DispatcherServlet,因为每次配置基本一致,故此处不再赘述,可自行配置。
部署JsonRequestTest这个Web应用,在浏览器中输入如下URL来测试应用:
http://localhost:8080/JsonRequestTest/index.jsp
载入index.jsp页面时会送ajax请求,传递json数据,BookController接收到请求后,@RequestBody注解会将json数据设置到Book参数对应的属性当中,控制台输出如下:
可以看到,json数据传递的id和name被赋值到Book对象的属性中。接下来,setJson方法给Book对象的author属性设置了值,并将Book对象转换成json写出到客户端。
请求响应如图所示,表示SpringMVC成功将json数据写出到客户端。
可以看到,Book对象被以json格式成功写回客户端。
示例:自定义HttpMessageConverter接收JSON格式的数据
Spring默认使用Jackson处理json数据。在实际开发中,也可以使用其他开源类包处理json数据。那么如果使用其他开源类包处理json,该如何配置HttpMessageConverter呢?接下来,我们就使用在业界非常受欢迎的fastjson来接收json数据。
创建一个JsonRequest2Test项目,在WebContent目录下创建一个js目录,加入jquery的js文件,在WEB-INF/lib目录中加入fastjson的jar文件。
最新发布版本jar包 1.2.23 下载地址: 点击下载
新建BookController:
package org.fkit.controller;
import javax.servlet.http.HttpServletResponse;
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 org.fkit.domain.Book;
import com.alibaba.fastjson.JSONObject;
@Controller
@RequestMapping("/json")
public class 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,maps,java,arrays和xml和json互相转换的包
//使用JSONObject将book对象转换成json输出
logger.info(JSONObject.toJSONString(book));
book.setAuthor("肖文姬");
response.setContentType("text/html;charset=UTF-8");
//将book对象转换成json写出到客户端
response.getWriter().println(JSONObject.toJSONString(book));
}
}
新建springmvc-config.xml:
<?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"/>
<!-- 使用默认的Servlet来响应静态文件 -->
<mvc:default-servlet-handler/>
<!-- 设置配置方案 -->
<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.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>
<!-- 视图解析器 -->
<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中默认的Mapping-Jackson2HttpMessageConverter,
这样只需要配置默认的<mvc:annotation-driven/>就可以了。而现在使用了第三方的fastjson处理json数据,则需要另行配置HttpMessageConverter.
<mvc:message-converters register-defaults="false">设置不使用默认的消息转换器。在Spring的官方文档中有这样一句话:
The MappingJackson2Json View uses the Jackson library's ObjectMapper to render the response content as JSON
这段话的意思是:SpringMVC默认使用MappingJackson2JsonView转换器,所以必须加入Jackson这个库的第三方类文件。而在实际开发中,更加受欢迎的是fastjson,所以本例并没有使用Jackson而是使用了fastjson,则转换器需要配置成com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter类型,FastJsonHttpMessageConverter是fastjson中实现了HttpMessageConverter接口的类。
此外,其他的jsp和java文件和之前的项目的一致,并且还需要在web.xml文件中配置SpringMVC的前端控制器DispatcherServlet,因为每次配置基本一致,故此处不在赘述,读者可自行配置。
部署JsonRequest2Test这个Web应用,在浏览器中输入如下URL来测试应用:
http://localhost:8080/JsonRequest2Test/index.jsp
由此可知,处理json格式的开源类包使用Jackson和fastjson,只是需要使用不同的HttpMessageConverter罢了。
org.springframework.web.bind.annotation.ResponseBody注解用于将Controller的方法返回的对象,通过适当的消息转换器转换为指定格式后,写入到Response对象的body数据区。通常当返回的数据不是html标签的页面,而是其他某种格式的数据时使用它。
示例:返回JSON格式的数据
创建一个JsonResponseTest项目,在WebContent目录下创建一个js目录,加入jquery的js文件,在WEB-INF/lib目录中加入Jackson的jar文件以及spring框架的jar包。
创建BookConteoller:
package org.fkit.controller;
import java.util.ArrayList;
import java.util.List;
import org.fkit.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping("/json")
public class BookController {
@RequestMapping(value="/testRequestBody")
//@ResponseBody会将集合数据转换为json格式并将其返回客户端
@ResponseBody
public Object getJson(){
List<Book> list= new ArrayList<Book>();
list.add(new Book(1,"Spring MVC企业应用实战", "肖文姬"));
list.add(new Book(2,"轻量级JavaEE企业应用实战", "李刚"));
return list;
}
}
getJson方法会将List集合数据转换成json格式,然后将其返回到客户端。
创建index.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>测试返回JSON格式的数据</title>
<script type="text/javascript" src="js/jquery.min.js"></script>
<script type="text/javascript">
$(document).ready(function(){
testRequestBody();
});
function testRequestBody(){
$.post("${pageContext.request.contextPath}/json/testRequestBody",null,
//发送请求的URL字符串
function(data){
$.each(data,function(){
var tr=$("<tr align='center'>");
$("<td/>").html(this.id).appendTo(tr);
$("<td/>").html(this.name).appendTo(tr);
$("<td/>").html(this.author).appendTo(tr);
$("#booktable").append(tr);
})
},"json");
}
</script>
</head>
<body>
<table id="booktable" border="1" style="border-collapse:collapse;">
<tr align="center">
<th>编号</th>
<th>书名</th>
<th>作者</th>
</tr>
</table>
</body>
</html>
index.jsp页面代码分析如下:
(1)页面使用jquery发送请求,在页面的<head>部分,引入了jquery的js文件。
(2)载入页面时调用testResponseBody函数。
(3)testResponseBody函数发送异步请求到"json/testRequestBody",请求成功将返回一个json数据,该数据包含多个书籍信息。接到返回的数据后使用jquery将数据设置到页面的<table>表单中。
此外,还需要在web.xml文件中配置Spring MVC的前端控制器DispatcherServlet,因为每次配置基本一致,故此处不再赘述,可自行配置。
同时Spring MVC还需要springmvc-config.xml配置文件,该文件内容和JsonRequetTest项目中的springmvc-config.xml文件一致,读者可自行配置。
部署JsonRequestTest这个Web应用,在浏览器中输入如下URL来测试应用:
http://localhost:8080/JsonReponseTest/index.jsp
载入index.jsp页面时会发送ajax请求,getJson方法创建多个Book对象并将其封装到List集合中返回,方法上的@ResponseBody注解会将集合数据转换为json格式数据并将其返回客户端。
请求响应如下,表示SpringMVC成功将json数据鞋到了客户端。
可以看到,包含Book对象的集合被转换成json数并被成功写回客户端。
示例:自定义HttpMessageConverter返回JSON格式的数据
接下来,使用fastjson来返回json数据。
创建一个JsonResponse2Test项目,在WebContent目录下创建一个js目录,加入jquery的js文件,在WEB-INF/lib目录中加入fastjson的jar文件。开发者可自行下载fastjson的第三方开源类包。
JsonResponse2Test项目的所有jsp和javaa文件和JsonResponseTest一致,只是在springmvc-config.xml中使用了fastjson的FastjsonHttpMessageConverter,此处不在赘述。