Spring MVC入门3——返回JSON或XML等多种视图

上一篇的例子返回的都是HTML的页面，是为人进行服务的页面，供人进行阅读的。如果我们希望将Web作为一种服务，返回数据为机器服务，例如返回JSON，XML等，我们应该如何实现呢？

很显然，根据MVC的思想，以及Spirng MVC的架构设计，我们很容易就能想到，只需要修改对应的ViewResolver，让其不选择jsp或者html以及别的模版，而是选择渲染成JSON,XML就可以了。

Spring MVC中ContentNegotiatingViewResolver这么一个Resolver提供了这么一种实现方法。

ContentNegotiatingViewResolver有什么作用呢？

1.支持在Spring MVC下输出不同的格式

2.该类不是自己处理view, 而是代理给不同的ViewResolver来处理不同的view;

我们要实现怎么样的效果呢？

1.访问url的json会返回json对象。

例如：localhost:8080/user/123.json会返回以123为唯一标识的user的json对象。

2.访问url的xml会返回xml对象。

例如：localhost:8080/user/123.xml会返回以123为唯一标识的user的xml对象。

3.直接访问url会访问url对应的页面。

例如：localhost:8080/user/123会访问原本的页面。

那我们需要怎么进行配置呢？

我们首先要修改viewResovler。

配置如下：

<bean
  class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
  <!-- order表明执行顺序，value为1最早执行 -->
  <property name="order" value="1" />
  <property name="contentNegotiationManager">
    <bean class="org.springframework.web.accept.ContentNegotiationManager">
      <constructor-arg>
        <bean
          class="org.springframework.web.accept.PathExtensionContentNegotiationStrategy">
          <constructor-arg>
            <map>
              <!-- 增加key到mineType的映射，还可以是别的格式pdf等 -->
              <entry key="json" value="application/json" />
              <entry key="xml" value="application/xml" />
            </map>
          </constructor-arg>
        </bean>
      </constructor-arg>
    </bean>
  </property>


  <property name="defaultViews">
    <list>
      <!-- JSON View，JSON使用的真正的resolver，需要增加相应的依赖 -->
      <bean
        class="org.springframework.web.servlet.view.json.MappingJackson2JsonView" />

      <!-- XML View XML使用的真正的resolver，需要增加相应的依赖，并且需要返回的XML对象需要在下面的扫描中添加-->
      <bean class="org.springframework.web.servlet.view.xml.MarshallingView">
        <constructor-arg>
          <bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
            <property name="packagesToScan">
              <list>
                <value>springmvc.web.model</value>
              </list>
            </property>
          </bean>
        </constructor-arg>
      </bean>
    </list>
  </property>
</bean>

可是仔细一看，发现这个resolver只有json和xml的映射，那我们的jsp页面的映射怎么办呢？

就需要增加另外一个resolver了，不过优先级比它低。

<!-- 如果前面的都没匹配到，则会采用这个resolver -->
<bean
  class="org.springframework.web.servlet.view.InternalResourceViewResolver">
  <property name="order" value="2" />
  <property name="viewClass"
    value="org.springframework.web.servlet.view.JstlView" />
  <property name="prefix" value="/WEB-INF/views/" />
  <property name="suffix" value=".jsp" />
</bean>

还是原本熟悉的viewResolver。

对于JSON和XML两种视图的resolver，需要什么依赖呢？

JSON:

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>2.5.4</version>
</dependency>

XML：

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-oxm</artifactId>
	<version>${spring.version}</version>
</dependency>

因为spring-oxm中的依赖会和spring web mvc的依赖冲突，所以最好使用同一个spring版本。

这样我们的配置就基本完成了。最后的配置如下：

web.xml:

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
	<display-name>Archetype Created Web Application</display-name>

	<!-- 中文乱码问题 -->
	<filter>
		<filter-name>encodingFilter</filter-name>
		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
		<init-param>
			<param-name>encoding</param-name>
			<param-value>UTF-8</param-value>
		</init-param>
		<init-param>
			<param-name>forceEncoding</param-name>
			<param-value>true</param-value>
		</init-param>
	</filter>
	<!-- encoding filter for jsp page -->
	<filter-mapping>
		<filter-name>encodingFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

	<!-- 加载DispatcherServlet应用上下文 -->
	<servlet>
		<servlet-name>webDispatcherServlet</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<!-- 可选的初始化，指定你加载的上下文文件的位置，如果不写，则默认使用/WEB-INF/[servlet-name]-servlet.xml的文件 
			<init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:webDispatcherServlet-servlet.xml</param-value> 
			</init-param> -->
		<!-- 设置servlet的优先级，正数数时越小优先级越高 -->
		<load-on-startup>1</load-on-startup>
	</servlet>
	<!-- url拦截到对应的前端控制器 -->
	<servlet-mapping>
		<servlet-name>webDispatcherServlet</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>

</web-app>

webDIspatcherServlet-servlet.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:p="http://www.springframework.org/schema/p"
	xmlns:context="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-3.0.xsd
        http://www.springframework.org/schema/context 
        http://www.springframework.org/schema/context/spring-context-3.0.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">

	<mvc:annotation-driven />

	<!-- 扫描包下的注解,自动注册bean -->
	<context:component-scan base-package="springmvc.web" />
	
	<import resource="viewResolver.xml" />
	
</beans>

这里import无疑就是上面提到的resolver的配置了。

接下来就是业务逻辑部分：

我们需要一个用来传递的类：

@XmlRootElement
public class User {
	
	private String id;
	private String userName;
	private String password;
	
	public User() {
		id = "000";
		userName = "张三";
		password = "张三的password";
	}
	
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getUserName() {
		return userName;
	}
	public void setUserName(String userName) {
		this.userName = userName;
	}
	public String getPassword() {
		return password;
	}
	public void setPassword(String password) {
		this.password = password;
	}
	
}

注意这里需要用@XmlRootElement进行标注，只有这样才能被转换成XML对象。

Controller部分：

@Controller
@RequestMapping("/hello")
public class HelloWorldController {
	
	@RequestMapping(value = "/user/{id}", method=RequestMethod.GET)
	public String getUserPage(@PathVariable("id") String id, Model model) {
		User user = new User();
		user.setId(id);
		model.addAttribute(user);
		return "user";
	}

}

最后运行结果如下：

网上看了很多篇博客，很多都是在Spring 3.1之前支持的，而Spring3.2之后的版本对于其中很多属性的set方法都弃用了，还是spring官网论坛好T T

这样一来，返回什么视图都非常的方便了。