Spring 4.2.2 and apache tiles 3.0.5 整合

记录 Spring 4.2.2 整合 apache tiles 3.0.5 的步骤

 

1. pom.xml
   

   <dependency>
   	<groupId>org.apache.tiles</groupId>
   	<artifactId>tiles-extras</artifactId>
   	<version>3.0.5</version>
   </dependency>

    
   
2. web.xml
   

   <listener>
   	<listener-class>org.apache.tiles.extras.complete.CompleteAutoloadTilesListener</listener-class>
   </listener>

   官网教程有提到添加该 listener，但是，这里不建议使用，为什么，因为这里添加了该 tiles listener，它会默认覆盖掉其它的配置，也就是说如果在 Spring 中 通过 TilesConfigurer 配置的模板路径也就不会生效了；CompleteAutoloadTilesListener 默认回到 /WEB-INF/tiels.xml 和 /WEB-INF/**/tiels.xml 的子目录中找 tiles.xml 的模板配置文件
   

   <servlet>
   	<servlet-name>Tiles Dispatch Servlet</servlet-name>
   	<servlet-class>org.apache.tiles.web.util.TilesDispatchServlet</servlet-class>
   </servlet>
   	
   <servlet-mapping>
   	<servlet-name>Tiles Dispatch Servlet</servlet-name>
   	<url-pattern>*.tiles</url-pattern>
   </servlet-mapping>

    这里，意思是，模板可以通过 模板名字.tiles 进行访问，这里也不建议配置，因为 Spring MVC 的 TilesViewResolver 可以进行模板的访问。
3. Spring 配置
   

   <!-- 自动将静态资源导向 -->
   <!-- <mvc:resources mapping="/resources/**" location="/resources/" /> -->
   
   <!-- Order 的意义：意思是说，当有多个 view resovler 的时候，按照 order 的数字大小，由小到大依次解析；很关键 -->
   <bean id="tilesViewResolver" class="org.springframework.web.servlet.view.tiles3.TilesViewResolver">
   	<property name="viewClass" value="org.springframework.web.servlet.view.tiles3.TilesView"></property>
       <property name="order" value="0"></property>
   </bean>
   	
   <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
   	<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
   	<property name="prefix" value="/"></property>
   	<property name="suffix" value=".jsp"></property>
   	<property name="order" value="1"></property>
   </bean>
   
   	<!-- 又是一个坑，Spring 4.2.2 默认启动时不会初始化 bean，而之前 3.x 会自动初始化，
   		 所以这里需要设置 lazy-init="false"，让 TilesConfigurer 在 Spring 容器启动时就初始化，否则，titlesConfigurer 加载 definitions 失败 -->
   <bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles3.TilesConfigurer" lazy-init="false">
   	
   	<property name="definitions">
   		<list>
   			<value>/WEB-INF/layout/layouts.xml</value>
   			<value>/WEB-INF/layout/views.xml</value>
   		</list>
   	</property>
   
   	<property name="preparerFactoryClass" value="org.springframework.web.servlet.view.tiles3.SpringBeanPreparerFactory" />
   
   </bean>

    注意，Spring 4.2.2 对配置的 bean 不会自动进行初始化，而是默认使用的懒加载，所以在配置 TilesConfigurer 的时候，记得加上 lazy-load="false"，否则配置的模板路径不会生效
4. 工程目录
   
5. layouts.xml
   

   <tiles-definitions>
     
     <definition name="education.default_template" template="/WEB-INF/views/education/common/template.jsp">
     
       <put-attribute name="title" value="education tutorial homepage" />
       
       <put-attribute name="header" value="/WEB-INF/views/education/common/header.jsp" />
       
       <put-attribute name="menu" value="/WEB-INF/views/education/common/menu.jsp" />
       
       <!-- remain the body as blank, let its inheritance to fill it up -->
       <put-attribute name="body" value="" />
   
       <put-attribute name="footer" value="/WEB-INF/views/education/common/footer.jsp" />
   
     </definition>  
     
   </tiles-definitions>

    > template.jsp 
       模板文件
    > title, menu, header, body, footer 全部是用来填充 template.jsp 的
    > 因为 body 未填充，所以 education.default_template 是抽象模板，可以被继承模板实现
6. views.xml 子模板
   

   <tiles-definitions>
   
   <!-- defined for education -->
   
     <definition name="education_spittle_home" extends="education.default_template">
         <put-attribute name="body" value="/WEB-INF/views/education/home_body.jsp" />
     </definition>
   
     <definition name="education_spittle_view" extends="education.default_template">
         <put-attribute name="body" value="/WEB-INF/views/education/view.jsp" />
     </definition>
   
   <!-- defined for education -->
     
   </tiles-definitions>

    
7. Controller
   

   @RequestMapping("/home")
   public String home(){
   		
   	// by using TilesView to render this page. the full template path should be education_spittle_home.tiles.
   	return "education_spittle_home";
   	
   }

    然后，浏览器可以直接通过 http://localhost:8080/home 访问模板页面。
   
   
8. 坑，
   
   中文乱码，在 template.jsp 中设置了 UTF-8，结果内容显示还是乱码，后来发现，在每一个模板文件中，比如 header.jsp, menu.jsp, body.jsp 还有 footer.jsp 中，都要添加如下代码
   

   <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>