OSCache

1、OSCache是什么?   

OSCache标记库由OpenSymphony设计，它是一种开创性的缓存方案，它提供了在现有JSP页面之内实现内存缓存的功能。OSCache是个一个被广泛采用的高性能的J2EE缓存框架，OSCache还能应用于任何Java应用程序的普通的缓存解决方案。

2、OSCache的特点  

     (1) 缓存任何对象：你可以不受限制的缓存部分jsp页面或HTTP请求，任何java对象都可以缓存。  

(2) 拥有全面的API：OSCache API允许你通过编程的方式来控制所有的OSCache特性。

(3) 永久缓存：缓存能被配置写入硬盘，因此允许在应用服务器的多次生命周期间缓存创建开销昂贵的数据。  

 (4) 支持集群：集群缓存数据能被单个的进行参数配置，不需要修改代码。  

 (5) 缓存过期：你可以有最大限度的控制缓存对象的过期，包括可插入式的刷新策略（如果默认性能不能满足需要时）。

3、OSCache缓存的三种模式

（1）缓存于内存中

（2）缓存于硬盘中

（3）一种较灵活的方式，先缓存于内存中，如果满了则转至硬盘

4、OSCache的安装与配置   

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

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

 

1.安装过程

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

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

解压压缩文件得到文件夹oscache-2.4.1-full

 

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

jar文件名可能含有版本号和该版本的发布日期信息等，如oscache-2.4.1.jar

 

将lib下的commons-logging.jar和jgroups-all.jar都放入到/WEB-INF/lib中

 

从src或etc目录取得oscache.properties 文件，放入src根目录或发布环境的/WEB-INF/classes 目录

oscache.properties文件配置

1、cache.memory
是否使用内存缓存；值为：true或false。默认为true；如设置为false，那cache只能缓存到数据库或硬盘中。

2、cache.capacity
缓存的最大数量。默认是不限制，cache不会移走任何缓存内容。负数被视不限制。

3、cache.algorithm
运算规则。为了使用规则，cache的size必须是指定的。

如果cache的size不指定的话, 将不会限制缓存对象的大小。如果指定了cache的size，但不指定algorithm，那它会默认使用:com.opensymphony.oscache.base.algorithm.LRUCache

有下面三种规则：
com.opensymphony.oscache.base.algorithm.LRUCache: last in first out(最后插入的最先调用)。默认选项。
com.opensymphony.oscache.base.algorithm.FIFOCache: first int first out(最先插入的最先调用)。
com.opensymphony.oscache.base.algorithm.UnlimitedCache: cache中的内容将永远不会被丢弃。如果cache.capacity不指定值的话，它将被设为默认选项。

4、cache.blocking
是否同步。true或者false。一般设为true，避免读取脏数据。

5、cache.unlimited.disk
指定硬盘缓存是否要作限制。默认值为false。false的状况下，disk cache capacity和cache.capacity的值相同。

6、cache.persistence.class
指定类是被持久化缓存的类。class必须实现PersistenceListener接口。
作为硬盘持久，可以实现com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener接口。
它把class的toString()输出的hash值作为文件的名称。如果你要想文件名易读些（自己设定），DiskPersistenceListener的父类也能使用，但其可能有非法字符或者过长的名字。
注意：HashDiskPersistenceListener和DiskPersistenceListener需要设定硬盘路径：cache.path

7、cache.path
指定硬盘缓存的路径。目录如果不存在将被建立。同时注意oscache应该要有权限写文件系统。
例:
cache.path=c:\\myapp\\cache
cache.path=/opt/myapp/cache

8、cache.persistence.overflow.only (NEW! Since 2.1)
指定是否只有在内存不足的情况下才使用硬盘缓存。
默认值false。但推荐是true如果内存cache被允许的话。这个属性彻底的改变了cache的行为，使得persisted cache和memory是完全不同。

