SiteMesh官方文档翻译(含Freemarker但不包括velocity部分)

最新推荐文章于 2018-02-03 18:41:11 发布

goosman

最新推荐文章于 2018-02-03 18:41:11 发布

阅读量5.3k

点赞数

分类专栏： Java 文章标签： freemarker velocity 文档 decorator include class

Java 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

安装配置

1. 创建普通的web项目或直接使用sitemesh-blank.war

2. 将sitemesh-2.4.1.jar拷贝到[web-app]/WEB-INF/lib下

3. 创建sitemesh的配置文件: [web-app]/WEB-INF/decorators.xml, 顶级标签为:

</decorators>

4. (可选的): 创建文件[web-app]/WEB-INF/sitemesh.xml, 包含以下内容:

<page_parsers>

<parser content-type=”text/html”

class=”com.opensymphony.module.sitemesh.parser.HTMLPageParser” />

<parser content-type=”text/html; charset=ISO-8859-1”

class=”com.opensymphony.module.sitemesh.parser.HTMLPageParser” />

</page_parsers>

<decorator-mappers>

<mapper

class=”com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper”>

</mapper>

</decorator-mappers>

</sitemesh>

5. 在[web-app]/WEB-INF/web.xml中的<web-app>标签内增加下面内容将sitemesh加入到应用中

<filter-name>sitemesh</filter-name>

<filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>

</filter>

<filter-mapping>

<filter-name>sitemesh</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

字符集

1. 默认编码: iso8859-1

2. 设置服务器解析后台页面的编码: <%@ page contentType=”text/html; charset=utf-8”%>

3. 告知浏览器解析界面的编码: <meta http-equiv=”content-type” content=”text/html; charset=utf-8” >

4. 设置sitemesh的装饰器解析时使用的编码

<page:applyDecorator name=”form” encoding=”utf-8”>

……

</page:applyDecorator>

构造装饰器

1. 兼容的一些装饰漆:

1.1. meta tags(关键字, 描述, 作者)

1.2. stylesheet(CSS样式表)

1.3. header(头部)

1.4. navigation(导航)

1.5. footer(底部)

2. 首先, 需要定义各种导航/布局, 比如: 是否需要一个默认的装饰器(一个对所有页面适用的标准装饰器)? 是否在首页有特定的布局? 文档中是否需要头部? 网站是否需要打印版?

3. 下面是一个web应用程序的示例结构, sitemesh不是必须的.

/decorators: 包含所有的装饰器文件的目录

/includes: 将要被其他文件包含的所有文件

/images: 包含所有的图片

/styles: 包含所有的样式表

/scripts: 包含所有的脚本文件

4. 良好的习惯:

4.1. 将整个应用都使用的样式表都放入同一个页面定义, 并按照下面方式引入:

String userAgent = request.getHeader("User-Agent");

if (userAgent != null && userAgent.indexOf("MSIE") == -1) {

out.print("<link href=/"" + request.getContextPath() + "/styles/ns4.css/" rel=/"stylesheet/" type=/"text/css/">");

} else {

out.print("<link href=/"" + request.getContextPath() + "/styles/ie4.css/" rel=/"stylesheet/" type=/"text/css/">");

}

4.2. 在你的装饰器中使用includes(比如: includes/navigation.jsp)

4.3. 不要尝试使用绝对路径(/), 用<%=request.getContextPate() %>去代替, 这会使得应用在发生变迁的时候变得非常容易.

4.4. 使你的装饰器兼容多浏览器(比如IE, Mozilla, Opera…)将会大大提高整个应用的兼容性

4.5. 使用frame (框架)的时候要特别小心, 因为装饰器可能不支持frame

5. 第一个装饰器: 最基本的, 你仅仅需要知道可以使用的一些装饰器标签, title, head, body这三个标签可能是经常使用的.

1: <%--
2: % 这个主装饰器应用于所有的页面.

