OSCache使用介紹

一.OSCache简介
    OSCache是OpenSymphony这个开源项目众多Projects中的一个。他是一个高效的J2EE缓存框架，能够很好的解决动态网站速度的问题。下面来
看下OSCache解决了动态网站的哪些令人郁闷的问题。
1.缓存动态内容：其实我们的动态网页上一般只有一部分是动态的（表头，表尾一般是不变的），如果我们缓存整个网页显然不成，因为有部分是
随着请求有可能变的。OSCache提供的方式是允许我们只缓存一部分网页。

2.缓存2进制内容：产生的图片和PDF文件在服务器加载的时候非常的耗时。OSCache解决这个问题是通过一个Servlet2.3的缓存过滤功能，然后能
够缓存任意的URI（比如一个完整的页面或者是一个产生的图片/PDF文件）

3.容错：有这种情况或许我们会遇到，就是当一个动态的网页出现错误。即便我们的页面有95%都加载完毕，但就是由于这个错误，整个页面就会
返回错误的提示或页面。OSCache允许我们提供出现错误时的缓存内容，如果出现就适时的提示出来了。

除了上面的这些Servlet的特征外，OSCache完全可以充当任何一个java程序的缓存方案。OSCache 的一般特征如下：
1.缓存任意对象：可以不受限制的缓存JSP的一部分或是Http请求，任何的Java对象都可以被缓存。

2.全面的API：通过API可以完完全全的控制OSCache的任何特性。

3.持久缓存：我们可以把认为重要的数据缓存到硬盘上。

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

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

二.OSCache运行环境
   如果用到OSCache Tag Library的话，需要Servlet2.3和JSP1.2的支持。如果是直接用OSCache API的话那么就不需要Servlet容器的支持。
目前可以正常运行的Web容器：
1.OrionServer(版本1.4.0和更高)
2.JRun(3.0或更好)
3.WebLogic(8.1或以上)
4.Websphere(5.0或以上)
5.Resin(1.2.3或以上)
6.TomCat(4.0或以上)
7.iPlanet(6.0或以上)
用到缓存过滤需要Servlet2.3支持.目前知道的可以个工作在OrionServer,WebLogic,Tomcat上.
OSCache需要Java的版本至少是java 1.4.

三.OSCache的安装
1.解压oscache-2.4.1-full后发现他下面有如下文件:

2.把oscache-2.4.1.jar放到/WEB-INF/lib下.
3.要确保commons-logging.jar也在环境变量中.一般情况下他也放在/WEB-INF/lib下.
4. 把/etc/oscache.properties放入/WEB-INF/classes下.如果用的Eclipse的话,建议新建一个 Source Folder比如叫Src_Config,然后就这个OSCache的属性文件放在其中.通过修改这个OSCache的配置文件可以改变文件缓存的磁盘路径,配置持久侦听等等.
5.把etc/META-INF/oscache.tld也放在/WEB-INF/classes下.
你的目录结构如下:
  

四.OSCache应用学习
1.JSP的应用
要是想应用OSCache的标签,我们必须先要引入进来.方式有两种.
其一.在web.xml中加入:
<taglib>
    <taglib-uri>oscache</taglib-uri>
    <taglib-location>/WEB-INF/classes/oscache.tld</taglib-location>