9、cache.event.listeners
class名列表(用逗号隔开)。每个class必须实现以下接口中的一个或者几个。
CacheEntryEventListener：接收cache add/update/flush and remove事件
CacheMapAccessEventListener ：接收cache访问事件。这个可以让你跟踪cache怎么工作。
默认是不配置任何class的。当然你可以使用一下class：
com.opensymphony.oscache.plugins.clustersupport.BroadcastingCacheEventListener: 分布式的监听器。可以广播到局域网内的其他cache实例。
com.opensymphony.oscache.extra.CacheEntryEventListenerImpl:一个简单的监听器。在cache的生命周期中记录所有entry的事件。
com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl: 记录count of cache map events（cache hits，misses and state hits）.

10、cache.key
在application和session的作用域时，用于标识cache对象的，用于ServletCacheAdministrator;此属性不是指定为"__oscache_cache"格式时为默认值, 如果代码中需要用到默认值时可以通使用com.opensymphony.oscache.base.Const.DEFAULT_CACHE_KEY来取得;

11、cache.use.host.domain.in.key
当配置多个服务器时,想通过服备器名称自动生成cache key时,可将此属性设为true. 默认值为false;

12、Additional Properties
在以上基础选项之上可以加入一些额外的属性到此文件中.
例: JavaGroupsBroadcastingListener便是额外的.

13、cache.cluster.multicast.ip
用于缓存集群. 默认为231.12.21.132

14、cache.cluster.properties
指集群中的额外配置项.

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

 

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

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

$WEB_APPLICATION\WEB-INF\lib\commons-logging.jar

$WEB_APPLICATION\WEB-INF\lib\jgroups-all.jar

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

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

为了便于调试日志输出，须加入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 

 

将下列代码加入web.xml文件中 
<taglib> 
<taglib-uri>oscache</taglib-uri> 
<taglib-location>/WEB-INF/classes/oscache.tld</taglib-location> 
</taglib> 

 

cache1.jsp 内容如下 
<%@ page language="java" pageEncoding="UTF-8"%>
<%@ 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 执行手动刷新页面如下 

<%@ page language="java" pageEncoding="UTF-8"%>
<%@ 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）作缓存处理 

 

web.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"

xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"

version="3.0">

 <display-name>oscache_demo</display-name>

 <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>5</param-value>

  </init-param>

 </filter>

 <filter-mapping>

  <filter-name>CacheFilter</filter-name>

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

 </filter-mapping>

 <welcome-file-list>

  <welcome-file>*.jsp</welcome-file>

 </welcome-file-list>

 <jsp-config>

  <taglib>

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

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

  </taglib>

 </jsp-config>

 

</web-app>

 

 

7、主要的标签以及标签属性

Cache标签——缓存代码段主要使用到的标签：

属性说明：

key
 标识缓存内容的关键词。在指定的作用范围内必须是唯一的。默认的key是被访问页面的URI和后面的请求字符串。可以在同一个页面中使用很多cache标签而不指定他的key属性，这种情况下系统使用该页面的URI和后面的请求字符串，另外再自动给这些key增加一个索引值来区分这些缓存内容。但是不推荐采用这样的方式。
 
scope
 缓存发生作用的范围，可以是application或者session。默认为application。
 
time
 缓存内容的时间段，单位是秒，默认是3600秒，也就是一个小时，如果设定一个负值，那么这部分被缓存的内容将永远不过期。
 
duration
 指定缓存内容失效的时间，是相对time的另一个选择，可以使用简单日期格式或者符合USO-8601的日期格式。如：duration='PT5M' duration='5s'等。

 

注意：time与duration的区别是time的单位是秒所以设置的时候是只要输入一个阿拉伯数字，而duration的话可以使用简单日期格式或者符合USO-8601的日期格式。如：duration='PT5M' duration='5s'等

