OSCache
前阵子对公司网站进行了性能优化，其中，有一项就是使用OSCache添加页面的缓存，开始还不以为然，做完缓存后，发现服务器的负载大大减小了，看来还真不能小瞧OSCache。 OSCache 主要用于页面缓存，当然它也可用于数据层缓存，但数据层缓存一般使用ehcache比较成熟。OSCache对于更新较慢的页面（比如一天或半天更新一次）缓存效果比较好，能大幅降低数据库和服务器的压力，而且OSCache简单易用，是一个非常不错的缓存框架。 OSCache的配置和使用 一、oscache 环境搭建 1， 从 https://oscache.dev.java.net/files/documents/629/61427/oscache-2.4.1-full.zip 下载 oscache-2.4.1-full版本，并从压缩包中分别拷贝oscache-2.4.1.jar、oscache.properties、 oscache.tld放入本地项目的应用目录，如下： $WEB-APP"WEB-INF"lib"oscache.jar $WEB-APP"WEB-INF"classes"oscache.properties $WEB-APP"WEB-INF"classes"oscache.tld 2， 在web.xml 中加入如下配置 oscache /WEB-INF/classes/oscache.tld 3， 如果需要日志输出，可在log4j.properties文件中加入如下配置 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} 二、oscache.properties 主要配置 1,cache.memory = true 设置是否使用内存缓存 可设置为true 或者 false ，默认为true 2,cache.capacity =10000 设置缓存对象的最大数量值 默认是不限制，cache不会移走任何缓存内容，负数被当作不限制 3,cache.unlimited.disk 指定硬盘缓存是否要作限制，默认值为false false的状况下，硬盘缓存容量将和cache.capacity的值相同 4，cache.path 指定硬盘缓存的路径，目录如果不存在将被建立，同时注意oscache应该要有权限写文件系统。 设置如：cache.path=d:""myapp""cache 5，cache.persistence.overflow.only 指定是否只有在内存不足的情况下才使用硬盘缓存。默认值false，推荐使用true如果内存cache被允许的话 三、标签参数介绍 使用了oscache:cache 的属性： key 缓冲的key,可以是任何的字符串，也可以动态生成。在一个范围内必须唯一。默认使用请求的URI和请求的字符串(问号后面的部分) scope 范围，有application和session, 默认为 application time 缓冲内容的时间(秒)，默认为1小时，3600秒，如果为-1则内容永远不过期 refresh 强制刷新缓存，false 或者true，可以使用此属性受动刷新需立即更新的数据 groups 设置分组，可以同组的缓冲数据进行控制 language 语言，默认为当前页面的语言 还有许多其他的属性，在这里不一一列举 四、oscache 基本用法 1，设置缓存
被缓存的列表 其中，cacheKey和time可以自己动态构件，scope（缓存范围） 可以是ession、application 注意：cacheKey或者time如果是jsp表达式时，如：key=”
”而不是：key=”string
”，写法要注意，否则页面会报错 2，刷新缓存
3，分组缓存 这里面的内容被缓存到键值为cacheKey_1，组名为a和b的缓存中，正常情况下，每隔5秒钟刷新一 次，但受上面标签“”的影响，它将随每次页面的刷新而刷新 这里面的内容被缓存到键值为cacheKey_2，组名为a的缓存中，它将每隔5秒中刷新一次 这里面的内容被缓存到cacheKey_3，组a，b中，组是通过标签而添加的，它也会受本页开头标签“”的影响而随页面刷新而刷新 这里面的内容被缓存到cacheKey_4，组a，b中，组是通过标签而添加的，它也会受本页开头标签“”的影响而随页面刷新而刷新 五、参考资料 1，oscache-2.4.1-full 中的demo，下在地址： https://oscache.dev.java.net/files/documents/629/61427/oscache-2.4.1-full.zip 2，oscache API：http://www.opensymphony.com/oscache/api/
=========================================================================
下面简单介绍一下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>
2.为了便于调试日志输出，须加入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
3.hibernate-session配置
<bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="mappingResources">
<list>
<value>com/ouou/album/model/Albums.hbm.xml</value>
</list>
</property>
<property name="hibernateProperties">
<props>
<prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
<prop key="hibernate.current_session_context_class">thread</prop>
<prop key="hibernate.cglib.use_reflection_optimizer">false</prop>
<!--<prop key="hibernate.query.substitutions">true 'Y', false 'N'</prop>-->
<prop key="hibernate.query.substitutions">true 1, false 0</prop>
<prop key="hibernate.cache.use_query_cache">true</prop>
<prop key="hibernate.cache.use_second_level_cache">true</prop> <prop key="hibernate.cache.provider_class">com.opensymphony.oscache.hibernate.OSCacheProvider
</prop>
<prop key="hibernate.show_sql">true</prop>
<!--<prop key="connection.provider_class">org.hibernate.connection.C3P0ConnectionProvider</prop> -->
<prop key="hibernate.jdbc.batch_size">25</prop>
</props>
</property>
</bean>
4.oscache.properties 文件配置向导
cache.memory
值为true 或 false ，默认为在内存中作缓存，
如设置为false，那cache只能缓存到数据库或硬盘中，那cache还有什么意义：）
cache.persistence.class
持久化缓存类，如此类打开，则必须设置cache.path信息
cache.capacity
缓存元素个数
cache.cluster 相关
为集群设置信息。
如
cache.cluster.multicast.ip为广播IP地址
cache.cluster.properties为集群属性
配置例子:
cache.memory=true
cache.key=__oscache_cache
cache.path=/data/oscache
cache.capacity=100000
cache.unlimited.disk=true
5.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>
6. 缓存过滤器 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）作缓存处理
7.关于oscache的几个基础方法:
public abstract class BaseManager<T extends BaseObject> implements Manager<T> ...{
private static Log logger = LogFactory.getLog(BaseManager.class);
private Cache oscache;
public Cache getOscache() ...{
return oscache;
}
public void setOscache(Cache oscache) ...{
this.oscache = oscache;
}
protected final String createCachekey(Object keyParams[]) ...{
if (keyParams == null) ...{
return "";
}
StringBuilder sb = new StringBuilder();
for (int i = 0; i < (keyParams.length - 1); i++) ...{
sb.append(keyParams[i].toString()).append("':'");
}
return sb.append(keyParams[keyParams.length - 1]).toString();
}
public Object getCacheValue(String key) ...{
return getCacheValue(key, null);
}
public Object getCacheValue(String key, Object obj) ...{
Object new_obj = null;
try ...{
new_obj = oscache.getFromCache(key);
} catch (NeedsRefreshException nre) ...{
oscache.cancelUpdate(key);
if (logger.isWarnEnabled()) ...{
logger.warn("Failed to get from Cache");
}
}
return (new_obj != null) ? new_obj : obj;
}
public void setCache(String key, Object serial) ...{
setCache(key, serial, default_cache_time_second);
}
public void setCache(String key, Object serial, int cache_time) ...{
if (oscache != null) ...{
oscache.putInCache(key, serial, new ExpiresRefreshPolicy(cache_time));
}
}
public void delCache(String key) ...{
if (oscache != null) ...{
oscache.removeEntry(key);
}
}
public void flushCache(String key) ...{
if (oscache != null) ...{
oscache.flushEntry(key);
}
}
}