</taglib>
然后我们在JSp中就可以<%@ taglib uri="oscache" prefix="os"%>这样来引用了.
其二,直接引用.直接在JSp中加入OSCache的标签库引用
<%@ taglib uri="/WEB- INF/classes/oscache.tld" prefix="os"%>.如果要进入官方的标签库的话也行.& lt;%@ taglib uri="http://www.opensymphony.com/oscache" prefix="cache" %& gt;这样就不用再把oscache.tld放在/WEB-INF/classes下了.
目前OSCache有5个标签.他们是cache, usecached, flush, addgroup, addgroups.下面我们来分别介绍一下他们的属性和用法.
<cache></cache>
他是OSCache中最主要的标签了.括起来的内容将根据属性的设置来缓存起来.第一次执行的时候,OSCache会把cache标签中的JSp执行并且缓存起来,以后再执行的话,他会首先判断缓存的内容是否过期,如果过期那么会从新执行并缓存.否则就直接从缓存中读取.判定过期的条件如下:
i.缓存的内容超过了属性time所指定的时间.
ii.不符合cron设置的时间间隔.
iii.如果scope指定的范围刷新的话,则认为过期了.如Session过期.
属性如下:
key   : 缓存的Key,可以是任何的字符,用来寻找缓存的内容用的.可以理解成HashMap中的Key.不能把2个要缓存的东东定义成一个名字,那样后一个会覆盖前一个的内容.默认情况,如果不指定Key的话,OSCache也会自动生成一个Key,规则是请求的URI+当前页面的Query String.
scope  : 缓存的范围.有2个, application和session.默认值是application.
time   : 缓存内容的时间.以秒为单位,默认是3600秒.到了指定的时间,就会刷新缓存内容.如果指定一个负数的话,意味着永远不会过期.
duration : 也是用来指定缓存内容的时间,它和time属性只能是2选1,它的特点是可以用Simple Data Format 或者是ISO-8601进行日期格式化.
cron   : 用万年历的形式指定缓存内容何时过期的.它应用的Unix的万年历形式,如("0 * * * *")
refresh  : 是个Boolean值,如果是True的话,则不管前面提到的过期检查,都刷新.默认情况是false.
mode   : 设置这项为”silent”将防止把括起来的内容输出.这在你预加载缓存内容而不愿显示给用户看到时很有用.
groups  : 可以提供一个以逗号分割的组名称.如group="A, B".这将允许你以组的名义来操作他们,分组非常有用,比如你要缓存的内容正好需要另外一个应用程序的一部分或数据,当依赖的发生了改变,正好联动的可以使很多的组过期,进而使与组发生关联的缓存内容得到更新.
language : 设置编码方式.
refreshpolicyclass:指定自定义的类来处理缓存的内容什么时候过期.这个类需要从 refreshpolicyparam com.opensymphony.oscache.web.WebEntryRefreshPolicy继承.
refreshpolicyparam : 它和上面的是联合使用的.是给refreshpolicyclass传任意的参数的.指定这项的话,就必须有refreshpolicyclass,否则就不起作用.
属性就这么多了,下面举几个应用的例子:
<os:cache key="<%=myKey%>" time="1800" refresh="<%=needRefresh%>">
<!--这里是要缓存的内容-->
</os:cache>
这里将myKey标识的缓存内容保持30分钟,到期自动刷新.如果needRefresh为true也会刷新(适合于更新内容的即时刷新).

<os:cache key="<%=myKey%>" cron="0 2 * * *" refresh="<%=needRefresh%>">
    <!--这里是要缓存的内容-->
</os:cache>
将myKey标识的缓存内容在每天的凌晨2时自动刷新.如果needRefresh为true也会刷新(适合于更新内容的即时刷新).
举到了这个例子,我不得不把cron表达式多说几句.首先这五颗星的位置代表
分,小时,一个月中的天,月,一周中的天
分: 无疑问0~59.
小时 : 无疑问 0~23.
天(月) : 1~31
月 : 1~12,用英文全称也可以.如January, April
天(周): 0~6(0代表Sunday; 1代表Monday… 6代表Saturday)
举个例子,比如我们想让缓存的内容在4月的晚上11:45分过期.我们可以这样来写
"45 23 * April *".


<usecached />
需要放在cache标签中嵌套使用(一般配合try..catch使用)告诉他的上级标签是否应用缓存的译本. 则出现异常时将会替换包括上级标签在内的所有内容(提示:Missing cached content). use="true|false" : 是否应用的标记. 默认为True.一般省略.
应用例子:
<os:cache>
  ..内容..
         <% try {%>
         ......其它内容
         <%}catch (Exception e) {%>
              Inside catch: <os:usecached use="<%=isUsed%>"/> YES
         <% } %>
  </os:cache>
