Tomcat SSI（服務(wù)器端嵌入）

簡(jiǎn)介

SSI（服務(wù)器端嵌入）是一組放在 HTML 頁(yè)面中的指令，當(dāng)服務(wù)器向客戶端訪問(wèn)提供這些頁(yè)面時(shí)，會(huì)解釋執(zhí)行這些指令。它們能為已有的 HTML 頁(yè)面添加動(dòng)態(tài)生成內(nèi)容，不需要通過(guò) CGI 程序來(lái)或其他的動(dòng)態(tài)技術(shù)來(lái)重新改變整個(gè)頁(yè)面。

如果利用 Tomcat 作為 HTTP 服務(wù)器并需要 SSI 支持時(shí)，可以添加 SSI 支持。通常，如果你運(yùn)行的不是像 Apache 那樣的服務(wù)器，就通過(guò)開(kāi)發(fā)來(lái)實(shí)現(xiàn)這種支持。

Tomcat SSI 支持實(shí)現(xiàn)了與 Apache 完全一致的 SSI 指令。關(guān)于使用 SSI 指令的詳細(xì)信息，可參考Apache 的 SSI 簡(jiǎn)介。

SSI 支持可以有兩種方式來(lái)實(shí)現(xiàn)：servlet 或過(guò)濾器。你只能利用其中的一種方式來(lái)提供 SSI 支持。

基于 servlet 的 SSI 支持是通過(guò) org.apache.catalina.ssi.SSIServlet 類(lèi)來(lái)實(shí)現(xiàn)的。一般來(lái)說(shuō)，這個(gè) servlet 映射至 URL 模式"*.shtml"。

基于過(guò)濾器的 SSI 支持則利用 org.apache.catalina.ssi.SSIFilter 類(lèi)來(lái)實(shí)現(xiàn)。一般而言，該過(guò)濾器映射至 URL 模式 "*.shtml"，但是它也可以被映射至 "*"，因?yàn)樗鼤?huì)基于 MIME 類(lèi)型選擇性地啟用/禁用對(duì) SSI 的處理。初始參數(shù) contentType 允許你將 SSI 處理應(yīng)用于 JSP 頁(yè)面、JavaScript 內(nèi)容以及其他內(nèi)容中。

默認(rèn) Tomcat 是不支持 SSI 的。

安裝

警告：SSI 指令可用于執(zhí)行 Tomcat JVM 之外的程序。如果使用 Java SecurityManager，它會(huì)繞過(guò)你在 catalina.policy 中配置的安全策略。

為了使用 SSI servlet，要從 $CATALINA_BASE/conf/web.xml 中去除 SSI servlet 及 servlet 映射配置旁邊的 XML 注釋。

為了使用 SSI 過(guò)濾器，要從 $CATALINA_BASE/conf/web.xml 中去除 SSI 過(guò)濾器及過(guò)濾器映射配置旁邊的 XML 注釋。

只有標(biāo)明為 privileged 的上下文才可以使用 SSI 功能（參看 Context 元素的 privileged 屬性）。

Servlet 配置

以下這些 servlet 初始化參數(shù)可以配置 SSI servlet 的行為：

• buffered 是否應(yīng)緩存該 servlet 的輸出？（0 = false，1 = true）默認(rèn)為 0（false）。
• debug 調(diào)試 servlet 所記錄信息的調(diào)試細(xì)節(jié)度。默認(rèn)為 0。
• expires 包含 SSI 指令的頁(yè)面失效的秒數(shù)。默認(rèn)行為針對(duì)的是每個(gè)請(qǐng)求所應(yīng)執(zhí)行的所有 SSI 指令。
• isVirtualWebappRelative “虛擬”的 SSI 指令路徑是否應(yīng)被解釋為相對(duì)于上下文根目錄的相對(duì)路徑（而不是服務(wù)器根目錄）？默認(rèn)為 false。
• inputEncoding 如果無(wú)法從資源本身確定編碼，則應(yīng)指定給 SSI 資源的編碼。默認(rèn)為系統(tǒng)默認(rèn)編碼。
• outputEncoding 用于 SSI 處理結(jié)果的編碼。默認(rèn)為 UTF-8。
• allowExec 是否啟用 exec 命令？默認(rèn)為 false。

過(guò)濾器配置

以下這些過(guò)濾器初始化參數(shù)可以配置 SSI 過(guò)濾器的行為：

• contentType 在應(yīng)用 SSI 處理之前必須匹配的正則表達(dá)式模式。在設(shè)計(jì)自己的模式時(shí)，不要忘記 MIME 內(nèi)容類(lèi)型后面可能會(huì)帶著可選的字符集：“mime/type; charset=set”。默認(rèn)為 “text/x-server-parsed-html(;.*)?”。
• debug 調(diào)試 servlet 所記錄信息的調(diào)試細(xì)節(jié)度。默認(rèn)為 0。
• expires 包含 SSI 指令的頁(yè)面失效的秒數(shù)。默認(rèn)行為針對(duì)的是每個(gè)請(qǐng)求所應(yīng)執(zhí)行的所有 SSI 指令。
• isVirtualWebappRelative “虛擬”的 SSI 指令路徑是否應(yīng)被解釋為相對(duì)于上下文根目錄的相對(duì)路徑（而不是服務(wù)器根目錄）？默認(rèn)為 false。
• allowExec 是否啟用 exec 命令？默認(rèn)為 false。

指令

指令采取 HTML 注釋的形式。在將頁(yè)面發(fā)送到客戶端之前，解讀指令，并用所得結(jié)果來(lái)替換指令。指令的一般形式為：

<!--#directive [parm=value] -->

這些指令包括：

• config <!--#config timefmt="%B %Y" --> 用于設(shè)定日期格式以及其他一些 SSI 處理的項(xiàng)目。
• echo <!--#echo var="VARIABLE_NAME" --> 將被變量值所取代。
• exec 在主機(jī)系統(tǒng)上用于運(yùn)行命令。
• include <!--#include virtual="file-name" --> 插入內(nèi)容。
• flastmod <!--#flastmod file="filename.shtml" --> 返回文件最后修改的時(shí)間。
• fsize <!--#fsize file="filename.shtml" --> 返回文件大小。
• printenv <!--#printenv --> 返回所有定義變量的列表。
• set <!--#set var="foo" value="Bar" --> 為用戶自定義變量賦值。
• if elif endif else 用于生成條件部分，例如：

<!--#config timefmt="%A" -->
<!--#if expr="$DATE_LOCAL = /Monday/" -->
<p>Meeting at 10:00 on Mondays</p>
<!--#elif expr="$DATE_LOCAL = /Friday/" -->
<p>Turn in your time card</p>
<!--#else -->
<p>Yoga class at noon.</p>
<!--#endif -->

關(guān)于使用 SSI 指令的詳細(xì)信息，可參考Apache 的 SSI 簡(jiǎn)介。

變量

SSI servlet 當(dāng)前能實(shí)現(xiàn)下列變量：