cron
    指定缓存内容失效表达式。
        通过Cron表达式我们可以很灵活的设置缓存的失效时间，Cron表达式包括5个字段分别为Minute,Hour, DOM(Day Of Month), Month,DOW(Day Of Week)。他们顺序地对应了5个位置。当某个位置上的值为*时,表示该位置上的任意时间。另外还提供了指定时间的操作符号"-"，","，"/"，他们分别表示一段时间范围，具体的时间，以及递增的时间段。下面是几个例子说明一下Cron表达式的基本应用： 
        （1） "10/20 * * * *" :因是第一个位置，并且是一个递增的表达式,所以表达式指定的是每个小时的第10分钟，第30分钟，第50分钟缓存内容失效。
        （2） "* 8-18/4 * * *" :指定每天早上8点到晚上6点之间，每4个小时缓存内容失效。  等同于"*8,12,16 * * *"。
        （3） "* * * * 1-5":表示每个星期一到星期五内容失效。
 
refresh
 false 或者true。如果refresh属性设置为true，不管其他的属性是否符合条件，这部分被缓存的内容都将被更新，这给编程者一种选择，决定什么时候必须刷新。
 
mode
 如果不希望被缓存的内容增加到给用户的响应中，可以设置mode属性为"silent"。此时被缓存的部分不在页面上显示，而其它任意的mode属性值都会将缓存的部分显示到页面上。
 
groups
 指定当前cache标签所属的组，可使用“,”分割组名。这样就可以对缓存项进行分组了。如果缓存项依赖于应用的其它部分或其它数据，分组就有了用武之地——当这种依赖改变时（刷新相关的组），这个组的所有缓存项都将过期。
 
language
 使用ISO-639定义的语言码来发布不同的缓存内容（under an otherwise identical key）。要在一个多语言网站上同一段JSP代码不同用户的参数提供不同的语言时，这个属性会很有用。
 
refreshpolicyclass

指定自定义的刷新策略类的全限定类名。这个类继承自

com.opensymphony.oscache.web.WebEntryRefreshPolicy
 
refreshpolicyparam
 指定任意需要传给refreshpolicyclass的参数。如果没有指定refreshpolicyclass，则这个值不起作用。

 

 

usecached标签
        <usecached />:必须嵌套在<cache>标签中。
属性说明：

use
 告诉所在的<cache>标签是否使用已经缓存的内容（缺省为true，使用缓存的内容）。可以使用这个标签来控制缓存。比如使用<frush>标签刷新某个key的缓存，但可以在必要的地方即使这样的强制刷新也仍然使用缓存内容而不刷新。

 

flush标签
        这个标签用于在运行时刷新缓存。只有运行flush标签后再次访问相关缓存项时才执行刷新。
属性说明：

scope[all]
 指定要刷新的范围。可选的值是"application","session" 和 nul。null（到底是null量还是all呀）值指定刷新所有的缓存（是指使用cache标签的缓存）。
 
key
 当指定了scope和key值时，刷新唯一的缓存项。当这个缓存项下次被访问时将被刷新。只指定一个key值而没有指定scope不起作用。
 
group
 指定一个组时将刷新所有这个组中的缓存项。只指定一个group值而没有指定scope不起作用。
 
pattern
 任意包含pattern属性指定的值的缓存项都将被刷新。只指定一个pattern值而没有指定scope不起作用。 (注意：OSCache项目组已经不赞成使用pattern这个属性赖刷新缓存，二是鼓励使用具有更好的灵活性和性能的group属性来代替)
 
language
 使用ISO-639定义的语言码来发布不同的缓存内容（under an otherwise identical key）。要在一个多语言网站上同一段JSP代码不同用户的参数提供不同的语言时，这个属性会很有用。

addgroup标签
        <addgroup />:必须嵌套在<cache>标签中。
属性说明： 

group
定义cache标签的group名称

示例代码如下：
<oscache:cache key="test1">
    <oscache:addgroupgroup="group1" />
        ... some jsp content ...
    <oscache:addgroupgroup="group2" />
    ... some more jsp content ...
</oscache:cache>