本文重点总结了Spring MVC中JSON格式数据的转换。主要通过@RequestBody注解来实现,利用Spring MVC的默认的信息转化器来实现。如果需要使用不同的信息转化器,则需要对配置文件进行修改。本文重点介绍@RequestBody
的使用和配置文件的理解和修改。
信息转换器与
@RequestBody
注解
这里的信息转换是指:
请求中的JSON数据
--->转化为对象
-->将对象输出为 JSON 数据
它使Spring MVC服务端(具体指controller文件中)能够和客户端JSON格式的消息进行通信,这样开发者就不需要关心通信层数据格式的问题。
HttpMessageConvert<T>
是Spring3.0之后新增的一个重要接口,它负责将请求信息转换为一个对象(类型为T),并将对象绑定到请求方法的参数中或输出为响应信息。
而MappingJackson2HttpMessageConverter
(针对JSON的一种信息转换器,实现了HttpMessageConvert接口
)可以处理JSON格式的请求或者响应信息。
@RequestBody
注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter
进行解析(这里是指使用MappingJackson2HttpMessageConverter
来解析JSON数据),然后把响应的数据绑定到Controller中方法的参数上。
(注:配置文件在后面会进行详细说明)
信息转化的大致流程
假如有一个Book类,具有id
、name
、author
属性(当然还定义了setter和getter以及用于打印的toString()方法)。假如在request请求中有{id:1,name:"Spring MVC实战"}
这样的以json格式发送过来的数据。
@RequestMapping(value = "/testRequestBody")
public void setJson(@RequestBody Book book,HttpServletResponse response) throws Exception{
...
}
这里通过@RequestBody
注解获取到Json数据后,就会相应地将数据设置到对应的Book对象的属性中。
而@ResponseBody
注解又可以将List集合数据转换为Json格式。然后将其返回到客户端。也即是说,此时可以通过EL表达式获取id等属性。这和之前的有什么区别呢。
URl请求
--->Controller
--->JSP页面
可以说之前的@RequestParam
等注解让我们在Controller文件中可以方便地读取到URI请求信息。如果后续要使用这些信息,我们可以手动封装一个对象,并保存到Model(Servlet技术是保存在session域中)。这样在JSP页面就可以通过requestScope,从Model的属性中访问到保存的对象。这么婉转的操作无非就是为了在JSP页面获取Servlet中保存的对象(的信息)。
而现在使用了@ResponseBody以后,这个问题也很好的解决了。会自动创建
一个对象,并且将参数映射到
对象的属性
中去。并且@ResponseBody可以将Controller返回的对象通过适当的消息转换器转换为json格式后,写入到Response对象的body数据区。
关于配置文件:
在配置文件中需要配置处理器映射器、处理器适配器、视图解析器(当然如果使用默认的可以不在配置文件中写出)。下面列出基于接口的控制器
和基于注解的控制器@Controller
在配置文件中的配置选项。
基于接口的控制器:
BeanNameUrlHandlerMapping
(处理器映射器)SimpleControllerHandlerAdapter
(处理器适配器)- InternalResourceViewResolver (视图解析器)
基于注解的控制器:
RequestMappingHandlerMapping
(处理器映射器)RequestMappingHandlerAdapter
(处理器适配器)- InternalResourceViewResolver(视图解析器)
可以看到,使用的是不同的处理映射器和处理器适配器。而视图解析器是相同的配置。其实相同才是常态,因为在DispatcherServlet.properties配置文件列出的默认组件中,本地化解析器、主题解析器、视图名称解析器、视图解析器都只有一个。只有处理器映射器、处理器适配器、异常处理器才有多个。
上面说过,如果保持默认配置,那么不需要再Spring MVC的配置文件中写出来。只需要对个性化的部分进行修改即可。
例如修改视图解析器InternalResourceViewResolver
,使得Controller返回的字符串能对应跳转到JSP页面。这个功能可以通过设置InternalResourceViewResolver
的前缀和后缀来实现,让Controller返回的字符串如"helloWorld"
自动跳转到/WEB-INF/content/helloWorld.jsp
页面(这里设置的前缀为“WEB-INF”,后缀为“.jsp”)。
配置文件中与信息转换相关的内容
回到信息转化的内容,HttpMessageConverter
是被RequestMappingHandlerAdapter
所使用。换句话说,HttpMessageConverter
相当于是RequestMappingHandlerAdapter
的一个属性。
RequestMappingHandlerAdapter
默认装配了以下的HttpMessageConverter
:
- StringHttpMessageConverter
- ByteArrayHttpMessageConverter
- SourceHttpMessageConverter
- XmlAwareFormHttpMessageConverter
而Spring MVC中还默认使用MappingJackson2HttpMessageConverter
来转换JSON格式的数据。如果省略每个组件的具体包路径,那么配置文件可以简写如下:
...
<bean class = ".RequestMappingHandlerAdapter">
<property name="messageConverters">
<list>
<bean class=".StringHttpMessageConverter"/>
<bean class=".XmlAwareFormHttpMessageConverter"/>
<bean class=".BufferedImageHttpMessageConverter"/>
</list>
</property>
</bean>
如果需要使用第三方的fastjson
处理json数据,需要添加消息转换器FastJsonHttpMessageConverter
,将HttpMessageConverter
另行配置如下:
//使用默认的Servlet来响应静态文件
<mvc:default-servlet-handler/>
//设置配置方案,<mvc:annotation-driven>是一种简写,下文会有解释
<mvc:annotation-driven>
//不使用默认的消息转换器
<mvc:message-converters register-defaults="false">
<bean class=".StringHttpMessageConverter"/>
<bean class=".XmlAwareFormHttpMessageConverter"/>
<bean class=".ByteArrayHttpMessageConverter"/>
<bean class=".BufferedImageHttpMessageConverter"/>
<bean id="fastJsonHttpMessageConverter" class=".FastJsonHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
//这里顺序不能写反,一定要先写text/html;
<value>text/htm;charset=UTF-8</value>
<value>application/json;charsest=UTF-8</value>
</list>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<mvc:annotation-driven /> 是一种简写形式,它会自动注册DefaultAnnotationHandlerMapping
与AnnotationMethodHandlerAdapter
两个bean。
网友评论