SpringMVC 使用ContentNegotiatingViewResolver整合多种视图解析器

之前的文章里，定义了多种视图解析器，可以使用ContentNegotiatingViewResolver进行视图整合。

配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"
	xmlns:util="http://www.springframework.org/schema/util"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
		http://www.springframework.org/schema/beans/spring-beans-4.1.xsd 
		http://www.springframework.org/schema/context 
		http://www.springframework.org/schema/context/spring-context-4.1.xsd 
		http://www.springframework.org/schema/mvc 
		http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
		http://www.springframework.org/schema/util
		http://www.springframework.org/schema/util/spring-util-4.0.xsd">
	
	<!-- 扫描的包 -->
	<context:component-scan base-package="com.smart.web"/>
	
	
	<!-- HandlerMapping和HandlerAdapter及数据转换器配置 -->	
    <mvc:annotation-driven conversion-service="conversionService">
    	<mvc:message-converters register-defaults="true">
    		<bean class="org.springframework.http.converter.BufferedImageHttpMessageConverter"/>
       		<bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter" />
            <bean class="org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.xml.MarshallingHttpMessageConverter"
                p:marshaller-ref="xmlMarshaller" p:unmarshaller-ref="xmlMarshaller">
            </bean>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
    	</mvc:message-converters>
    </mvc:annotation-driven>
    <!-- 数据转换器 -->
	<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
		<property name="converters">
			<list>
				<bean class="com.smart.domain.StringToUserConvert" />
			</list>
		</property>
	</bean>      
	 <!-- xml消息转换器 -->         
    <bean id="xmlMarshaller" class="org.springframework.oxm.xstream.XStreamMarshaller">
        <property name="streamDriver">
            <bean class="com.thoughtworks.xstream.io.xml.StaxDriver"/>
        </property>
        <property name="annotatedClasses">
            <list>
                <value>com.smart.domain.User</value>
            </list>
        </property>
    </bean>   
           
    
	<!-- 在使用Excel/PDF/XML的视图时，请先把这个视图解析器注释掉，否则产生视图解析问题-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          p:order="100" p:viewClass="org.springframework.web.servlet.view.JstlView"
          p:prefix="/WEB-INF/views/" p:suffix=".jsp"/>
	
	<!-- FreeMarker基础设施及视图解析器配置 -->
	<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"
		 p:templateLoaderPath="/WEB-INF/ftl" 
		 p:defaultEncoding="UTF-8">
		 <property name="freemarkerSettings">
            <props>
                <prop key="classic_compatible">true</prop>
            </props>
        </property>
	</bean>
  	<bean  class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver"
            p:order="5" p:suffix=".ftl1" p:contentType="text/html; charset=utf-8"/>
            
	 <!-- Excel及PDF视图解析器配置 -->
    <bean class="org.springframework.web.servlet.view.BeanNameViewResolver"
          p:order="10"/>
    <bean id="userListExcel" class="com.smart.web.UserListExcelView"/>  
    <bean id="userListPdf" class="com.smart.web.UserListPdfView"/>      
    
    <!-- XMl及JSON视图解析器配置 -->
    <bean id="userListXml"
          class="org.springframework.web.servlet.view.xml.MarshallingView"
          p:modelKey="userList" p:marshaller-ref="xmlMarshaller"/>    
	<bean id="userListJson"
          class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"
          p:modelKeys="userList"/>  
          
     
    <!-- 协商多种视图解析器 -->
    <bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver" p:order="0">
        <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
        <property name="defaultViews">
            <list>
                <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"
                      p:modelKeys="userList"/>
                <bean class="org.springframework.web.servlet.view.xml.MarshallingView"
                      p:modelKey="userList" p:marshaller-ref="xmlMarshaller"/>
            </list>
        </property>
    </bean>
    <bean id="contentNegotiationManager"
          class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean"
          p:ignoreAcceptHeader="true"
          p:favorPathExtension="false"   
          p:favorParameter="true"       
          p:parameterName="format"
          p:defaultContentType="text/html">
        <property name="mediaTypes">
            <value>
                html=text/html
                xml=application/xml
                json=application/json
            </value>
        </property>
    </bean>
