sitemesh-学习文档

sitemesh 学习文档 sitemesh是opensymphony团队开发的j2ee应用框架之一，旨在提高页面的可维护性和复用性。opensymphony的另一个广为人知的框架为webwork是用作web层的表示框架。他们都是开源的，可以在下找到。应用于以下大项目的例子：/projects/ 简介： sitemesh应用Decorator模式，用filter截取request和response,把页面组件head,content,banner结合为一个完整的视图。通常我们都是用include标签在每个jsp页面中来不断的包含各种header, stylesheet, scripts and footer，现在，在sitemesh的帮助下，我们可以开心的删掉他们了。如下图，你想轻松的达到复合视图模式，那末看完本文吧。 hello sitemesh： 在WEB-INF/web.xml中copy以下filter的定义: class=codeblock sitemesh com.opensymphony.module.sitemesh.filter.PageFilter sitemesh /* sitemesh-decorator /WEB-INF/sitemesh-decorator.tld sitemesh-page /WEB-INF/sitemesh-page.tldcopy所需jar和dtd文件至相应目录，访问的cvs以获取sitemesh最新版本。 sitemesh.jarWEB-INF/lib sitemesh-decorator.tldWEB-INF sitemesh-page.tldWEB-INF 建立WEB-INF/decorators.xml描述各装饰器页面(可仿照sitemesh例子)。 * 建立装饰器页面 /_decorators/main.jsp sitemesh的例子 建立一个的被装饰页面 /index.jsp(内容页面) Agent Test 本页只有一句，就是本句. 最后访问index.jsp，将生成如下页面： 而且，所有的页面也会如同index.jsp一样，被sitemesh的filter使用装饰模式修改成如上图般模样，却不用再使用include标签。装饰器 decorator概念 建立可复用的web应用程序,一个通用的方法是建立一个分层系统，如同下面一个普通的web应用： 前端，front-end:JSP和Servlets，或jakarta的velocity 控制层框架 Controller ： (Struts/Webwork) 业务逻辑 Business ：主要业务逻辑 持久化框架 ：hibernate/jdo可糟糕的是前端的页面逻辑很难被复用，当你在每一个页面中用数之不尽的include来复用公共的header, stylesheet, scripts，footer时，一个问题出现了-重复的代码，每个页面必须用copy来复用页面结构，而当你需要创意性的改变页面结构时，灾难就爱上了你。sitemesh通过filter截取request和response，并给原始的页面加入一定的装饰(可能为header,footer.)，然后把结果返回给客户端，并且被装饰的原始页面并不知道sitemesh的装饰，这也就达到了脱耦的目的。据说即将新出台的Portlet规范会帮助我们标准的实现比这些更多更cool的想法，但可怜的我还不懂它到底是一个什末东东，有兴趣的人可以研究jetspeed，或JSR (Java Specification Request) 168,但我想sitemesh如此简单，我们不妨先用着。让我们看看怎样配置环境 除了要copy到WEB-INF/lib中的sitemesh.jar, copy到WEB-INF中的sitemesh-decorator.tld,sitemesh-page.tld文件外，还有2个文件要建立到WEB-INF/： sitemesh.xml (可选) decorators.xml sitemesh.xml 可以设置2种信息: Page Parsers ：负责读取stream的数据到一个Page对象中以被SiteMesh解析和操作。(不太常用，默认即可)Decorator Mappers : 不同的装饰器种类，我发现2种比较有用都列在下面。一种通用的mapper,可以指定装饰器的配置文件名，另一种可打印的装饰器，可以允许你当用http:/localhost/aaa/a.html?printable=true方式访问时给出原始页面以供打印(免得把header,footer等的花哨的图片也搭上)(但一般不用建立它，默认设置足够了：com/opensymphony/module/sitemesh/factory/sitemesh-default.xml）： 范例： decorators.xml ：定义构成复合视图的所有页面构件的描述(主要结构页面，header,footer.)，如下例： * defaultdir: 包含装饰器页面的目录 page : 页面文件名 name : 别名 role : 角色，用于安全 webapp : 可以另外指定此文件存放目录 Patterns : 匹配的路径，可以用*,那些被访问的页面需要被装饰。 最重要的是写出装饰器本身(也就是那些要复用页面，和结构页面)。 其实，重要的工作就是制作装饰器页面本身(也就是包含结构和规则的页面)，然后把他们描述到decorators.xml中。 让我们来先看一看最简单的用法：其实最常用也最简单的用法就是我们的hello例子，面对如此众多的技术，我想只要达到功能点到为止即可，没必要去研究太深(除非您有更深的需求)。 sitemesh的例子 我们在装饰器页面只用了2个标签： ： 把请求的原始页面的title内容插入到中间。 ： 把请求的原始页面的body内的全部内容插入到相应位置。然后我们在decorator.xml中加入以下描述即可： *这样，请求的所有页面都会被重新处理，并按照main.jsp的格式重新展现在你面前。 让我们看看更多的用法。(抄袭sitemesh文档) 以下列着全部标签： Decorator TagsPage Tags被用于建立装饰器页面.被用于从原始内容页面访问装饰器.page:param 插入原始页面(被包装页面)的head标签中的内容(不包括head标签本身)。 插入原始页面(被包装页面)的body标签中的内容。插入原始页面(被包装页面)的title标签中的内容，还可以添加一个缺省值。例：/_decorator/main.jsp中 （装饰器页面）: - 附加标题/aaa.jsp中 (原始页面)：aaa页面访问/aaa.jsp的结果：aaa页面 - 附加标题在标签处插入原始页面(被包装页面)的原有的标签的属性中的内容，还可以添加一个缺省值。sitemesh文档中的例子很好理解：The decorator: body bgcolor=whiteThe undecorated page: The decorated page: 注意，writeEntireProperty=true会在插入内容前加入一个空格。象jsp页面中的标签一样，可以使用被包装为一个Page对象的页面。 (懒的用)例：可用 ：达到的访问结果。 . . 应用包装器到指定的页面上，一般用于被包装页面中主动应用包装器。这个标签有点不好理解，我们来看一个例子：包装器页面 /_decorators/panel.jsp： . 并且在decorators.xml中有一个公共页面，即将被panel包装：/_public/date.jsp: . .被包装页面 /page.jsp ： page的应用 . chen_ 最后会是什末结果呢？除了/page.jsp会被默认的包装页面包装上header,footer外，page.jsp页面中还内嵌了date.jsp页面，并且此date.jsp页面还会被panel.jsp包装为一个title加body的有2段的页面，第1段是date.jsp的title，第2段是date.jsp的body内容。另外，page:applyDecorator中包含的page:param标签所声明的属性值还可以在包装页面中用decorator:getProperty标签访问到。 可打印的界面装饰 前面说过有1种可打印的装饰器，可以允许你当用http:/localhost/aaa/a.html?printable=true方式访问时，应用其他的装饰器(自己指定)，给出原始页面以供打印(免得把header,footer等的花哨的图片也搭上)。 让我们来看一看怎样实现他：1.首先在WEB-INFO/sitemesh.xml中设置： 这样就可以通过?printable=true来使用名为printable的装饰器，而不是用原来的装饰器。2.在WEB-INFO/decorators.xml中定义相应的printable装饰器 3.最后编写printable装饰器/decorators/printable.jsp (printable version) 这样就可以让一个原始页面通过?printable=true开关来切换不同的装饰器页面。 中文问题由于sitemesh内部所使用的缺省字符集为iso-8859-1，直接使用会产生乱码，我们可以通过以下方法纠正之： 方法1：可以在您所用的application server的配置文件中找一找，有没有设置encoding或charset的项目，然后设成gbk或gb2312即可 方法2：这也是我们一直使用的方法。1.在每一个jsp页里设置: 来告诉server你所要求的字符集。2.在每个jsp页的head中定义： 来告诉浏览器你所用的字符集。 总结：使用sitemesh最通常的途径：1.配置好环境， 2.在WEB-INFO/decroators.xml中描述你将建立的包装器。 3.开发在decroators.xml中描述的包装器，最好存放在/_decorators目录下4.ok ，可以看看辛勤的成果了 : ：sitemesh，一个不错的tiles替代方案，比tiles做的更漂亮优雅。本文是sitemesh官方推荐的入门文档，本来想自己翻译的，突然发现有人先行一步了，就转过来看吧。以前我通常使用旧式的方法来建立自己的web应用：手工排版，仔细使用每一个字节使其工作在Unicode下，同时使用make文件来适应不同的CPU或许现在我们可以换一种方式。尽管我从没有感觉到需要使用assembly (CISC or RISC)来建立web应用，但也会偶尔觉得我的开发伙伴的工作相当繁琐。特别是我发现很多的开发者在痛苦的寻求一种比较好的方式来控制web应用的基本模块：例如那些页头、页尾、导航栏、打印页面、手持设备的轻量级页面，以及其他更多的问题。到了最后，令人惊异的是大部分人都采用了落后的includes和复制粘贴方式。根据经验，我可以采用在上开源的servlet 过滤器SiteMeshn来简单明了并优雅的解决这些问题。作为一种替代新的templating语言（XSLT）或部署您的页面到新的系统的解决方法，应用SiteMesh可以相当容易处理你的页面，这一切只需要普通的HTML，JSP，servlet(包括Struts)，以及其他常用的技术。工作原理SiteMesh利用了一种很少人知道的servlet规范实现了一种页面过滤器。设想一下，现在有一个简单的jsp页面用来返回当前的日期和时间。通常这个页面请求来到应用服务器，页面被处理，最后处理结果返回到web浏览器。SiteMesh作为一个页面过滤器，在页面被处理之后，返回web浏览器之前，对页面做了一些附加的操作。这个变化简单描述为图一和图二所示的附加步骤。图一：普通页面处理情况图二：SiteMesh对页面处理情况现在看一个简单的例子。Simple DocumentHello World! 你会发现这个页面有一个title和body（类似普通的HTML页面）。你也会发现一小段JSP代码它将会如同你期望的那样被处理。同时你可以使用任何你想使用的JSP语法和特性来替换这一小段代码。现在来看一个简单的SiteMesh 装饰（decorator）页面。列表2显示了一个被SiteMesh调用的JSP页面。My Site - (printable version查看这个装饰器（decorator），我们能看到一些有趣的东西。首先，在第一行申明了一个SiteMesh标签库。这个标签库包含了与原始页面一起工作时所需的所有东西。你能看到我们使用了两个SiteMesh的装饰标签（declared tags），和。不要惊讶于标签在原始页面中显示标签中的内容，中的内容也是如此。我们在这个页面的HEAD和BODY元素都使用了同一个title标签。（Were making a few fairly radical changes to the page, including repeating the title both in theHEADelement as well as theBODY. ）同时，我们还增加了一个到可打印版本页面的链接。作为对照，图三显示了原始处理页面，图四显示了被修饰过的处理页面。留意被装饰页面在浏览器窗口显示的标题文字和HTML内容。同时也可以看到增加了一个可打印页面的链接这个我们回头再说。图三：原始未修饰页面图四：被修饰页面很明显，对比起使用include（例如）来说，以这样的方式使用页头、页尾系统结构要清晰得多。这种方式更易移植、更易理解，同时也鼓励了JSP页面不再使用导航或其他类似的表现层代码。我发现在JSP页面中使用装饰器和CSS的组合比标准HTML的标签更容易去除格式信息。安装SiteMesh注意下面的屏幕截图是基于Windows XP Professional，Tomcat 5.0.19，和Java 2 SDK 1.4.2_03的环境之上的。在这里我假定你的Tomcat已经安装完毕并且可以正常工作了。你或许会有一些混淆，但我们已经成功地在Tomcat 4.1 和 WebLogic 测试过，同时 SiteMesh 也支持大部分的web应用服务器。本文描述的SiteMesh 2.0.1可以在下载到。 在 上SiteMeshs 的项目库中有四个文件可以下载。sitemesh-2.0.1.jar是其核心 JAR 文件，sitemesh-2.0.1-sources.zip的作用正如同其名字所述，sitemesh-example.war则提供了一个复杂的例子用来显示一些SiteMesh的高级特性。为了使描述更加简单，我们从sitemesh-blank.war文件开始。将该WAR文件放入Tomcat 的webapps目录，WAR包将自动解压显示内容（SoSo注：这里的前提是你的tomcat已经开始工作），如图五所示。图五： SiteMesh_blank.WAR解开后的内容我们花点时间描述一下这些文件的作用。web.xml首先，WEB-INF/web.xml文件显示如列表3，这些语句用来安装SiteMesh 过滤器和标签库。如果你决定在一个已有的Web应用中使用SiteMesh，你必须把这些语句添加到你的WEB-INF/web.xml文件中。sitemeshcom.opensymphony.module.sitemesh.filter.PageFiltersitemesh*.jspsitemesh-page/WEB-INF/sitemesh-page.tldsitemesh-decorator/WEB-INF/sitemesh-decorator.tld注意：这里需要注意一下url-pattern的写法- 如果使用的是Tomcat 5（而不是 Tomcat 4 ），需要将默认的*修改如*.jsp的形式。最新的servlet规范不再支持*样式。decorators.xmlWEB-INF/decorators.xml文件用来将一个装饰器名字同一个专门的JSP装饰文件绑定。作为一个例子，这里将JSP装饰文件minimal.jsp同一个称为handheld的装饰器绑定起来。*正如我们在代码列表里看到的一样，我们定义了三个装饰器，他们分别绑定了三个类似的JSP页面。我们可以看到一个默认装饰器（main.jsp），它将被默认运用于所有文件。缺省的，SiteMesh使用下面的逻辑来选择使用哪一个装饰器： 这个逻辑在sitemesh-2.0.1.jar包的comopensymphonymodulesitemeshfactorsitemesh-default.xml文件里被描述。你可以针对诸如：客户端操作系统，web浏览器，用户代理等在WEB-INFsitemesh.xml文件里，通过一个变量覆盖这个行为。(You can override this behavior. with a wide variety ofbuilt-in mappersfor things like language, client operating system, web browser/user agent, etc. by creating aWEB-INFsitemesh.xmlfile. ）可以在sitemesh-example.war找到例子。页面是否使用meta装饰器标签（meta. decorator tag）特别指定了一个装饰器？ 页面是否是一个框架集（是的话则不应用装饰器）？ 页面是否使用了printable=true参数（是的话则使用打印装饰器） 页面时候使用装饰器文件名特别指定了一个装饰器？ 页面是否匹配decorators.xml文件里描述的样式？ 通常第一条规则仅用来确定该装饰器是否被使用（Conceptually, the first rule that evaluates to true determines the decorator that is used. ）在上面的例子中，当出现printable=true参数的时候，装饰器printable.jsp（规则 #3）替代了main.jsp（规则 #5）。在SiteMesh中，这些规则被描述为mappers。decorators/*.jsp这三个decorators目录下的文件是decorators.xml文件中描述的不同装饰器JSP文件。上面是一个简单的装饰器例子，在后面我们将讨论更复杂的示例。sitemesh-2.0.1.jar这是SiteMesh最主要的二进制文件，通常被安装在WEB-INF/lib目录下。可以在/sitemesh/api找到这个库的javadoc。*.tldSiteMesh使用两个标签库，但大多数人都只需要sitemesh-decorator.tld。你可以在/sitemesh/tags.html找到相应的文档。我们已经讲述了最主要的标签：head，title和body。在下一章我们来讨论剩下的标签：getProperty。SiteMesh高级特性SiteMesh的一个重要特性是使用原始HTML的meta标签（例如）从基础页面传递信息到装饰器。作为一个例子，下面我们使用一个meta标签来定义HTML页面的作者。Simple DocumentHello World! 我们定义一个“smart”装饰器来研究meta标签，如果出现这个标签，则可以得到一个相应的HTML：My Site -a href=mailto:(printable version可以看到我们使用了getProperty标签的一个默认属性如果没有指定author，我们就设定其为staff。