则出现异常时的页面输出有两种:
1>. isUsed=false
..内容..
......其它内容
Inside catch: YES
2>. isUsed=true
Missing cached content

<flush />
这个标签是用于在运行时状态下刷新缓存的.这个标签非常有用,因为它可以放在Web程序的管理部分使管理员可以决定何时刷新缓存.
属性如下:
scope : 刷新的范围.3个值, "application", "session" and null .null表示刷新所有.
Key  : 和scope联合使用,刷新指定范围的指定缓存.如果不指定scope则key无效.
group  : 和scope联合使用, 刷新指定范围的指定组中的缓存. 不指定scope无效.
Pattern :任何包含了pattren指定的字符串的缓存都被更新.它也是和scope连用.但是现在官方不赞成再用这个属性了.用group完全可以取代这个.便于管理.
language : 设置编码方式
举几个应用的例子:
    刷新整个application.
    <os:flush scope="application" />

    刷新session中的foobar这个缓存.
    <os:flush scope="session" key="foobar" />

    在application 中刷新所有currencyData 组中的缓存
    <os:flush scope="application" group="currencyData" />


<addgroup />
这个标签也是必须嵌套在cache标签中的.把缓存的东东放入到指定的组中.这样就可以以组来刷新指定的内容了.
属性只有group来指定名字的.例子如下:
    把test1加入到group1和group2中
    <os:cache key="test1">
         < os:addgroup group="group1" />
         ... some jsp content ...
         < os:addgroup group="group2" />
         ... some more jsp content ...
</ os:cache>


<addgroups /> (2.3及以后的版本中新加的)
     同上面的功能相同,只不过可以不用一个一个加group了.例子如下:
     < os:cache key="test1">
         ... some jsp content ...
         < os:addgroups groups="group1,group2" />
         ... some jsp content ...
     </ os:cache>

2.API的应用
     在实际应用中除了JSP标签库和CacheFilter(下面介绍)外,还可以使用OSCache提供的Java API .下面我来介绍一个实用的 Java类 ,使用GeneralCacheAdministrator来建立,刷新和管理缓存. GeneralCacheAdministrator 可以被实例化,里面有很多的实用方法.此外它还管理加载cache.properties并且根据这个属性文件创建一个缓存实例.因此你最好使用单例模式来创建GeneralCacheAdministrator实例.
     主要用到的GeneralCacheAdministrator的方法有
public Object getFromCache(String key) throws NeedsRefreshException; -- 从缓存中获取一个key标识的对象.
public Object getFromCache(String key, int refreshPeriod) throws NeedsRefreshException ; -- 从缓存中获取一个key标识的对象.  refreshPeriod刷新周期,标识此对象在缓存中保存的时间(单位:秒)

public void putInCache(String key, Object content)  -- 存储一个由Key标识的缓存对象.

public void putInCache(String key, Object content, String[] groups)   -- 存储一个由Key标识的属于groups中所有成员的缓存对象.

public void flushEntry(String key) -- 更新一个Key标识的缓存对象.
public void flushGroup(String group) --更新一组属于groupr标识的所有缓存对象.
public void flushAll() -- 更新所有缓存.