</beans>

在协商多种视图解析器配置里，定义了 json xml和html的视图。默认是html视图。

p:favorPathExtension 为false,如果设置为true,可以a.html  a.xml  a.json格式访问,返回对应视图。

p:favorParameter 为true,可以使用参数访问，p:parameterName="format" 定义参数名称为format,如 a?format=json,则可以返回json视图。

p:defaultContentType="text/html" 默认视图，是html，如果在ContentNegotiatingViewResolver外有其他视图解析器，这个配置可能会使其他视图不生效，如上面配置的XMl及JSON视图解析器，此时应去掉 p:defaultContentType="text/html"这行配置。如果没有去掉，只支持html xml json三种视图，其他视图（除了JstlView）会报错。

接口：

package com.smart.web;

import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.springframework.http.HttpEntity;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import com.smart.domain.User;

@Controller
@RequestMapping("/sp5")
public class Sp5Controller {
	@RequestMapping(value="m1",method=RequestMethod.GET)
	@ResponseBody
	public String m1(){
		return "inm1";
	}
	
	@RequestMapping(value = "/m2",method=RequestMethod.POST)
	public ResponseEntity<User> m2(HttpEntity<User> requestEntity) throws UnsupportedEncodingException {
		User user = requestEntity.getBody();
		System.out.println("######:"+user+"---"+user.getRealName());
		user.setUserId("1000");
		return new ResponseEntity<User>(user, HttpStatus.OK);
	}
	
	@RequestMapping(value="/m3",method=RequestMethod.GET)
	public String m3(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		list.add(user1);
		mm.addAttribute("list", list);
		return "suc";
	}
	
	@RequestMapping(value="/m4" ,method=RequestMethod.GET)
	public String m4(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userFtl";
	}
	
	@RequestMapping(value="/m5" ,method=RequestMethod.GET)
	public String m5(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		user.setRealName("张三");
		user.setBirthday(new Date());
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		user1.setRealName("张三");
		user1.setBirthday(new Date());
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userListExcel";
	}
	
	@RequestMapping(value="/m6" ,method=RequestMethod.GET)
	public String m6(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		user.setRealName("张三");
		user.setBirthday(new Date());
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		user1.setRealName("张三");
		user1.setBirthday(new Date());
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userListPdf";
	}
	
	@RequestMapping(value="/m7" ,method=RequestMethod.GET)
	public String m7(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		user.setRealName("张三");
		user.setBirthday(new Date());
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		user1.setRealName("张三");
		user1.setBirthday(new Date());
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userListXml";
	}
	
	@RequestMapping(value="/m8" ,method=RequestMethod.GET)
	public String m8(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		user.setRealName("张三");
		user.setBirthday(new Date());
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		user1.setRealName("张三");
		user1.setBirthday(new Date());
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userListJson";
	}
	
	@RequestMapping(value="/m9" ,method=RequestMethod.GET)
	public String m9(ModelMap mm){
		List<User> list = new ArrayList<User>();
		User user = new User();
		user.setUserId("1");
		user.setUserName("zhangsan");
		user.setRealName("张三");
		user.setBirthday(new Date());
		list.add(user);
		User user1 = new User();
		user1.setUserId("2");
		user1.setUserName("lisi");
		user1.setRealName("张三");
		user1.setBirthday(new Date());
		list.add(user1);
		mm.addAttribute("userList", list);
		return "userListMax";
	}
	
}

m9?format=json   返回json视图

m9?format=xml    返回xml视图

m9 返回jstl视图，也就是 如下bean视图

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          p:order="100" p:viewClass="org.springframework.web.servlet.view.JstlView"
          p:prefix="/WEB-INF/views/" p:suffix=".jsp"/>

WEB-INF/views/userListMax.jsp

上面只是整合了 xml和json视图，此时访问m6 会报错，因为定义了p:defaultContentType="text/html"     不匹配xml和json，自动用JstlView视图解析，UserListPdfView视图没有被使用，此时去掉p:defaultContentType="text/html"  即可。