Struts Tiles讲解

rendong — Wed, 02 Aug 2006 15:11:00 GMT

Struts Tiles

我很喜欢 struts ，这是我目前最熟悉的 MVC Framework ，但是 struts 的 template Engine 和 Turbine(jakarta 另外一个 mvc framework，还有一个 tapestry )使用的 Velocity 有异曲同工之妙，另外如果你们在 Mail List 看到 Craig R. McClanahan 这号人物，他就是“神”的代言人！

MVCII Framework
Cotroller是指由 Servlet 所主导,Model 为 JavaBean所开发, 最后以 JSP 做 View 端的呈现,最后将资料返回到客户端. 而今天我要讨论的就是客户端的 Template Engine -- Tiles.

View (Template Engine)-Tiles
Tiles是由Cedric Dumoulin老大所开发的 Template Engine , 什么叫做 Template Engine呢, 他是一个版面切割控制的处理中心.通常我们在早古时代大约 ( 1995 ~ 2000 )年间 , 设计网页大多以 Frame 为切割网页的方式 , 因为当时网络带宽不足, 加上开发工具短缺,所以我们那时候对于版面的控制大概也只是这样, 但随着宽带网络的普及化,造就了网页的复杂功能, HTML 4.0 包含了 Layer的功能,问题来了, Layer 无法跨过 Frame变成一个浮动的控制小窗口,所以 Frame渐渐被淘汰,变成整个网页由 Table 的切割来组合而成, 但是, Table 的设计大多属于网页美工的工作,你要他们懂得如何写动态程序, 大概只有 1/10 的美工可以做到,所以我们建议是各师其职,让网页视觉大师的工作就单纯只是网页设计, 所以 Template Engine就应运而生,那比较有名的有, Velocity, Tiles, FreeMaker等等. 而 Struts 是使用 Tiles的,这次我就针对 Tiles 做初级的介绍.

基本上, 你在撰写 JSP的时候, 如果 /WEB-INF/lib/之下有放struts.jar那就代表说, 你的 JSP 可以 import struts 的组件进来, 而 struts-tiles.tld我通常会放在 /WEB-INF/tlds/目录之下,所以你在 JSP 的开始的地方就要写
<%@ taglib uri="/WEB-INF/tlds/struts-tiles.tld" prefix="tiles" %> 这意思就是说你这个网页将会通过 Struts-Tiles 这个 TagLib去调用 Tiles Template Engine , 你可以自己打开 struts-tiles.tld 这个文件看看, 里面的定义就是说,当你调用到其中的 tag时候,他需要去调用哪一个程序来执行你想得到的结果.

完全战略首部曲--建立模板 (template.jsp)
建立一个 template.jsp, 你先规划书面需要切割成为各个区块,本范例是切成上方标题区(top),左方主选单 (menu),右方主画面再切割上下区域各为 main 及 copyright :


<%@ page contentType="text/html;charset=BIG5" %>
<%@ taglib uri="/WEB-INF/tlds/struts-tiles.tld" prefix="tiles" %>


link="#660000">

 
 
 
 
 

 

 
 
 
 

  /images/top.gif" border="0">

完全战略二部曲--定义 definations.xml
根据 template.jsp 定义的 InsertTag 属性名称 ( attribute )给予一个 jsp/html来显示

完全战略三部曲--制作 ScreenServlet.java (WARN:copyrights are reserved by Softleader Copr.)
编译以下之程序(ScreenServlet.class)放到 /WEB-INF/classes/com/softleader/system/init/之下


package com.softleader.system.init;

import java.util.StringTokenizer;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import java.io.IOException;
import java.io.PrintWriter;

import java.net.URL;

import javax.servlet.*;
import javax.servlet.ServletException;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import javax.naming.InitialContext;
import javax.naming.NamingException;

import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.tiles.*;
import org.apache.struts.tiles.TilesUtil;

public class ScreenServlet extends HttpServlet {

    private ServletContext context;
    /** Debug flag */
    public static final boolean debug = true;
    /** Associated definition factory */
    protected DefinitionsFactory definitionFactory;
    protected ComponentDefinition definition;
    private TilesRequestProcessor trp;

    public void init()  throws ServletException {
    }


    public void doPost(HttpServletRequest request, HttpServletResponse response)
    throws IOException, ServletException {
        process(request, response);
    }

    public void doGet(HttpServletRequest request, HttpServletResponse  response)
    throws IOException, ServletException {
        process(request, response);

    }

