Spring MVC的多视图解析器配置及与Freemarker的集成

Spring MVC的多视图解析器配置及与Freemarker的集成

一、从freemarker谈起

Freemarker使用模板技术进行视图的渲染。自从看了Struts标签、Freemarker、JSTL的性能对比后，我毅然决定放弃Struts标签了！效率太差……

Spring本身支持了对Freemarker的集成。只需要配置一个针对Freemarker的视图解析器即可。

 

二、Spring MVC视图解析器

视图解析器的工作流程大致是这样的：Controller的某个方法执行完成以后，返回一个视图（比如：listUser），视图解析器要做的工作就是找到某个对象来完成视图的渲染，或者跳转到其他的逻辑视图。这里的渲染对象通常就是我们的jsp文件或者我们下面用的Freemarker(例如listUser.jsp或者listUser.ftl)。渲染完成以后，将解析结果发送到客户端浏览器

下面介绍一下本文需要用到的解析器（更多解析器资料，请参考 http://e-freya.iteye.com/blog/384083 ）：

InternalResourceViewResolver：这是一个最常用的解析器。通常使用它指定渲染对象为jsp页面

FreeMarkerViewResolver：这就是Spring与Freemarker整合需要用到的解析器

 

三、配置多视图，支持freemarker

我们通常不希望所有的动态页面请求都使用Freemarker来渲染，那就需要配置多个视图解析器。网上有很多这方面的帖子。我看到很多人的做法是在web.xml中配置两个DispatcherServlet,一个拦截*.do，一个拦截*.ftl;然后再写两个dispatcherServlet.xml,配置两个视图解析器；jsp页面、ftl模板就各司其职。

其实没有那么复杂。

1.Web.xml

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  

2. <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"  

3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

4.     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee   

5.     http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">  

6.     <welcome-file-list>  

7.         <welcome-file>index.jsp</welcome-file>  

8.     </welcome-file-list>  

9.   

10.    <!-- ======================================================== -->  

11.    <!--                  Spring MVC Config Servlet               -->  

12.    <!-- ======================================================== -->  

13.    <!-- JSP DispatcherServlet -->  

14.    <servlet>  

15.        <servlet-name>dispatcher</servlet-name>  

16.        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  

17.        <init-param>  

18.            <param-name>contextConfigLocation</param-name>  

19.            <param-value>/WEB-INF/classes/applicationContext.xml</param-value>  

20.        </init-param>  

21.        <load-on-startup>1</load-on-startup>  

22.    </servlet>  

23.  

24.    <!-- ======================================================== -->  

25.    <!--                  Spring MVC Config Mapping               -->  

26.    <!-- ======================================================== -->  

27.    <servlet-mapping>  

28.        <servlet-name>dispatcher</servlet-name>  

29.        <url-pattern>*.do</url-pattern>  

30.    </servlet-mapping>  

31.</web-app>  

 

 

2.dispatcherServlet.xml

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  

2. <beans xmlns="http://www.springframework.org/schema/beans"  

3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"  

4.     xmlns:tx="http://www.springframework.org/schema/tx"  

5.     xmlns:p="http://www.springframework.org/schema/p"  

6.     xmlns:context="http://www.springframework.org/schema/context"  

7.     xmlns:mvc="http://www.springframework.org/schema/mvc"  

8.     xsi:schemaLocation="  

9.   http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  

10.  http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd  

11.  http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd  

12.  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd  

13.  http://www.springframework.org/schema/mvc  http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">  

14.  

15.      

16.    <!--通用视图解析器-->  

17.    <bean id="viewResolverCommon" class="org.springframework.web.servlet.view.InternalResourceViewResolver">  

18.        <property name="prefix" value="/WEB-INF/page/"/>    

19.        <property name="suffix" value=".jsp"/><!--可为空,方便实现自已的依据扩展名来选择视图解释类的逻辑  -->  

20.        <property name="viewClass">  

21.            <value>org.springframework.web.servlet.view.InternalResourceView</value>  

22.        </property>  

23.        <property name="order" value="1"/>  

24.    </bean>  

25.      

26.    <!-- 配置freeMarker视图解析器 -->  

27.    <bean id="viewResolverFtl" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">  

28.        <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>  

29.        <property name="contentType" value="text/html; charset=utf-8"/>  

30.        <property name="cache" value="true" />  

