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

布满荆棘的人生 2022-08-04 11:35 114阅读 0赞

#### 一、从freemarker谈起 ####

Freemarker使用模板技术进行视图的渲染。自从看了Struts标签、Freemarker、JSTL的性能对比后，我毅然决定放弃Struts标签了！效率太差……   
Spring本身支持了对Freemarker的集成。只需要配置一个针对Freemarker的视图解析器即可。

#### 二、Spring MVC视图解析器 ####

视图解析器的工作流程大致是这样的：

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

下面介绍一下本文需要用到的解析器（[更多解析器资料][Link 1]）：

*  InternalResourceViewResolver：这是一个最常用的解析器。通常使用它指定渲染对象为jsp页面
 *  FreeMarkerViewResolver：这就是Spring与Freemarker整合需要用到的解析器

#### 三、配置多视图，支持freemarker ####

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

##### 1.Web.xml #####

<?xml version="1.0" encoding="UTF-8"?>
    <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
        http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
        <welcome-file-list>
            <welcome-file>index.jsp</welcome-file>
        </welcome-file-list>
    
        
        
        
        
        <servlet>
            <servlet-name>dispatcher</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                <param-value>/WEB-INF/classes/applicationContext.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
    
        
        
        
        <servlet-mapping>
            <servlet-name>dispatcher</servlet-name>
            <url-pattern>*.do</url-pattern>
        </servlet-mapping>
    </web-app>

##### 2.dispatcherServlet.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:aop="http://www.springframework.org/schema/aop"
        xmlns:tx="http://www.springframework.org/schema/tx"
        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-2.5.xsd
      http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd
      http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
      http://www.springframework.org/schema/mvc  http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
    
    
        
        <bean id="viewResolverCommon" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/WEB-INF/page/"/>  
            <property name="suffix" value=".jsp"/>
            <property name="viewClass">
                <value>org.springframework.web.servlet.view.InternalResourceView</value>
            </property>
            <property name="order" value="1"/>
        </bean>
    
        
        <bean id="viewResolverFtl" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
            <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>
            <property name="contentType" value="text/html; charset=utf-8"/>
            <property name="cache" value="true" />
            <property name="suffix" value=".ftl" />
            <property name="order" value="0"/>
        </bean>
    
        
        <bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
            <property name="templateLoaderPath">
            <value>/WEB-INF/ftl/</value>
            </property>
            <property name="freemarkerVariables">
            <map>
                <entry key="xml_escape" value-ref="fmXmlEscape" />
            </map>
            </property>
            <property name="defaultEncoding">
                <value>utf-8</value>
            </property>
            <property name="freemarkerSettings">
                <props>
                    <prop key="template_update_delay">3600</prop>
                </props>
            </property>
        </bean>
    
        <bean id="fmXmlEscape" class="freemarker.template.utility.XmlEscape"/>
    
          
        <mvc:annotation-driven/>
    
        
        <context:component-scan base-package="com.hl.usersmanager">
            
        </context:component-scan>
    
    </beans>

##### 3.Controller #####

package com.hl.usersmanager.controller;
    
    import java.util.List;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.ModelMap;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    import com.hl.usersmanager.model.Users;
    import com.hl.usersmanager.service.IUserService;
    
    @Controller
    public class UserController {
    //  使用注解实现自动装配 不需要再写get set方法以及在context中配置bean
        @Autowired
        private IUserService userService;
    
        @RequestMapping(value = "findUserByName.do")
        public String findUserByName(String name,ModelMap model) {
            Users users = userService.findUserByName(name);
            model.addAttribute("userPhone",users.getPhone());
            System.out.println("userPhone：" + users.getPhone());
            return "showUser";
        }
    
        @RequestMapping(value = "findAllUsers.do")
        public String findAllUsers(ModelMap model) {
            List<Users> users = userService.findAllUsers();
            model.addAttribute("users",users);
            return "listUser";
        }
    
        ……
    }

在视图解析器中有一个`<property name="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`配置，否则会找不到页面。

[Link 1]: http://e-freya.iteye.com/blog/384083