public void cancelUpdate(String key) --- 取消更新 只用于在处理捕获的NeedsRefreshException异常并尝试生成新缓存内容失效的时候.
public void removeEntry(String key) ---从缓中移除一个key标识的对象
public void clear()  --- 清除所有缓存
官方的使用例子:
///采取补救措施的典型方案
String myKey = "myKey";
String myValue;
int myRefreshPeriod = 1000; //刷新周期1000秒
try {
    //从Cache中获得 要做类型转换
    myValue = (String) admin.getFromCache(myKey, myRefreshPeriod);
} catch (NeedsRefreshException nre) {
    try {
        // Cache中没有则从库获得数据.
        myValue = "This is the content retrieved.";
        // 存放在Cache中 键值myKey
        admin.putInCache(myKey, myValue);
    } catch (Exception ex) {
// 尝试恢复Cache中的内容
        myValue = (String) nre.getCacheContent();
        // 如果Cache中的内容没有复原 则用这个终级方法
        admin.cancelUpdate(myKey);  //取消对myKey的更新 即类似数据回滚
    }
}
///不采取补救措施的典型方案
String myKey = "myKey";
String myValue;
int myRefreshPeriod = 1000;
try {
    //从Cache中获得 要做类型转换
    myValue = (String) admin.getFromCache(myKey, myRefreshPeriod);
} catch (NeedsRefreshException nre) {
    try {
        // Cache中没有则从库获得数据.
        myValue = "This is the content retrieved.";
        // 存放在Cache中 键值myKey
        admin.putInCache(myKey, myValue);
        updated = true;
    } finally {
        if (!updated) {
            // 如果Cache中的内容更新出现异常 则用这个终级方法
        admin.cancelUpdate(myKey);  //取消对myKey的更新 即类似数据回滚
        }
    }
}
注意:
如果一个NeedsRefreshException出现 必须调用admin.putInCache或甚至admin.cancelUpdate来避免死锁情况发生.

3.CacheFilter的应用
  OScache可以是你很轻易的缓存网站中全部页面,甚至是那些2进制文件.从2.4版本开始你可以在运行期设置和覆盖CacheFilter的初始化参数.注意,只有返回状态为200的页面才会缓存. (HttpServletResponse.SC_OK).
配置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>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>
    <url-pattern>*.jsp</url-pattern>
</filter-mapping>
这个例子将在session范围缓存所有JSp10分钟.默认情况scope为application,时间为1小时.
如果ICacheKeyProvider不设置的话,这个CacheFilter将使用(URI+QueryString)作为缓存Key.
你可以使用下列的初始化参数来设置CacheFilter:

Parameter: time
     设置缓存时间,默认是1个小时.可以设置为-1(不确定).这样他就不会过期了.除非你明确刷新它(前面说到的refresh =”true”).或者是更改这个刷新的策略.

Parameter: scope
   同cache的scope. 也是有application(default)和session

Parameter: cron (NEW! Since 2.3)
   同cache的scope.设置过期

Parameter: fragment (NEW! Since 2.2)
   作用不太清除,用默认即可.

Parameter: nocache (NEW! Since 2.2)
定义那些页面不需要缓存.”off”---缓存所有;”sessionIdInURL”---如果session中包括这URL的则不缓存这个页面

Parameter: lastModified (NEW! Since 2.2)
   定义是否把Header发送到Response中.
”off”----不发送,即便它设置在过滤链中.
“on”----如果在过滤链中则发送.
“inital”(default)----最后更改的信息将基于当前时间被设置

Parameter: max-age (NEW! Since 2.3.1)
设置在浏览器中缓存的最大时间.在设置的期间,不再向服务器请求,而是从自己的缓存中查找页面.默认是60秒.

Parameter: expires (NEW! Since 2.2)
定义过期header发送到Response中的时间.
“off”----不发送.
“on”(default)---如果在过滤链中则发送.并且time这个过期信息将基于时间参数和页面内容的创建时间初始化.

Parameter: ICacheKeyProvider (NEW! Since 2.2)
指定实现ICacheKeyProvider接口的类.


Parameter: ICacheGroupsProvider (NEW! Since 2.2)
指定实现ICacheGroupsProvider接口的类

Parameter: EntryRefreshPolicy (New! Since 2.3)
指定实现EntryRefreshPolicy接口的类.


Parameter: disableCacheOnMethods (New! Since 2.4)
指定请求方式不进行缓存.默认Null,对所有的请求方式都缓存.例如:
<init-param>
        <param-name>disableCacheOnMethods</param-name>
        <param-value>POST,PUT,DELETE</param-value>
    </init-param>

