oscache应用简介

cache是一种用于提高系统响应速度、改善系统运行性能的技术。尤其是在web应用中，通过缓存页面的输出结果，能非常显著的改善系统运行性能。本文介绍一个实现j2ee框架中web应用层缓存功能的开放原始码项目----oscache。通过应用oscache，我们不仅能实现通常的cache功能，还能够改善系统的稳定性。

1 面临的问题


1.1 需要处理的特别动态内容


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

1. 基础数据的变更问题

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

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

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

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

1.2 问题的一起点


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

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

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

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

4、对这些内容的处理动作比较消耗系统性能，影响系统响应时间

1.3 解决方法


缓存技术能帮助我们非常好的解决这个问题：

1、缓存信息

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

2、响应信息由缓存提供

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

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

2 oscache简介


oscache是opensymphony组织提供的一个j2ee架构中web应用层的缓存技术实现组件，他的出现解决了我们面临的问题。 oscache目前最新的稳定版本是2.0，本文中的例子都是基于这个版本的，如果大家运行例子的过程中发生问题，请首先确认是否采用了正确的软件版本。

2.1 主要特征


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网站上的其他资源获取更多的信息。

3 oscache组件的安装


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>




4 开始使用oscache中的缓存组件


oscache中按照缓存范围的不同分为两种不同的方式：一种是缓存jsp页面中部分或全部内容，一种是基于整个页面文件的缓存。

4.1 jsp部分内容缓存


4.1.1 cache-oscache提供的缓存标签


这是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。

上面的这些属性能独立使用，也能根据需要组合使用，下面的例子将讲解这些常用属性的使用方式。

4.1.2 cache标签实例分析:


1. 最简单的cache标签用法

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

<cache:cache>
<%
//自己的jsp代码内容
%>
</cache:cache>




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

<cache:cache key="foobar" scope="session">
<%
//自己的jsp代码内容
%>
</cache:cache>




3.动态设定key值，使用自己指定的time属性设定缓存内容的超时时间，使用动态refresh值决定是否强制内容刷新。

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

<cache:cache key="<%= product.getid() %>" time="1800" refresh="<%= needrefresh %>">
<%
//自己的jsp代码内容
%>
</cache:cache>




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

<cache:cache time="-1">
<%
//自己的jsp代码内容
%>




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

<cache:cache duration=pt5m>
<%
//自己的jsp代码内容
%>




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

<cache:cache mode=silent>
<%
//自己的jsp代码内容
%>




4.2 用cashfilter实现页面级缓存


在oscache组件中提供了一个cachefilter用于实现页面级的缓存，主要用于对web应用中的某些动态页面进行缓存，尤其是那些需要生成pdf格式文件/报表、图片文件等的页面，不仅减少了数据库的交互、减少数据库服务器的压力，而且对于减少web服务器的性能消耗有非常显著的效果。

这种功能的实现是通过在web.xml中进行设置来决定缓存哪一个或一组页面，而且还能设置缓存的相关属性，这种基于设置文件的实现方式对于j2ee来说应该是一种标准的实现方式了。

[注] 只有客户访问时返回http头信息中代码为200（也就是访问已成功）的页面信息才能够被缓存

1. 缓存单个文件

修改web.xml，增加如下内容，确定对/testcontent.jsp页面进行缓存。

<filter>
<filter-name>cachefilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.cachefilter</filter-class>
</filter>
<filter-mapping>
<filter-name>cachefilter</filter-name>
<!-对/testcontent.jsp页面内容进行缓存-->
<url-pattern>/testcontent.jsp</url-pattern>
</filter-mapping>




2. 缓存url pattern

修改web.xml，增加如下内容，确定对*.jsp页面进行缓存。

<filter>
<filter-name>cachefilter</filter-name>
<filter-class>com.opensymphony.oscache.web.filter.cachefilter</filter-class>
</filter>
<filter-mapping>
<filter-name>cachefilter</filter-name>
<!-对所有jsp页面内容进行缓存-->
<url-pattern>*.jsp</url-pattern>
</filter-mapping>




3. 自己设定缓存属性

在页面级缓存的情况下，能通过设置cachefilter的初始属性来决定缓存的一些特性：time属性设置缓存的时间段，默认为3600秒，能根据自己的需要只有的设置，而scope属性设置，默认为application，可选项包括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>
<!-对所有jsp页面内容进行缓存-->
<url-pattern>*.jsp</url-pattern>
</filter-mapping>