    public void process(HttpServletRequest request, HttpServletResponse  response)
    throws IOException, ServletException {
        // init screen
        String screenName = null;
        String selectedUrl = request.getRequestURI();

        // get the screen name
        int lastPathSeparator = selectedUrl.lastIndexOf("/") + 1;
        int lastDot = selectedUrl.lastIndexOf(".");
        if (lastPathSeparator != -1 && lastDot != -1 && lastDot > lastPathSeparator) {
            screenName = selectedUrl.substring(lastPathSeparator);
        }

        try {
            // Read definition from factory, but we can create it here.
            //ComponentDefinition definition = DefinitionsUtil.getDefinition( screenName, 

request, this.getServletContext() );
            //System.out.println("get Definition " + definition );
            //DefinitionsUtil.setActionDefinition( request, definition);
            //DefinitionsFactory definitionsFactory = 

DefinitionsUtil.getDefinitionsFactory(getServletContext());
            DefinitionsFactory definitionsFactory = TilesUtil.getDefinitionsFactory(request, 

getServletContext());

            String uri="";
            Controller controller;
            ComponentContext tileContext = null;

            if( definitionsFactory != null ) {
                // Get definition of tiles/component corresponding to uri.
                ComponentDefinition definition
                    = definitionsFactory.getDefinition(screenName, request, getServletContext());


                if( definition != null ){
                    // We have a definition.
                    // We use it to complete missing attribute in context.
                    // We also get uri, controller.
                    uri = definition.getPath();
                    controller = definition.getOrCreateController();

                    if( tileContext == null ) {

                        tileContext = new ComponentContext( definition.getAttributes() );
                        ComponentContext.setContext( tileContext, request);

                    }
                    else
                        tileContext.addMissing( definition.getAttributes() );
                } // end if
            } // end if


            RequestDispatcher rd = getServletContext().getRequestDispatcher(uri);

            rd.forward(request, response);


        }  catch( Exception ex ) {
        }
    }

}

并且设定 web.xml增加一个 ScreenServlet


  
    ScreenServlet
    ScreenServlet
    com.softleader.system.init.ScreenServlet
    3

测试网页呈现
当然,你需要自己建立相关定义在 definations.xml 的 jsp文件, 接着重新启动 tomcat, 你就可以看到 http://localhost:8080/test.screen是一个整合起来的画面了

设定相关的 compile 环境, 基本上,可以直接使用 struts source 的 libs 和 sources
设定相关的 properties 及 xml,如果不太了解, 请直接查阅 oreilly 所出的 Struts
请尊重知识产权,本文章之原始文件不得用于商业用途,需要时请于本公司联络.
Struts 网站: http://jakarta.apache.org/struts/
Tiles网站: http://www.lifl.fr/~dumoulin/tiles/
Tomcat 网站: http://jakarta.apache.org/tomcat/
以上程序都在 Tomcat 4.1.x以上以及 Sun JDK 1.4.x以上测试完成

上周告诉大家使用 tile 的基本方法,当然也有更基本的, 相关的文件有 Manning 出的 Struts in Action 和 Oreilly 出的 Programming Jakarta Struts 里面都有详尽的解释. 不过今天要介绍的时更高阶的技术-- Tile Layout ,书上都没有提到,呵呵!!

单独使用 Tiles
把 tiles.jar 放到 WEB-INF/lib/
把 tiles.tld 放到 WEB-INF/
把 commons-digester.jar,commons-collections.jar,commons-beanutils.jar 放到 WEB-INF/lib/ 下
把 jakarta commons *.tld 放到 WEB-INF/ 下

接着在 WEB-INF/web.xml 中增加



 action
 org.apache.struts.titles.TilesServlet


 
  definitions-config
  /WEB-INF/tiles/tiles-definitions.xml
 
 
  definitions-parser-validate
  true

使用及
简单来说, 上一篇介绍的 tiles definitions 的方法是一对一, tiles:insert 会去找 definitions 中的 put 值, 把指向的 jsp 抓进来, 一起包装成一个网页送到客户端的浏览器, 但是, 如果我希望在 template 中一次加入多笔的页面该怎么做呢, 哪就得用接着使用 iterate 把他一个一个取出来显示.



 
  
  
src="<%=request.getContextPath()%>/images/logo.gif">

 在 view 端 jsp 中要写




 
 
 
<%=item%>

RssChannel
所谓的 RssData, 是一个 webservice 的格式, 相关的介绍有
XML.com RSS 的介绍
 Oreilly RSS 研究中心
 RSS 教学手册
 RSS 最新消息
基本上有几个好处

可能放到各个不同的 tiles channel 中 .
在同一个 page 可能放到好几个不同 channel .
可以简单的重新绘出 channel 画面.
可能符合好几个 channel , 每一个都可以各自重绘.

首先我们先定义 tiles-definition.xml , 最重要的, 是 controllerUrl 需要设定 , 此外, 还需要得到 rss 的格式.



 controllerUrl="/examples/controller/rssChannel.do">

在 strut-config.xml 中定义


    type="org.apache.struts.example.tiles.rssChannel.RssChannelsAction">

