oscache缓存使用总结
在目前流行的三种开源的缓存工具中，OSCache的配置和使用应给是最简单的了，它主要是针对页面级的配置，EHCache主要针对对象级的缓存，MemCached应该是比较完整的了。
下面我来总结一下OSCache，下面是网上找的两篇文章介绍：
从 https://oscache.dev.java.net/files/documents/629/61427/oscache-2.4.1-full.zip 下载
下面转自 http://www.iteye.com/topic/172186
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）作缓存处理
下面转自http://www.blogjava.net/ruchal/archive/2009/05/31/277420.html?opt=admin
三、标签参数介绍
使用了oscache:cache 的属性：
key 缓冲的key,可以是任何的字符串，也可以动态生成。在一个范围内必须唯一。默认使用请求的URI和请求的字符串(问号后面的部分)
scope 范围，有application和session, 默认为 application
time 缓冲内容的时间(秒)，默认为1小时，3600秒，如果为-1则内容永远不过期
refresh 强制刷新缓存，false 或者true，可以使用此属性受动刷新需立即更新的数据
groups 设置分组，可以同组的缓冲数据进行控制
language 语言，默认为当前页面的语言
还有许多其他的属性，在这里不一一列举
四、oscache 基本用法
1，设置缓存
<%@ taglib uri="/WEB-INF/tlds/oscache.tld" prefix="oscache" %>
<oscache:cache key=”cacheKey” time=”300” scope=”application”>被缓存的列表 </oscache:cache> 其中，cacheKey和time可以自己动态构件，scope（缓存范围） 可以是ession、application
注意：cacheKey或者time如果是jsp表达式时，如：key=”<%=”string”+variable%>”而不是：key=”string<%=variable%>”，写法要注意，否则页面会报错
2，刷新缓存
<%@ taglib uri="/WEB-INF/tlds/oscache.tld" prefix="oscache" %>
<oscache:flush key=”cacheKey” scope=”application” />
3，分组缓存
<cache:flush group='b' scope='application'/>
<cache:cachekey='cacheKey_1' groups='a,b' duration='5s'>
这里面的内容被缓存到键值为cacheKey_1，组名为a和b的缓存中，正常情况下，每隔5秒钟刷新一 次，但受上面标签“<cache:flush group='b' scope='application'/>”的影响，它将随每次页面的刷新而刷新
</cache:cache>
<cache:cachekey='cacheKey_2' groups='a' duration='5s'>
这里面的内容被缓存到键值为cacheKey_2，组名为a的缓存中，它将每隔5秒中刷新一次
</cache:cache>
<cache:cachekey='cacheKey_3' duration='20s'>
这里面的内容被缓存到cacheKey_3，组a，b中，组是通过标签<cache: addgroup>而添加的，它也会受本页开头标签“<cache:flush group='b' scope='application'/>”的影响而随页面刷新而刷新
<cache:addgroup group='a'/>
<cache:addgroup group='b'/>
</cache:cache>
<cache:cachekey='cacheKey_4' duration='20s'>
这里面的内容被缓存到cacheKey_4，组a，b中，组是通过标签<cache: addgroups>而添加的，它也会受本页开头标签“<cache:flush group='b' scope='application'/>”的影响而随页面刷新而刷新
<cache:addgroups groups='a,b'/>
</cache:cache>
OSCache是当前运用最广的缓存方案。其主被用的最广泛功能是缓存页面，这里主要是用其缓存文件对象。
运用OScache的步骤：
1.取得oscache.jar 文件放到 /WEB-INF/lib 或相应类库目录 目录中。
2.oscache.jar依赖commons-collections.jar包。如果你的jdk版本为1.3,
建议在lib中加入Apache Common Lib 的commons-collections.jar包。
如jdk是1.4以上则不必要。
3.src根目录或发布环境的/WEB-INF/classes 目录下放入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为集群属性
cache.path
硬盘持久化时存放文件的目录。如果目录不存在OSCache会自动创建。
Windows系统：c:\\myapp\\cache。其它：/opt/myapp/cache
cache.persistence.overflow.only*
是否只有当指定的内存缓存已经满时才进行持久化。推荐使用true，flase是为向后兼容。
cache.unlimited.disk
硬盘缓存是否有限制。缺省为cache.capacity指定的值
运用：
com.opensymphony.oscache.general.GeneralCacheAdministrator
GeneralCacheAdministrator主要对实现持久化对象的保存以及取出的相关的操作。
Object getFromCache（String key） //根据key获取缓存对象
Object getFromCache（String key , int refreshInterval）//refreshInterval时间内，根据key获取缓存对象
void putInCache(String key ,Object obj) //保存被缓存对象
void flushAll() //删除所有被缓存的对象
void flushAll(Date date) //在指定的时间去删除所有被缓存的对象
void cancelUpdate(String key) //取消未确定的更新
Java代码
2
3 import java.io.BufferedInputStream;
4 import java.io.BufferedOutputStream;
5 import java.io.File;
6 import java.io.FileInputStream;
7 import java.io.IOException;
8 import java.text.SimpleDateFormat;
9 import java.util.Date;
10
11 import javax.servlet.ServletException;
12 import javax.servlet.http.HttpServlet;
13 import javax.servlet.http.HttpServletRequest;
14 import javax.servlet.http.HttpServletResponse;
15 import javax.servlet.http.HttpSession;
16
17 import com.opensymphony.oscache.base.NeedsRefreshException;
18 import com.opensymphony.oscache.general.GeneralCacheAdministrator;
19
20
21 public class DisplayChart extends HttpServlet {
22
23 /**
24 * Default constructor.
25 */
26 public DisplayChart() {
27 super ();
28 }
29
30 /**
31 * Init method.
32 *
33 * @throws ServletException never.
34 */
35 public void init() throws ServletException {
36 return ;
37 }
38
39
40 public static GeneralCacheAdministrator cacheAdmin = new GeneralCacheAdministrator();
41 public void service(HttpServletRequest request,
42 HttpServletResponse response)
43 throws ServletException, IOException {
44
45 String path = getServletContext().getRealPath( " / " );
46 File file = null ;
47 SimpleDateFormat sdf = new SimpleDateFormat( " hh-mm-ss " );
48 try {
49 file = (File)cacheAdmin.getFromCache(sdf.format( new Date()));
50 System.out.println( " 来自缓存! " + sdf.format( new Date()));
51 } catch (NeedsRefreshException e) {
52 file = new File(path + " xmls\\Pipe11.xml " );
53 cacheAdmin.putInCache(sdf.format( new Date()), file);
54 System.out.println( " --缓存没有! " + sdf.format( new Date()));
55 }
56 sendResponse(file,response);
57 return ;
58 }
59 /**
60 * 把文件用响应流写出
61 * @param file
62 * @param response
63 * @throws IOException
64 */
65 public void sendResponse(File file,HttpServletResponse response) throws IOException{
66 BufferedInputStream bis = new BufferedInputStream( new FileInputStream(file));
67 BufferedOutputStream bos = new BufferedOutputStream(response.getOutputStream());
68 byte [] input = new byte [ 1024 ];
69 boolean eof = false ;
70 while ( ! eof) {
71 int length = bis.read(input);
72 if (length == - 1 ) {
73 eof = true ;
74 }
75 else {
76 bos.write(input, 0 , length);
77 }
78 }
79 bos.flush();
80 bis.close();
81 bos.close();
82 }
83
84 }