OSCACHE使用

        本文转载于：

        http://blog.csdn.net/liuzhenwen/article/details/3080274

        如需转载，需注明转载地址，谢谢！

        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_APPLICATIONWEB-INFliboscache.jar
        $WEB_APPLICATIONWEB-INFclassesoscache.properties
        $WEB_APPLICATIONWEB-INFclassesoscache.tld

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

oscache
/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

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" %>




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



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



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


手动刷新

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

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




缓存已刷新...




返回

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

...

        4.  缓存过滤器  CacheFilter 

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

CacheFilter
com.opensymphony.oscache.web.filter.CacheFilter

time
60


scope
session



CacheFilter
*.jsp

        上面定义将缓存所有.jsp页面，缓存刷新时间为60秒，缓存作用域为Session

        注意，CacheFilter只捕获Http头为200的页面请求，即只对无错误请求作缓存，
而不对其他请求（如500,404,400）作缓存处理

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

        OSCache的基本使用
        OSCache 是OpenSymphony组织提供的一种WEB应用层的缓存组件。OSCache提供了内存和磁盘的两种缓存存储机制，并且提供了集群机制。与JSP2.0自带的Cache标签相比，Oscache显得功能更加灵活，强大，比如硬盘缓存，以及在下面将会提到的cron表达式定制复杂而灵活的缓存失效时间等。
首先，在TOMCAT发布一个名为test的应用，然后在http://www.opensymphony.com/oscache/download.action下载最新版本的OSCache。我下载的是oscache-2.1-full.zip。解压此文件把oscache-2.1.jar以及lib/core目录下的commons-collections-3.1.jar和commons-logging.jar文件拷贝到test应用的WEB-INF/LIB目录下。把etc/scache.properties和oscache.tld拷贝到test应用的WEB-INF/CLASSES目录下。
修改web.xml文件，加入

oscache
/WEB-INF/classes/oscache.tld
 

        现在我们就可以使用OSCache了。
        一、几个在JSP中的基本用法

<%
Syste.out.println("Test OSCache!");
//需要缓存的JSP代码，默认缓存时间是3600
%>


<%
//需要缓存的JSP代码，此处指定缓存作用的范围是session ，并且key值是first
%>


<%
//需要缓存的JSP代码，此处指定缓存的时间是600秒 ，
//且通过一个参数动态判断是否需要缓存,如此处time为－1则被缓存的内容永不过期
%>


<%
//通过Cron表达式指定每天的早上2点钟缓存的内容失效
%>

 //刷新application中的缓存
 //刷新session中的缓存

        二、Cron表达式基本语法
        通过Cron表达式我们可以很灵活的设置缓存的失效时间，Cron表达式包括5个字段分别为Minute,Hour, DOM(Day Of Month), Month,DOW(Day Of Week)。他们顺序地对应了5个位置。当某个位置上的值为*时,表示该位置上的任意时间。另外还提供了指定时间的操作符号"-"，","，"/"，他们分别表示一段时间范围，具体的时间，以及递增的时间段。下面是几个例子说明一下Cron表达式的基本应用，有兴趣的也可以查看下OScache的doc文档。
        "10/20 * * * *" :因是第一个位置，并且是一个递增的表达式,所以表达式指定的是每个小时的第10分钟，第30分钟，第50分钟缓存内容失效。
        "* 8-18/4 * * *" :指定每天早上8点到晚上6点之间，每4个小时缓存内容失效。 等同于"* 8,12,16 * * *"
"* * * * 1-5":表示每个星期一到星期五内容失效。

         三、CashFilter的使用
         CashFilter是通过过滤器来缓存一个完整的JSP页面或者我们生成的二进制文件，包括生成的图片，EXCEL，WORLD，PDF等。

CacheFilter
com.opensymphony.oscache.web.filter.CacheFilter


CacheFilter

/needCache.jsp

        注意：只有返回http头信息中代码为200（即成功状态）的才能被缓存。

        四、oscache.properties文件的配置
        cache.memory 指定是否使用内存缓存(默认为使用)
        cache.persistence.class 当使用磁盘方式或数据库等其他方式缓存时指定
        cache.path 当使用磁盘缓存时，须指定
        cache.capacity 缓存大小
        cache.unlimited.disk 对于磁盘缓存是否限制大小