接着建立一个 RssChannelsAction 的 Class


 public final class RssChannelsAction extends TilesAction {
  public static final String CHANNELS_KEY = "CHANNELS";

  public static final String CHANNEL_URLS_KEY= "urls";

  public ActionForward doExecute(ActionMapping mapping, 
    ActionForm form, HttpServletRequest request,
    HttpServletResponse response) 
  throws IOException, ServletException, Exception {
   org.apache.commons.digester.rss.Channel channel = null ; 


   List channels = (List)context.getAttribute(CHANNEL_URLS_KEY);
   List channelBeans = new ArrayList(channels.size());

   for ( int i=0 ; i < channels.size(); i++ ) {
    RSSDigester digester = new RSSDigester();
    String url = (String)channels.get(i);

    Channel obj = (Channel) digester.parse(url);
    channelBeans.add(obj);
   }
   context.putAttribute(CHANNELS_KEY,channelBeans);
   return null;
  }  

 }

最后, 在 view 端 jsp 这样就可以看到 rssChannel 的资料啦


<%@ page language="java" %>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>
<%@ taglib uri="/WEB-INF/struts-tiles.tld" prefix="tiles" %>


















  ">
    
property="image.URL"/>">
 
">[home]

property="description"/>







  [ 
property="link"/>">more ]

Layouts
目前 tiles-example 有提供几种不同的 layout 可以参考

Layout Name	Parameters	Use
Class Layout	title header menu body fotter	使用取得标题外, 其余使用
Menu Layout	title items	使用取得标题外, 其余使用 org.apache.struts.tiles.beans.MenuItem  iterate
VBox or VStack Layout	list	使用
Multi-columns Layout	numCols list1 list2 [optional] list3 [optional] listn [optional]	使用接着使用和将资料放进来
Center Layout	header right body left footer	使用和将资料放进来
Tabs Layout	tabList selectedIndex parameterName	这个几乎以上用到的观念都会用到

当然, 你也可以建立自己的 Layout , 我们希望你能建立符合 MVC 观念的 Layout!!

rendong 2006-08-02 23:11 发表评论

Struts s Tiles 使用入门完全攻略(转载)

rendong — Wed, 02 Aug 2006 15:09:00 GMT

一：说明
Struts1.1以后增加了Tiles包使得struts在页面的处理方面多了一种选择.并且更容易实现代码的重用。Tiles中对页面的划分有点象jakarta的另外一个项目Turbine中的TDK。增加了layout的概念.其实就是把一个页面划分为几块。通常的来说一个页面大概可以划分为如下几块：head页面头部:存放一个运用的公共信息：logo等，如果是网站可能是最上面的一块.menu页面菜单:放置一个运用中需要使用的菜单，或者在每一个页面都使用的连接.footer页面尾部:如版权信息等.body页面主题内容:每个页面相对独立的内容.如果按上面的划分那对每一个页面我们只要写body里面的内容，其他的就可以共享重用.如果大多数页面的布局基本相同我们甚至可以使用一个jsp文件根据不同的参数调用不同的body.

二：Tiles配置和基本配置文件介绍
Tiles有一个配置文件:tiles-defs.xml
tiles-defs.xml定义了每一个页面的组成元素和形式。
下面我将说明如下所示的一个tiles-defs.xml文件
tiles-defs.xml
-----------------------------------------------

附：/layouts/classicLayout.jsp
--------------------------------

<tiles:getAsString name="title"/><br />

在web.xml里面配置tiles,配置完后对应struts action servlet的配置如下:
web.xml
-----------------

action

org.apache.struts.action.ActionServlet

definitions-config
/WEB-INF/tiles-defs.xml

definitions-debug
1

definitions-parser-details
0

definitions-parser-validate
true

config
/WEB-INF/struts-config.xml

validate
true

debug
2

detail
2

三：使用Tiles
如果已经配置好tiels-defs.xml，接下来就可以在jsp文件中使用这些定义了。
有如下的方式使用tiles
3.1:

插入site.mainLayout标记的一页

3.2：

/tutorial/basic/myFramesetLayout.jsp
---------------------------------

<tiles:get name="title"/>

" name="header" >
" name="body" >
" name="footer" >

插入/tutorial/basic/myFramesetLayout.jsp
并把title的值设定为:My first frameset page
header设定为/tutorial/common/header.jsp

四：后记
Tiles的使用在他的文档里面写的比较详细。以上是一些简单和基本的使用。具体的文档可以看Struts里面的一个tiles-documentation.war的包。但即使是这个包也不是很全。可以通过上的的连接到作者的主页上去找。个人觉得使用Tiles在做企业运用的时候可能不如在做网站那样更能体现优越性。但在系统开始设计的时候考虑并规划好整个UI，那在修改和维护的时候将节省不少的工作量，因为通常UI的确定在代码编写结束和完成，所有尽可能的使用多个子页面构成一个页面，后面的美化和维护就比直接维护一个很大的页面容易

rendong 2006-08-02 23:09 发表评论

"> property="image.URL"/>">	">[home]
property="description"/>
[ property="link"/>">more ]

BlogJava-学习--共同努力-随笔分类-struts

Struts Tiles讲解

Struts s Tiles 使用入门完全攻略(转载)