springmvc不同的url后缀返回不同格式的数据
Spring3.x中定义一个控制器类,必须以@Controller注解标记。当控制器类接收到一个请求时,它会在自己内部寻找一个合适的处理方 法来处理请求。使用@RequestMapping注解将方法映射到一些请求上,以便让该方法处理那些请求。这种方法就像一般的类中的方法,方法名参数列 表和返回值并不像Struts2之类的框架有很强的限制。方法参数列表具体以及返回值具体都有哪些,这里先不细说。这篇博客的目的在于简单介绍如何快速上 手使用Spring MVC框架。
控制器在选择好适合处理请求的方法时,传入收到的请求(根据方法参数类型,可能以不同的类型传入),并且 调用该方法中的逻辑来进行处理(也可以是调用Service来真正处理)。方法逻辑可能也会在参数中添加或者删除数据。处理方法处理完之后,会委派给一个 视图,由该视图来处理方法的返回值。处理程序的返回值并不代表视图的具体实现,可以只是String类型,代表视图名,甚至是void(这时候 Spring MVC可以根据方法名或者控制器名找默认视图)。也不需要担心返回值只是视图名称的话,视图拿不到要显示的数据。因为方法参数对于视图来说也是可以拿到 的。比如说,如果处理方法以Map为参数,那么这个Map对于视图也是可以拿到的。
返回的视图名称会返回给DispatcherServlet,它会根据一个视图解析器将视图名称解析为一个具体的视图实现。这里说到的视图解析器是一个实现了ViewResolver借口的Bean,它的任务就是返回一个视图的具体实现(HTML、jsonp、json等等).
配置根据不同的url后缀返回不同格式的数据
<entry key="json" value="application/json"/>
<entry key="jsonp" value="application/javascript"/>
<entry key="xml" value="application/xml"/>
<entry key="html" value="text/html"/>
如 :www.xx.com/123.json 返回application/json格式数据
www.xx.com/123.jsonp 返回application/javascript格式数据
servlet.xml配置如下:
<!-- 对模型视图名称的解析,在请求时模型视图名称添加前后缀 --> <bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver"> <property name="order" value="1"/> <property name="mediaTypes"> <map> <entry key="json" value="application/json"/> <entry key="jsonp" value="application/javascript"/> </map> </property> <property name="viewResolvers"> <list> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/> <property name="prefix" value="/WEB-INF/manage/"/> <property name="suffix" value=".jsp"/> </bean> </list> </property> <property name="defaultViews"> <list> <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" > <property name="disableCaching" value="false"></property> </bean> <bean class="com.xx.jos.application.core.common.defaultview.MappingJacksonJsonpView"> <property name="disableCaching" value="false"></property> </bean> </list> </property> </bean>
Spring 3.2.4.RELEASE的最新配置
<!--1、检查扩展名(如my.pdf);2、检查Parameter(如my?format=pdf);3、检查Accept Header--> <bean id= "contentNegotiationManager" class= "org.springframework.web.accept.ContentNegotiationManagerFactoryBean"> <!-- 扩展名至mimeType的映射,即 /user.json => application/json --> <property name= "favorPathExtension" value= "true" /> <!-- 用于开启 /userinfo/123?format=json 的支持 --> <property name= "favorParameter" value= "true" /> <property name= "parameterName" value= "format"/> <!-- 是否忽略Accept Header --> <property name= "ignoreAcceptHeader" value= "false"/> <property name= "mediaTypes"> <!--扩展名到MIME的映射;favorPathExtension, favorParameter是true时起作用 --> <value> json=application/json jsonp=application/javascript </value> </property> <!-- 默认的content type --> <property name= "defaultContentType" value= "text/html" /> </bean> <!-- ========================= VIEW定义 ========================= --> <!-- 内容协商视图解析器;根据客户端不同的请求决定不同的view进行响应 --> <!-- 会自动根据解析的contentType来决定使用哪个视图解析器(默认使用整个web应用中的viewResolver) --> <bean class= "org.springframework.web.servlet.view.ContentNegotiatingViewResolver"> <property name="order" value="0"/> <!-- 内容协商管理器 用于决定media type --> <property name= "contentNegotiationManager" ref= "contentNegotiationManager"/> <!-- 默认视图 放在解析链最后 --> <property name="defaultViews"> <list> <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" > <property name="disableCaching" value="false"></property> </bean> <bean class="com.xx.jos.application.core.common.defaultview.MappingJacksonJsonpView"> <property name="disableCaching" value="false"></property> </bean> </list> </property> </bean> <!-- bean name view resolver--> <bean class= "org.springframework.web.servlet.view.BeanNameViewResolver"> <property name="order" value="1"/> </bean> <!-- 默认的视图解析器 在上边的解析错误时使用 (默认使用 html)- --> <bean id= "defaultViewResolver" class= "org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="order" value="2"/> <property name= "viewClass" value= "org.springframework.web.servlet.view.JstlView"/> <property name= "contentType" value= "text/html"/> <property name= "prefix" value= "/WEB-INF/manage/"/> <property name= "suffix" value= ".jsp"/> </bean> <!--在mvc:annotation-driven里面配置使用内容协商--> <mvc:annotation-driven content-negotiation-manager= "contentNegotiationManager"/>
MappingJacksonJsonpView代码如下:
package com.xx.jos.application.core.common.defaultview; import org.apache.log4j.Logger; import org.springframework.web.servlet.view.json.MappingJacksonJsonView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.Map; public class MappingJacksonJsonpView extends MappingJacksonJsonView { /** * Default content type. Overridable as bean property. support jsonp */ public static final String DEFAULT_CONTENT_TYPE = "application/javascript"; private Logger log = Logger.getLogger(MappingJacksonJsonpView.class); @Override public String getContentType() { return DEFAULT_CONTENT_TYPE; } /** * Prepares the view given the specified model, merging it with static * attributes and a RequestContext attribute, if necessary. * Delegates to renderMergedOutputModel for the actual rendering. * @see #renderMergedOutputModel */ @Override public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception { if("GET".equals(request.getMethod().toUpperCase())) { @SuppressWarnings("unchecked") Map<String, String[]> params = request.getParameterMap(); try { if(params.containsKey("callback")) { response.getOutputStream().write(new String(params.get("callback")[0] + "(").getBytes()); super.render(model, request, response); response.getOutputStream().write(new String(");").getBytes()); response.setContentType("application/javascript"); } else { super.render(model, request, response); } } catch (Exception e) { // TODO: handle exception e.printStackTrace(); } } else { super.render(model, request, response); } } }