OSCache入门教程

1. OSCache入门教程

 

OSCache是一个开放式资源缓冲库，可从http://www.opensymphony.com/oscache免费下载。它包括一组JSP的标签，通过它们可以很容易的在你的程序中实现页面缓存，同时，还可以使用它的过滤器，可缓冲的不仅仅是JSP页面，还可以缓存任何Servlet生成的内容。
　　 下面先介绍一下它的一些术语：
　　 缓冲记录：存储在页面缓存器内的对象称为一个缓冲记录。在一个JSP程序中，它通常是一个JSP页面、JSP页面的一部分或Servlet的输出。
　　 缓冲键码：它就像一个哈西表（Hash Table）。当在页面缓存中存储缓冲记录时，你必须提供缓冲键码来识别各个条目。在一个JSP程序中，你可能需要把几个请求参数组合在一起来形成缓冲键码，或者使用页面请求URI作为缓冲键码。
　　 缓冲周期：是一个缓冲记录在保留在页面缓存器中的时间。对于一个显示数据时常更新的JSP页面，你应该设定一个短的缓冲周期。
　　 缓冲域：是缓冲被存储在的作用域。你可以在应用程序域内存储缓冲记录，这样，缓冲记录可以被所有用户分享；或者在会话域，在前用户基础上存储缓冲记录。
　　安装OSCache
　　 解压下载下来的文件包，将oscache.jar放到lib目录下，将oscache.properties和oscache.tld放到WEB-INF/classes下。在web.xml中加入标签库的配置：
　　 <taglib>
　　 <taglib-uri>oscache</taglib-uri>
　　 <taglib-location>/WEB-INF/classes/oscache.tld</taglib-location>
　　 </taglib>
　　 oscache.properties文件是它的配置，如果你像将缓存文件存放在硬盘上，并使用windows，在指定目录上需要使用//。比如你的目录是c:/cache，那么应该写上c://cache。
　　OSCache JSP标签
　　 使用这些标签很简单。你要做的是在需要缓存的JSP页面部分防止<os:cache>标签。以下JSP页面的示例表明了其实现方法：
　　 <!--导入标签库-->
　　 <%@ taglib uri="/WEB-INF/oscache.tld" prefix="os" %>
　　 <!--开始使用-->
　　 <os:cache time="60">
　　 <!--这里是你要缓存的JSP代码-->
　　 <os:cache>
　　 怎么样很简单吧，你只需把你要缓存的代码用<os:cache>标签包围起来即可，这里缓存周期是60秒，你可以根据你的具体情况来修改。在这个例子中，我们没有指定一个缓冲键码，默认情况下，OSCache将使用请求URI作为缓冲记录的键码。也没有指定一个缓冲域，默认情况下将会使用应用程序域。
　　OSCacheServlet过滤器
　　 我们现在可以用它的过滤器来缓冲Servlet的输出，通过使用com.opensymphony.module.oscache.web.filter.CacheFilter类来实现。现在你需要做的是在程序的web.xml中添加这个过滤器，以及为所有你希望缓存的URL样式添加过滤器映射。以下是web.xml文件，我们只给出需要的部分：
　　 <filter>
　　 <filter-name>CacheFilter</filter-name>
　　 <filter-class>com.opensymphony.module.oscache.web.filter.CacheFilter</filter-class>
　　 <init-param>
　　 <param-name>time</param-name>
　　 <param-value>60</param-value>
　　 </init-param>
　　 </filter>
　　 <filter-mapping>
　　 <filter-name>CacheFilter</filter-name>
　　 <uri-pattern>/servlets/*</url-pattern>
　　 </filter-mapping>
　　 过滤器元素应该在上下文参数之后，但在Servlet和监听器元素之前。
　　 如同前面JSP的例子一样，我们同样设置了缓冲时间为60秒。其他的参数，如缓冲键码和缓冲域被省略，使用默认值。<filter-mapping>元素配置CacheFilter，以便它为匹配样式/servlets/*的所有请求URL缓冲相应输出。
　　 这篇教程只是简单的介绍一下OSCache的用法，以后我会在继续添加

 

2.OSCache的配置和使用过程

 

OSCache是当前运用最广的缓存方案，JBoss,Hibernate,Spring等都对其有支持，

下面简单介绍一下OSCache的配置和使用过程。

 

1.安装过程

从http://www.opensymphony.com/oscache/download.html下载合适的OSCache版本，

我下载的是oscache-2.0.2-full版本。

解压缩下载的文件到指定目录

 

从解压缩目录取得oscache.jar 文件放到 /WEB-INF/lib 或相应类库目录 目录中，

jar文件名可能含有版本号和该版本的发布日期信息等，如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根目录或发布环境的/WEB-INF/classes 目录

如你需要建立磁盘缓存，须修改oscache.properties 中的cache.path信息 (去掉前面的#注释)。

win类路径类似为c://app//cache

unix类路径类似为/opt/myapp/cache

 

拷贝OSCache标签库文件oscache.tld到/WEB-INF/classes目录。

 

现在你的应用目录类似如下：

$WEB_APPLICATION/WEB-INF/lib/oscache.jar

$WEB_APPLICATION/WEB-INF/classes/oscache.properties

$WEB_APPLICATION/WEB-INF/classes/oscache.tld

 

 

将下列代码加入web.xml文件中

<taglib>

<taglib-uri>oscache</taglib-uri>

<taglib-location>/WEB-INF/classes/oscache.tld</taglib-location>

</taglib>

 

为了便于调试日志输出，须加入commons-logging.jar和log4j-1.2.8.jar到当前类库路径中

 

在src目录加入下面两个日志输出配置文件：

log4j.properties 文件内容为：

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 文件内容为

 

org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JCategoryLog

 

2.oscache.properties 文件配置向导

 

cache.memory

值为true 或 false ，默认为在内存中作缓存，

如设置为false，那cache只能缓存到数据库或硬盘中，那cache还有什么意义：）

 

cache.capacity

缓存元素个数

 

cache.persistence.class

持久化缓存类，如此类打开，则必须设置cache.path信息

 

cache.cluster 相关

为集群设置信息。

如

cache.cluster.multicast.ip为广播IP地址

cache.cluster.properties为集群属性

 

 

3.OSCache的基本用法

 

cache1.jsp 内容如下

 

<%@ page import="java.util.*" %>

<%@ taglib uri="oscache" prefix="cache" %>

 

<html>

<body>

 

没有缓存的日期: <%= new Date() %><p>

<!--自动刷新-->

<cache:cache time="30">

每30秒刷新缓存一次的日期: <%= new Date() %>

</cache:cache>

<!--手动刷新-->

<cache:cache key="testcache">

手动刷新缓存的日期: <%= new Date() %> <p>

</cache:cache>

<a href="cache2.jsp">手动刷新</a>

</body>

</html>

cache2.jsp 执行手动刷新页面如下

<%@ taglib uri="oscache" prefix="cache" %>

 

<html>

<body>

缓存已刷新...<p>

<cache:flush key="testcache" scope="application"/>

<a href="cache1.jsp">返回</a>

</body>

</html>

 

你也可以通过下面语句定义Cache的有效范围,如不定义scope,scope默认为Applcation

<cache:cache time="30" scope="session">

...

</cache:cache>

 

 

 

4. 缓存过滤器 CacheFilter

你可以在web.xml中定义缓存过滤器，定义特定资源的缓存。

<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页面，缓存刷新时间为60秒，缓存作用域为Session

 

注意，CacheFilter只捕获Http头为200的页面请求，即只对无错误请求作缓存，

而不对其他请求（如500,404,400）作缓存处理 .

 

 

备注：内存+硬盘作缓存配置

 

cache.memory=true

cache.persistence.class=com.opensymphony.oscache.plugins.diskpersistence.DiskPersistenceListener

cache.path=/home02/work/oscache

cache.persistence.overflow.only=true

cache.capacity=1000

 

 

3.用OSCache提升J2EE系统运行性能

<H4>文章摘要</H4>

  Cache是一种用于提高系统响应速度、改善系统运行性能的技术。尤其是在Web应用中，通过缓存页面的输出结果，可以很显著的改善系统运行性能。本文中作者给大家介绍一个实现J2EE框架中Web应用层缓存功能的开放源代码项目----OSCache。通过应用OSCache，我们不但可以实现通常的Cache功能，还能够改善系统的稳定性。<H4>1 面临的问题</H4>

<H4>1.1 需要处理的特殊动态内容</H4>

 

在信息系统建设过程中我们通常会遇到这样的问题：

1. 基础数据的变更问题

  信息系统中需要处理的基础数据的内容短时间内是不会发生变化的，但是在一个相对长一些的时间里，它却可能是动态增加或者减少的。

  举个例子：电子商务中关于送货区域的定义，可能短时间内不会发生变化，但是随着电子商务企业业务的扩大，系统中需要处理的送货区域就可能增加。所以我们的系统中不得不在每次向客户展示送货区域信息的时候都和数据库（假设送货区域信息保存在数据库中，这也是通常采用的处理方法）进行交互。

2. 统计报表（不仅限于统计报表）的问题

   一般来说，统计报表是一个周期性的工作，可能是半个月、一个月或者更长的时间才会需要更新一次，然而统计报表通常是图形显示或者是生成pdf、word、excel等格式的文件，这些图形内容、文件的生成通常需要消耗很多的系统资源，给系统运行造成很大的负担。<H4>1.2 问题的共同点</H4>

 

通过比较分析，不难发现这两类问题有一些共同点：

1、被处理的内容短时间不变，所以短时间内可以作为静态内容进行处理

2、在一个不太长的时间内，被处理的内容可能或者必定产生变化，所以必须将他们作为动态内容进行处理

3、在合理的时间区段内可以忽略被处理内容变化后带来的影响

4、对这些内容的处理动作比较消耗系统性能，影响系统响应时间<H4>1.3 解决方法</H4>

 

缓存技术可以帮助我们很好的解决这个问题：

1、缓存信息

  当上述的基础数据或者统计报表第一次被访问时，被处理的内容被当作动态信息，基础数库从数据库中获得，统计报表也会被生成符合要求的图形、文件，然后这些信息都会被放入缓存信息中。

2、响应信息由缓存提供

  当上述的基础数据或者统计报表继续被访问时，系统将会首先检查缓存信息中是否有对应的内容和我们设定的缓存规则，如果符合缓存信息存在而且符合缓存规则，给出的响应将来自于缓存信息，如果没有或者缓存信息已经不符合设定的要求，系统将重复上一步的动作。

  很显然，上面的步骤2中，多数情况下，当用户请求到达时，被处理的内容将来自于缓存，所以大大的减少了与数据库的交互，或者不再需要为每个请求都生成一次报表图形或者文件，这部分工作的减少对于降低系统性能消耗、提高系统稳定性和并发处理能力是非常有益的。<H4>2 OSCache简介</H4>

 

  OSCache是OpenSymphony组织提供的一个J2EE架构中Web应用层的缓存技术实现组件，它的出现解决了我们面临的问题。 OSCache目前最新的稳定版本是2.0，本文中的例子都是基于这个版本的，如果大家运行例子的过程中发生问题，请首先确认是否采用了正确的软件版本。<H4>2.1 主要特征</H4>

 

1. 兼容多种支持JSP的web服务器

   已经通过兼容测试的web服务器包括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服务器应该都是完全兼容OSCache的。

2. 可选的缓存区

   你可以使用内存、硬盘空间、同时使用内存和硬盘或者提供自己的其他资源（需要自己提供适配器）作为缓存区。

 

使用内存作为缓存区将可以提供更好的性能

使用硬盘作为缓存区可以在服务器重起后迅速恢复缓存内容

同时使用内存和硬盘作为缓存区则可以减少对内存的占用

 

3. 灵活的缓存系统

  OSCache支持对部分页面内容或者对页面级的响应内容进行缓存，编程者可以根据不同的需求、不同的环境选择不同的缓存级别。

4. 容错

  在一般的web应用中，如果某个页面需要和数据库打交道，而当客户请求到达时，web应用和数据库之间无法进行交互，那么将返回给用户"系统出错"或者类似的提示信息，如果使用了OSCache的话，你可以使用缓存提供给用户，给自己赢得维护系统或者采取其他补救的时间。

  其它特性还包括对集群的支持、缓存主动刷新等特性，大家可以参考OpenSymphony网站上的其他资源获取更多的信息。

 

 

<H4>3 OSCache组件的安装</H4>

 

OSCache是一个基于web应用的组件，他的安装工作主要是对web应用进行配置，大概的步骤如下：

1. 下载、解压缩OSCache

  请到OSCache的主页http://www.opensymphony.com/oscache/download.html下载Oscache的最新版本，作者下载的是OSCache的最新稳定版本2.0。

  将下载后的。Zip文件解压缩到c:/oscache（后面的章节中将使用%OSCache_Home%来表示这个目录）目录下

2. 新建立一个web应用

3. 将主要组件%OSCache_Home%/oscache.jar放入WEB-INF/lib目录

4. commons-logging.jar、commons-collections.jar的处理

 

OSCache组件用Jakarta Commons Logging来处理日志信息，所以需要commons-logging.jar的支持，请将%OSCache_Home%/lib/core/commons-logging.jar放入classpath（通常意味着将这个文件放入WEB-INF/lib目录）

如果使用JDK1.3,请将%OSCache_Home%/lib/core/commons-collections.jar放入classpath，如果使用JDK1.4或者以上版本，则不需要了

 

5. 将oscache.properties、oscache.tld放入WEB-INF/class目录

 

%OSCache_Home%/oscache.properties包含了对OSCache运行特征值的设置信息

%OSCache_Home%/oscache.tld包含了OSCache提供的标签库的定义内容

 

6. 修改web.xml文件

在web.xml文件中增加下面的内容，增加对OSCache提供的taglib的支持：

<taglib><taglib-uri>oscache</taglib-uri><taglib-location>/WEB-INF/classes/ oscache.tld</taglib-location></taglib> [/PRE]

 

<H4>4 开始使用OSCache中的缓存组件</H4>

 

  OSCache中按照缓存范围的不同分为两种不同的方式：一种是缓存JSP页面中部分或者全部内容，一种是基于整个页面文件的缓存。<H4>4.1 JSP部分内容缓存</H4>

<H4>4.1.1 Cache-OSCache提供的缓存标签</H4>

   这是OSCache提供的标签库中最重要的一个标签，包括在标签中的内容将应用缓存机制进行处理，处理的方式将取决于编程者对cache标签属性的设置。

   第一次请求到达时，标签中的内容被处理并且缓存起来，当下一个请求到达时，缓存系统会检查这部分内容的缓存是否已经失效，主要是以下几项：

 

1. 缓存时间超过了cache标签设置的time或者duration属性规定的超时时间

2. cron属性规定的时间比缓存信息的开始时间更晚

3. 标签中缓存的内容在缓存后又被重新刷新过

4. 其他缓存超期设定

 

  如果符合上面四项中的任何一项，被缓存的内容视为已经失效，这时被缓存的内容将被重新处理并且返回处理过后的信息，如果被缓存的内容没有失效，那么返回给用户的将是缓存中的信息。

 

cache标签的属性说明:

  key - 标识缓存内容的关键词。在指定的作用范围内必须是唯一的。默认的key是被访问页面的URI和后面的请求字符串。

   你可以在同一个页面中使用很多cache标签而不指定他的key属性，这种情况下系统使用该页面的URI和后面的请求字符串，另外再自动给这些key增加一个索引值来区分这些缓存内容。但是不推荐采用这样的方式。

scope - 缓存发生作用的范围，可以是application或者session

time - 缓存内容的时间段，单位是秒，默认是3600秒，也就是一个小时，如果设定一个负值，那么这部分被缓存的内容将永远不过期。

duration - 指定缓存内容失效的时间，是相对time的另一个选择，可以使用简单日期格式或者符合USO-8601的日期格式。如：duration='PT5M' duration='5s'等

refresh - false 或者true。

如果refresh属性设置为true，不管其他的属性是否符合条件，这部分被缓存的内容都将被更新，这给编程者一种选择，决定什么时候必须刷新。

mode - 如果编程者不希望被缓存的内容增加到给用户的响应中，可以设置mode属性为"silent"

其它可用的属性还包括：cron 、groups、language、refreshpolicyclass、refreshpolicyparam。

上面的这些属性可以单独使用，也可以根据需要组合使用，下面的例子将讲解这些常用属性的使用方式。<H4>4.1.2 Cache标签实例分析:</H4>

 

1. 最简单的cache标签用法

使用默认的关键字来标识cache内容，超时时间是默认的3600秒

<cache:cache><%//自己的JSP代码内容%></cache:cache> [/PRE]

 

 

2. 用自己指定的字符串标识缓存内容，并且设定作用范围为session。

<cache:cache key="foobar" scope="session"><%//自己的JSP代码内容%></cache:cache> [/PRE]

 

 

3.动态设定key值，

使用自己指定的time属性设定缓存内容的超时时间，

使用动态refresh值决定是否强制内容刷新。

   因为OSCache使用key值来标识缓存内容，使用相同的key值将会被认为使用相同的的缓存内容，所以使用动态的key值可以自由的根据不同的角色、不同的要求决定使用不同的缓存内容。

<cache:cache key="<%= product.getId() %>" time="1800" refresh="<%= needRefresh %>"><%//自己的JSP代码内容%></cache:cache> [/PRE]

 

 

4. 设置time属性为负数使缓存内容永不过期

<cache:cache time="-1"><%//自己的JSP代码内容%>[/PRE]

 

 

5. 使用duration属性设置超期时间

<cache:cache  duration='PT5M'><%//自己的JSP代码内容%>[/PRE]

 

 

6. 使用mode属性使被缓存的内容不加入给客户的响应中

<cache:cache  mode='silent'><%//自己的JSP代码内容%>[/PRE]