3: %它包含标准的缓存, 样式表, 头部, 底部和版权声明.
4: --%>
5: <%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>
6: <%@ include file="/includes/cache.jsp" %>
7: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
8: <html>
9: <head>
10: <title><decorator:title default="INTRANET" /></title>
11: <decorator:head />
12: <%@ include file="/includes/style.jsp" %>
13: </head>
14: <body bgcolor="#FFFFFF" background="<%=request.getContextPath()%>/images/bg.gif">
15: <script type="text/javascript">window.status = "Loading: <decorator:title default="INTRANET" />...";</script>
16: <%@ include file="/includes/header.jsp"%>
17: <table width="100%" border="0" cellspacing="0" cellpadding="0">
18: <tr>
19: <td height="20" nowrap> </td>
20: </tr>
21: <tr>
22: <td width="1%" nowrap> </td>
23: <td width="16%" valign="top" nowrap>
23: <script type="text/javascript">window.status = "Loading: Navigation...";</script>
24: <%@ include file="/includes/navigation.jsp" %>
25: </td>
26: <td width="2%" nowrap> </td>
27: <td valign="top">
28: <br>
29: <script type="text/javascript">window.status = "Loading: Document body...";</script>
30: <div class="docBody"><decorator:body /></div>
31: </td>
32: <td width="1%" nowrap> </td>
33: </tr>
34: </table>
35: <br>
36: <%@ include file="/includes/footer.jsp" %>
37: <%@ include file="/includes/copyright.jsp" %>
38: <script type="text/javascript">window.status = "Done";</script>
39: </body>
40: </html>

第1-4行: 对装饰器的解释, 这种方式不同于一般的马上进行装饰器的工作.

第5行: 引入标签库, 这对所有要使用内部装饰器的页面都是必须的

第6行: 设置通知浏览器缓存页面的响应头, 如果你的应用是经常变动的, 省略这里

第10行: 如果请求页面没有title, 默认title将使用”INTRANET”

第15行: 页面在加载的时候状态条的消息

第30行: 整个请求页面的body放入docBody. 将导航和body进行了划分.

6. 现在用你喜欢的编辑器打开WEB-INF/decorators.xml让sitemesh知道你有了一个装饰器(通过映射):

</decorator>

</decorators>

7. 现在部署你的web应用, 访问欢迎界面, main装饰器就会被应用上.

freemarker支持

1. sitemesh2.0.2之后开始支持freemarker

<#include "/includes/decorators/header.dec">

    <h2>${title}</h2>

    ${head}

    <img src="${base}/images/logo.gif" border="0">

    <td valign="top" class="body">

        <div class="header">

            <span class="pagetitle">${title}</span>

        </div>

        ${body}

    </td>

<#include "/includes/decorators/footer.dec">

2. 安装freemarker支持

2.1. 拷贝freemarker.jar到[web-app]/WEB-INF/lib下

2.2. 在web.xml中增加下面内容:

<servlet-name>sitemesh-freemarker</servlet-name>

<servlet-class>com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet</servlet-class>

<init-param>

<param-name>TemplatePath</param-name>

<param-value>/</param-value>

</init-param>

<init-param>

<param-name>default_encoding</param-name>

<param-value>ISO-8859-1</param-value>

</init-param>

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

</servlet>

<servlet-mapping>

<servlet-name>sitemesh-freemarker</servlet-name>

<url-pattern>*.dec</url-pattern>

</servlet-mapping>

2.3. 修改decorators.xml中要使用freemarker的decorator的page指向一个后缀为dec的文件.

3. FreemarkerDecoratorServlet向contex对象中放入了一些东西可以在模板中使用

3.1. 基础属性:

3.1.1. 所有的request, request参数, session, servlet context属性变量${Session[“user”]}

3.1.2. 创建变量: <#assign ww=JspTaglibs[“/WEB-INF/webwork.tld”]> 使用创建的变量去加载jsp taglibs: <@ww.property value=”myVar” />

3.2. sitemesh的context 属性:

3.2.1. base: request.getContextPath()

3.2.2. title: 解析页面标题

3.2.3. head: 解析页面头部

3.2.4. body: 解析页面体

3.2.5. page: 内部页面对象

装饰器映射

1. 当一个页面被解析的时候, 它会被映射成为一个装饰器, 这个映射就扮演了链接DecoratorMappers的角色.

2. 对于每一个请求, 整个过程的第一个mapper要求知道使用哪个装饰器, 如果知道使用哪个装饰器, 传递一个页面对象和HttpServletRequest, 返回一个装饰器对象, 否则返回null. 如果返回了null, 下一个mapper继续查询, 重复这个过程直到没有mapper或返回了一个合法的装饰器, 如果没有mapper返回装饰器, 页面将不会被装饰以原始的状态返回.