OSCache使用指南
?OSCache是當(dāng)前運(yùn)用最廣的緩存方案,JBoss,Hibernate,Spring等都對(duì)其有支持,下面簡(jiǎn)單介紹一下OSCache的配置和使用過(guò)程。
1.安裝過(guò)程
從http://www.opensymphony.com/oscache/download.html下載合適的OSCache版本,
我下載的是oscache-2.0.2-full版本。
解壓縮下載的文件到指定目錄
從解壓縮目錄取得oscache.jar? 文件放到? /WEB-INF/lib? 或相應(yīng)類庫(kù)目錄? 目錄中,
jar文件名可能含有版本號(hào)和該版本的發(fā)布日期信息等,如oscache-2.0.2-22Jan04.jar
如果你的jdk版本為1.3.x,建議在lib中加入Apache? Common? Lib? 的commons-collections.jar包。
如jdk是1.4以上則不必
從src或etc目錄取得oscache.properties? 文件,放入src根目錄或發(fā)布環(huán)境的/WEB-INF/classes? 目錄
如你需要建立磁盤緩存,須修改oscache.properties? 中的cache.path信息? (去掉前面的#注釋)。
win類路徑類似為c:\app\cache
unix類路徑類似為/opt/myapp/cache
拷貝OSCache標(biāo)簽庫(kù)文件oscache.tld到/WEB-INF/classes目錄。
現(xiàn)在你的應(yīng)用目錄類似如下:
$WEB_APPLICATIONWEB-INFliboscache.jar
$WEB_APPLICATIONWEB-INFclassesoscache.properties
$WEB_APPLICATIONWEB-INFclassesoscache.tld
將下列代碼加入web.xml文件中
程序代碼:
<taglib>
<taglib-uri>oscache</taglib-uri>
<taglib-location>/WEB-INF/classes/oscache.tld</taglib-location>
</taglib>
為了便于調(diào)試日志輸出,須加入commons-logging.jar和log4j-1.2.8.jar到當(dāng)前類庫(kù)路徑中
在src目錄加入下面兩個(gè)日志輸出配置文件:
log4j.properties? 文件內(nèi)容為:
程序代碼:
log4j.rootLogger=DEBUG,stdout,file
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[start]%d{yyyy/MM/dd/ HH:mm:ss}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=oscache.log
log4j.appender.file.MaxFileSize=100KB
log4j.appender.file.MaxBackupIndex=5
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[start]%d{yyyy/MM/dd/ HH:mm:ss}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
log4j.logger.org.apache.commons=ERROR
log4j.logger.com.opensymphony.oscache.base=INFO
commons-logging.properties 文件內(nèi)容為
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JCategoryLog
2.oscache.properties? 文件配置向?qū)?
cache.memory
值為true? 或? false? ,默認(rèn)為在內(nèi)存中作緩存,
如設(shè)置為false,那cache只能緩存到數(shù)據(jù)庫(kù)或硬盤中,那cache還有什么意義:)
cache.capacity
緩存元素個(gè)數(shù)
cache.persistence.class
持久化緩存類,如此類打開(kāi),則必須設(shè)置cache.path信息
cache.cluster? 相關(guān)
為集群設(shè)置信息。
如
cache.cluster.multicast.ip為廣播IP地址
cache.cluster.properties為集群屬性
3.OSCache的基本用法
cache1.jsp? 內(nèi)容如下
程序代碼:
<%@ page import="java.util.*" %>
<%@ taglib uri="oscache" prefix="cache" %>
<html>
<body>
沒(méi)有緩存的日期: <%= new Date() %><p>
<!--自動(dòng)刷新-->
<cache:cache time="30">
每30秒刷新緩存一次的日期: <%= new Date() %>
</cache:cache>
<!--手動(dòng)刷新-->
<cache:cache key="testcache">
手動(dòng)刷新緩存的日期: <%= new Date() %> <p>
</cache:cache>
<a href="cache2.jsp">手動(dòng)刷新</a>
</body>
</html>
cache2.jsp? 執(zhí)行手動(dòng)刷新頁(yè)面如下
<? %@? taglib? uri="oscache"? prefix="cache"? %? >
<html>
<body>
緩存已刷新...<p>
<cache:flush? key="testcache"? scope="application"/>
<a? href="cache1.jsp">返回</a>
</body>
</html>
你也可以通過(guò)下面語(yǔ)句定義Cache的有效范圍,如不定義scope,scope默認(rèn)為Applcation
程序代碼:
<cache:cache time="30" scope="session">
...
</cache:cache>
4.? 緩存過(guò)濾器? CacheFilter?
你可以在web.xml中定義緩存過(guò)濾器,定義特定資源的緩存。
程序代碼:
<filter>
<filter-name>CacheFilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.CacheFilter</filter-class>
<init-param>
<param-name>time</param-name>
<param-value>60</param-value>
</init-param>
<init-param>
<param-name>scope</param-name>
<param-value>session</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CacheFilter</filter-name>
<url-pattern>*.jsp</url-pattern>
</filter-mapping>
上面定義將緩存所有.jsp頁(yè)面,緩存刷新時(shí)間為60秒,緩存作用域?yàn)镾ession
注意,CacheFilter只捕獲Http頭為200的頁(yè)面請(qǐng)求,即只對(duì)無(wú)錯(cuò)誤請(qǐng)求作緩存,
而不對(duì)其他請(qǐng)求(如500,404,400)作緩存處理
OSCache簡(jiǎn)介
OSCache是OpenSymphony組織提供的一個(gè)J2EE架構(gòu)中Web應(yīng)用層的緩存技術(shù)實(shí)現(xiàn)組件,它的出現(xiàn)解決了我們面臨的問(wèn)題。 OSCache目前最新的穩(wěn)定版本是2.0,本文中的例子都是基于這個(gè)版本的,如果大家運(yùn)行例子的過(guò)程中發(fā)生問(wèn)題,請(qǐng)首先確認(rèn)是否采用了正確的軟件版本。
2.1 主要特征
1. 兼容多種支持JSP的web服務(wù)器
已經(jīng)通過(guò)兼容測(cè)試的web服務(wù)器包括OrionServer (1.4.0或者以上版本) 、Macromedia JRun (3.0或者以上版本) 、BEA Weblogic (7.x或者以上版本) 、IBM Websphere (5.0版本)、Silverstream (3.7.4版本)、Caucho Resin (1.2.3或者以上版本)、Tomcat (4.0或者以上版本) ,其他支持servlet2.3、jsp1.2的web服務(wù)器應(yīng)該都是完全兼容OSCache的。
2. 可選的緩存區(qū)
你可以使用內(nèi)存、硬盤空間、同時(shí)使用內(nèi)存和硬盤或者提供自己的其他資源(需要自己提供適配器)作為緩存區(qū)。
使用內(nèi)存作為緩存區(qū)將可以提供更好的性能
使用硬盤作為緩存區(qū)可以在服務(wù)器重起后迅速恢復(fù)緩存內(nèi)容
同時(shí)使用內(nèi)存和硬盤作為緩存區(qū)則可以減少對(duì)內(nèi)存的占用
3. 靈活的緩存系統(tǒng)
OSCache支持對(duì)部分頁(yè)面內(nèi)容或者對(duì)頁(yè)面級(jí)的響應(yīng)內(nèi)容進(jìn)行緩存,編程者可以根據(jù)不同的需求、不同的環(huán)境選擇不同的緩存級(jí)別。
4. 容錯(cuò)
在一般的web應(yīng)用中,如果某個(gè)頁(yè)面需要和數(shù)據(jù)庫(kù)打交道,而當(dāng)客戶請(qǐng)求到達(dá)時(shí),web應(yīng)用和數(shù)據(jù)庫(kù)之間無(wú)法進(jìn)行交互,那么將返回給用戶"系統(tǒng)出錯(cuò)"或者類似的提示信息,如果使用了OSCache的話,你可以使用緩存提供給用戶,給自己贏得維護(hù)系統(tǒng)或者采取其他補(bǔ)救的時(shí)間。
其它特性還包括對(duì)集群的支持、緩存主動(dòng)刷新等特性,大家可以參考OpenSymphony網(wǎng)站上的其他資源獲取更多的信息。
3 OSCache組件的安裝
OSCache是一個(gè)基于web應(yīng)用的組件,他的安裝工作主要是對(duì)web應(yīng)用進(jìn)行配置,大概的步驟如下:
1. 下載、解壓縮OSCache
請(qǐng)到OSCache的主頁(yè)http://www.opensymphony.com/oscache/download.html下載Oscache的最新版本,作者下載的是OSCache的最新穩(wěn)定版本2.0。
將下載后的。Zip文件解壓縮到c:\oscache(后面的章節(jié)中將使用%OSCache_Home%來(lái)表示這個(gè)目錄)目錄下
2. 新建立一個(gè)web應(yīng)用
3. 將主要組件%OSCache_Home%\oscache.jar放入WEB-INF\lib目錄
4. commons-logging.jar、commons-collections.jar的處理
OSCache組件用Jakarta Commons Logging來(lái)處理日志信息,所以需要commons-logging.jar的支持,請(qǐng)將%OSCache_Home%\lib\core\commons-logging.jar放入classpath(通常意味著將這個(gè)文件放入WEB-INF\lib目錄)
如果使用JDK1.3,請(qǐng)將%OSCache_Home%\lib\core\commons-collections.jar放入classpath,如果使用JDK1.4或者以上版本,則不需要了
5. 將oscache.properties、oscache.tld放入WEB-INF\class目錄
%OSCache_Home%\oscache.properties包含了對(duì)OSCache運(yùn)行特征值的設(shè)置信息
%OSCache_Home%\oscache.tld包含了OSCache提供的標(biāo)簽庫(kù)的定義內(nèi)容
6. 修改web.xml文件
在web.xml文件中增加下面的內(nèi)容,增加對(duì)OSCache提供的taglib的支持:
<taglib>
<taglib-uri>oscache</taglib-uri>
<taglib-location>/WEB-INF/classes/ oscache.tld</taglib-location>
</taglib>
4 開(kāi)始使用OSCache中的緩存組件
OSCache中按照緩存范圍的不同分為兩種不同的方式:一種是緩存JSP頁(yè)面中部分或者全部?jī)?nèi)容,一種是基于整個(gè)頁(yè)面文件的緩存。
4.1 JSP部分內(nèi)容緩存
4.1.1 Cache-OSCache提供的緩存標(biāo)簽
這是OSCache提供的標(biāo)簽庫(kù)中最重要的一個(gè)標(biāo)簽,包括在標(biāo)簽中的內(nèi)容將應(yīng)用緩存機(jī)制進(jìn)行處理,處理的方式將取決于編程者對(duì)cache標(biāo)簽屬性的設(shè)置。
第一次請(qǐng)求到達(dá)時(shí),標(biāo)簽中的內(nèi)容被處理并且緩存起來(lái),當(dāng)下一個(gè)請(qǐng)求到達(dá)時(shí),緩存系統(tǒng)會(huì)檢查這部分內(nèi)容的緩存是否已經(jīng)失效,主要是以下幾項(xiàng):
1. 緩存時(shí)間超過(guò)了cache標(biāo)簽設(shè)置的time或者duration屬性規(guī)定的超時(shí)時(shí)間
2. cron屬性規(guī)定的時(shí)間比緩存信息的開(kāi)始時(shí)間更晚
3. 標(biāo)簽中緩存的內(nèi)容在緩存后又被重新刷新過(guò)
4. 其他緩存超期設(shè)定
如果符合上面四項(xiàng)中的任何一項(xiàng),被緩存的內(nèi)容視為已經(jīng)失效,這時(shí)被緩存的內(nèi)容將被重新處理并且返回處理過(guò)后的信息,如果被緩存的內(nèi)容沒(méi)有失效,那么返回給用戶的將是緩存中的信息。
cache標(biāo)簽的屬性說(shuō)明:
key - 標(biāo)識(shí)緩存內(nèi)容的關(guān)鍵詞。在指定的作用范圍內(nèi)必須是唯一的。默認(rèn)的key是被訪問(wèn)頁(yè)面的URI和后面的請(qǐng)求字符串。
你可以在同一個(gè)頁(yè)面中使用很多cache標(biāo)簽而不指定他的key屬性,這種情況下系統(tǒng)使用該頁(yè)面的URI和后面的請(qǐng)求字符串,另外再自動(dòng)給這些key增加一個(gè)索引值來(lái)區(qū)分這些緩存內(nèi)容。但是不推薦采用這樣的方式。
scope - 緩存發(fā)生作用的范圍,可以是application或者session
time - 緩存內(nèi)容的時(shí)間段,單位是秒,默認(rèn)是3600秒,也就是一個(gè)小時(shí),如果設(shè)定一個(gè)負(fù)值,那么這部分被緩存的內(nèi)容將永遠(yuǎn)不過(guò)期。
duration - 指定緩存內(nèi)容失效的時(shí)間,是相對(duì)time的另一個(gè)選擇,可以使用簡(jiǎn)單日期格式或者符合USO-8601的日期格式。如:duration='PT5M' duration='5s'等
refresh - false 或者true。
如果refresh屬性設(shè)置為true,不管其他的屬性是否符合條件,這部分被緩存的內(nèi)容都將被更新,這給編程者一種選擇,決定什么時(shí)候必須刷新。
mode - 如果編程者不希望被緩存的內(nèi)容增加到給用戶的響應(yīng)中,可以設(shè)置mode屬性為"silent"
其它可用的屬性還包括:cron 、groups、language、refreshpolicyclass、refreshpolicyparam。
上面的這些屬性可以單獨(dú)使用,也可以根據(jù)需要組合使用,下面的例子將講解這些常用屬性的使用方式。
4.1.2 Cache標(biāo)簽實(shí)例分析:
1. 最簡(jiǎn)單的cache標(biāo)簽用法
使用默認(rèn)的關(guān)鍵字來(lái)標(biāo)識(shí)cache內(nèi)容,超時(shí)時(shí)間是默認(rèn)的3600秒
<cache:cache>
<%
//自己的JSP代碼內(nèi)容
%>
</cache:cache>
2. 用自己指定的字符串標(biāo)識(shí)緩存內(nèi)容,并且設(shè)定作用范圍為session。
<cache:cache key="foobar" scope="session">
<%
//自己的JSP代碼內(nèi)容
%>
</cache:cache>
3.動(dòng)態(tài)設(shè)定key值,使用自己指定的time屬性設(shè)定緩存內(nèi)容的超時(shí)時(shí)間,使用動(dòng)態(tài)refresh值決定是否強(qiáng)制內(nèi)容刷新。
因?yàn)?/font>OSCache使用key值來(lái)標(biāo)識(shí)緩存內(nèi)容,使用相同的key值將會(huì)被認(rèn)為使用相同的的緩存內(nèi)容,所以使用動(dòng)態(tài)的key值可以自由的根據(jù)不同的角色、不同的要求決定使用不同的緩存內(nèi)容。
<cache:cache key="<%= product.getId() %>" time="1800" refresh="<%= needRefresh %>">
<%
//自己的JSP代碼內(nèi)容
%>
</cache:cache>
4. 設(shè)置time屬性為負(fù)數(shù)使緩存內(nèi)容永不過(guò)期
<cache:cache time="-1">
<%
//自己的JSP代碼內(nèi)容
%>
5. 使用duration屬性設(shè)置超期時(shí)間
<cache:cache duration='PT5M'>
<%
//自己的JSP代碼內(nèi)容
%>
6. 使用mode屬性使被緩存的內(nèi)容不加入給客戶的響應(yīng)中
<cache:cache mode='silent'>
<%
//自己的JSP代碼內(nèi)容
%>
4.2 用CashFilter實(shí)現(xiàn)頁(yè)面級(jí)緩存
在OSCache組件中提供了一個(gè)CacheFilter用于實(shí)現(xiàn)頁(yè)面級(jí)的緩存,主要用于對(duì)web應(yīng)用中的某些動(dòng)態(tài)頁(yè)面進(jìn)行緩存,尤其是那些需要生成pdf格式文件/報(bào)表、圖片文件等的頁(yè)面,不僅減少了數(shù)據(jù)庫(kù)的交互、減少數(shù)據(jù)庫(kù)服務(wù)器的壓力,而且對(duì)于減少web服務(wù)器的性能消耗有很顯著的效果。
這種功能的實(shí)現(xiàn)是通過(guò)在web.xml中進(jìn)行配置來(lái)決定緩存哪一個(gè)或者一組頁(yè)面,而且還可以設(shè)置緩存的相關(guān)屬性,這種基于配置文件的實(shí)現(xiàn)方式對(duì)于J2EE來(lái)說(shuō)應(yīng)該是一種標(biāo)準(zhǔn)的實(shí)現(xiàn)方式了。
[注] 只有客戶訪問(wèn)時(shí)返回http頭信息中代碼為200(也就是訪問(wèn)已經(jīng)成功)的頁(yè)面信息才能夠被緩存
1. 緩存單個(gè)文件
修改web.xml,增加如下內(nèi)容,確定對(duì)/testContent.jsp頁(yè)面進(jìn)行緩存。
<filter>
<filter-name>CacheFilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.CacheFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>CacheFilter</filter-name>
<!-對(duì)/testContent.jsp頁(yè)面內(nèi)容進(jìn)行緩存-->
<url-pattern>/testContent.jsp</url-pattern>
</filter-mapping>
2. 緩存URL pattern
修改web.xml,增加如下內(nèi)容,確定對(duì)*.jsp頁(yè)面進(jìn)行緩存。
<filter>
<filter-name>CacheFilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.CacheFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>CacheFilter</filter-name>
<!-對(duì)所有jsp頁(yè)面內(nèi)容進(jìn)行緩存-->
<url-pattern>*.jsp</url-pattern>
</filter-mapping>
3. 自己設(shè)定緩存屬性
在頁(yè)面級(jí)緩存的情況下,可以通過(guò)設(shè)置CacheFilter的初始屬性來(lái)決定緩存的一些特性:time屬性設(shè)置緩存的時(shí)間段,默認(rèn)為3600秒,可以根據(jù)自己的需要只有的設(shè)置,而scope屬性設(shè)置,默認(rèn)為application,可選項(xiàng)包括application、session
<filter>
<filter-name>CacheFilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.CacheFilter</filter-class>
<init-param>
<param-name>time</param-name>
<param-value>600</param-value>
</init-param>
<init-param>
<param-name>scope</param-name>
<param-value>session</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CacheFilter</filter-name>
<!-對(duì)所有jsp頁(yè)面內(nèi)容進(jìn)行緩存-->
<url-pattern>*.jsp</url-pattern>
</filter-mapping>
posted on 2006-10-11 09:37 捕風(fēng) 閱讀(452) 評(píng)論(0) 編輯 收藏 所屬分類: java高級(jí)