31.        <property name="suffix" value=".ftl" />  

32.        <property name="order" value="0"/>  

33.    </bean>  

34.      

35.    <!-- 配置freeMarker的模板路径 -->  

36.    <bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">  

37.        <property name="templateLoaderPath">  

38.            <value>/WEB-INF/ftl/</value>  

39.        </property>  

40.        <property name="freemarkerVariables">  

41.            <map>  

42.                <entry key="xml_escape" value-ref="fmXmlEscape" />  

43.            </map>  

44.        </property>  

45.        <property name="defaultEncoding">  

46.            <value>utf-8</value>  

47.        </property>  

48.        <property name="freemarkerSettings">  

49.            <props>  

50.                <prop key="template_update_delay">3600</prop>  

51.            </props>  

52.        </property>  

53.    </bean>  

54.       

55.    <bean id="fmXmlEscape" class="freemarker.template.utility.XmlEscape"/>  

56.      

57.    <!-- 注解支持 -->    

58.    <mvc:annotation-driven/>  

59.      

60.    <!-- 对包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->  

61.    <context:component-scan base-package="com.hl.usersmanager">  

62.        <!-- 允许定义过滤器将基包下的某些类纳入或排除  

63.        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/> -->  

64.    </context:component-scan>  

65.      

66.</beans>  

 

 

3.Controller

Java代码  

1. package com.hl.usersmanager.controller;  

2.   

3. import java.util.List;  

4.   

5. import org.springframework.beans.factory.annotation.Autowired;  

6. import org.springframework.stereotype.Controller;  

7. import org.springframework.ui.ModelMap;  

8. import org.springframework.web.bind.annotation.RequestMapping;  

9.   

10.import com.hl.usersmanager.model.Users;  

11.import com.hl.usersmanager.service.IUserService;  

12.  

13.@Controller  

14.public class UserController {  

15.//  使用注解实现自动装配 不需要再写get set方法以及在context中配置bean  

16.    @Autowired  

17.    private IUserService userService;  

18.  

19.    @RequestMapping(value = "findUserByName.do")  

20.    public String findUserByName(String name,ModelMap model) {  

21.        Users users = userService.findUserByName(name);  

22.        model.addAttribute("userPhone",users.getPhone());  

23.        System.out.println("userPhone：" + users.getPhone());  

24.        return "showUser";  

25.    }  

26.      

27.    @RequestMapping(value = "findAllUsers.do")  

28.    public String findAllUsers(ModelMap model) {  

29.        List<Users> users = userService.findAllUsers();  

30.        model.addAttribute("users",users);  

31.        return "listUser";  

32.    }  

33.      

34.    ……  

35.}  

 

 

在视图解析器中有一个<propertyname="order" value="orderValue"/>的配置，这个配置表示解析器的优先级别。我们将FreeMarkerViewResolver的级别设为0,将InternalResourceViewResolver的级别设为1。这样，解析器就会优先使用FreeMarkerViewResolver 进行解析，如果找不到相应的模板，就使用InternalResourceViewResolver进行解析，如果还找不到页面，就会产生一个404错误！

 

在本例中，我们在/WEB-INF/page/下有一个showUser.jsp页面，在/WEB-INF/ftl/下有一个listUser.ftl的模板文件。那么当访问findAllUsers.do的时候，Controller返回一个listUser视图，根据解析器配置，先使用FreeMarkerViewResolver进行解析。它会根据模板路径templateLoaderPath的配置/WEB-INF/ftl/下去找是否有一个listUser并且以后缀配置suffix值.ftl，即listUser.ftl文件，如果找到则使用该模板进行解析。这里我们实现已经创建了这个模板文件，所以user列表成功被显示出来。

当用户访问findUserByName.do的时候，返回showUser视图，毅然先使用FreeMarkerViewResolver进行解析，结果发现在/WEB-INF/ftl/下并没有showUser.ftl这个模板文件，于是使用InternalResourceViewResolver进行解析，于是开始寻找/WEB-INF/page/下是否有showUser.jsp文件。由于我们已经创建了这个文件，于是最终使用showUser.jsp进行渲染。那么如果没有找到showUser.jsp，就会抛出404错误。

 

这里还要注意的是，如果Controller中返回视图加了后缀jsp或者ftl，在配置中就不要加入suffix配置，否则会找不到页面。