Parameter: oscache-properties-file (New! Since 2.4)
通过指定OSCache的属性文件,开发者就能运行多个CacheFilter



4.OSCache的属性文件.(oscache.properties)
cache.memory
值为true或false.默认为true.如果设置为false那么缓存到数据库或硬盘中.似乎有点傻,所以我们一般不改此项.

cache.capacity
缓存元素的个数.默认是没有限制的.

cache.algorithm
缓存的算法.注意要是指定算法的话,必须把上面的缓存个数指定.这里支持三种算法.
com.opensymphony.oscache.base.algorithm.LRUCache – 最后最近使用
com.opensymphony.oscache.base.algorithm.FIFOCache – 先进先出
com.opensymphony.oscache.base.algorithm.UnlimitedCache – 无限缓存

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

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

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

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


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

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的生命周期中记录count of 所有entry的事件。 com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl －记录 count of cache map events（cache hits，misses and state hits）.

cache.key
设置ServletCacheAdministrator使用的Key.在代码中如果需要用到的话,可以通过com.opensymphony.oscache.web.ServletCacheAdministrator.DEFAULT_CACHE_KEY得到.

cache.use.host.domain.in.key
如果你的服务器是被配置到多台主机上的话,你或许想加上一个主机的名字在它生成的缓存Key上.true的话会加上.默认值是false.

附加的属性: cache.cluster.multicast.ip,  cache.cluster.properties



5.小结:
OSCache的使用主要有4种：
POJO 缓存
HTTP Response 缓存
JSP Tag Library 缓存
O/R Data Access 缓存

1)、POJO 缓存
这种方式的缓存直接调用OSCache的API进行，主要用于处理页面内容会根据参数动态改变，可以将参数设置为key值来保存数据：
首先，声明成员变量：
// OSCache Adminitrator instance
private static GeneralCacheAdministrator cacheAdmin = null;
其次，进行初始化：
public RingArtistAction() {
  cacheAdmin = new GeneralCacheAdministrator();
}
将POJO进行缓存：
  // Cache data key and refresh period
  String key = sex + ":" + place;
  int refreshPeriod = Constants.getIntegerValue(Constants.OSCACHE_REFRESH_PERIOD).intValue();
  try {
      // Get from the cache
   artists = (Map) cacheAdmin.getFromCache(key, refreshPeriod);
  } catch (NeedsRefreshException nre) {
      try {
          // Get the value (probably from the database)
    int count = getArtistCount(sex, place, errors);
    artists = getArtistData(sex, place, count, errors);
          // Store in the cache
    cacheAdmin.putInCache(key, artists);
      } catch (Exception ex) {
          // We have the current content if we want fail-over.
    artists = (Map) nre.getCacheContent();
          // It is essential that cancelUpdate is called if the
          // cached content is not rebuilt
    cacheAdmin.cancelUpdate(key);
    ex.printStackTrace();
      }
  }
 
2)、HTTP Response 缓存
这种方式的缓存用来处理整个页面的内容固定，不会根据参数动态改变：
首先在web.xml中配置CacheFilter：
<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>86400</param-value>
  </init-param>
  <init-param>
   <param-name>scope</param-name>
   <param-value>application</param-value>
  </init-param>
</filter>
将所有需要缓存的页面加入filter-mapping：
<filter-mapping>
  <filter-name>Set Character Encoding</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>
注意，只有返回状态为200（HttpServletResponse.SC_OK）的内容才会被缓存

3)、JSP Tag 缓存
JSP Tag缓存主要用于缓存JSP页面的局部内容：
  <cache:cache key="especialcategory" cron="* 5 * * *">
  <jsp:include page="/ringcategory.do" flush="true" >
    <jsp:param name="ringType" value="1"/>
  </jsp:include>
  </cache:cache>

4)、O/R Data Access 缓存
请阅读参考资料的内容获取详情。





轉自：http://club.163.com/viewArticleByWWW.m?boardId=java&articleId=java_119e671602b16a2_1&boardOffset=0