摘要
本文档介绍了如何在
Portlet
应用中使用
OSCache
进行页面内容缓存和对象缓存,分析了
OSCache
的实现原理,并提出了一个用来缓存对象和页面的简单易用的方案。本文档不涉及
OSCache
的安装与配置的内容,相关内容请参考
OSCache
的
在线文档
。
OSCache标记库由OpenSymphony设计,它是一种开创性的缓存方案,它提供了在现有JSP页面之内实现内存缓存的功能。OSCache是个一个被广泛采用的高性能的J2EE缓存框架,OSCache还能应用于任何Java应用程序的普通的缓存解决方案。
OSCache有以下特点:
l
缓存任何对象:你可以不受限制的缓存部分jsp页面或HTTP请求,任何java对象都可以缓存。
l
拥有全面的API:OSCache API允许你通过编程的方式来控制所有的OSCache特性。
l
永久缓存:缓存能被配置写入硬盘,因此允许在应用服务器的多次生命周期间缓存创建开销昂贵的数据。
l
支持集群:集群缓存数据能被单个的进行参数配置,不需要修改代码。
l
缓存过期:你可以有最大限度的控制缓存对象的过期,包括可插入式的刷新策略(如果默认性能不能满足需要时)。
图
3-1 OSCache
架构概览
Cache Factory
:该实体负责获得
Cache Proxy
,兼有一些对
Cache Proxy
的管理功能。对应到现在的
OSCache
实现中的类是:
GeneralCacheAdministrator
和
ServletCacheAdministrator
。
Cache Proxy
:该实体是
Cache Map
的代理,它主要负责从
Cache Map
中取得
/
存储指定的缓存对象,如果缓存对象过期,那么就将缓存刷新,并向指定的监听者发送存
/
取事件。对应到现在的
OSCache
实现中的类是:
Cache
和
ServletCache
。
Cache Map
:该实体存储了所有的缓存实体,是一个
OSCache
专有的
Map
实现,它能根据指定的算法清除缓存,以及将缓存持久化到磁盘中。对应到现在的
OSCache
实现中的类是:
FIFOCache
,
LRUCache
和
UnlimitedCache
。
Listeners
:
OSCache
存
/
取事件的监听者实体。对应到现在的
OSCache
实现中的类是:
CacheEntryEventListener
和
CacheMapAccessEventListener
。
Cache Entry
:表示缓存对象的包装实体,它包装了缓存对象和刷新策略。对应到现在的
OSCache
实现中的类是:
CacheEntry
。
一个典型的“缓存对象”场景是:
应用调用
Cache Factory
获得
Cache Proxy
,然后应用将要缓存的对象以及刷新策略通过
Cache Proxy
存储到
Cache Map
中,并通知各个
Listener
。
一个典型的“取得缓存对象”的场景是:
应用调用
Cache Factory
获得
Cache Proxy
,然后给
Cache Proxy
的相应方法传入要获得的缓存对象的
key
,
Cache Proxy
会根据指定的刷新策略判断缓存是否过期,如果缓存没有过期,则返回缓存对象,如果缓存过期,则刷新缓存,并向应用层抛出需要刷新的异常(
NeedsRefreshException
),应用如果收到此异常,将重新计算内容并将内容缓存。
OSCache
现有的缓存刷新策略(超过指定时间后自动过期,超过指定日期后自动过期,按照克龙表达式的设定自动过期)不能满足需求。现有应用要求:当数据源的部分内容更新后,能够使相关缓存过期,展现页面从数据源取得更新的内容显示。
该方案为下列场景提供了支持:
1.
缓存整个
Response
,能够定制刷新指定的
Response
。
2.
缓存
JSP
页面内容,能够定制刷新指定的缓存内容。
3.
缓存对象,能够定制刷新指定的缓存对象。
在
Web
应用的
web.xml
中添加下面的内容:
<
filter>
<
filter-name>CacheFilter</filter-name>
<
filter-class>
com.***.portal.oscache.***CacheFilter
</
filter-class>
<
init-param>
<
param-name>time</param-name>
<
param-value>-1</param-value>
</
init-param>
<
init-param>
<
param-name>scope</param-name>
定制这个
fileter
缓存的
response
的组
|
<
param-value>application</param-value>
</
init-param>
<init-param>
<param-name>groups</param-name>
<param-value>
landy
</param-value>
</init-param>
</
filter>
<
filter-mapping>
<
filter-name>CacheFilter</filter-name>
<
url-pattern>/
landy
</
url-pattern>
</
filter-mapping>
|
注意:
为了在部分数据更新时只刷新部分
Response
,
***CacheFilter
比
OSCache
提供的
CacheFitler
增加了一个可配置的参数:“
groups
”,部署者可以通过这个参数配置这个
filter
所映射的
URLS
的组(通常同一个组的
URL
会从同时更新的数据源取数据),这样当数据源某部分更新之后,我们就可以刷新从这部分数据源取数据的
URLs
。该配置项支持配置多个组,以逗号作为分隔符,如:“
group1,group2
”。
其他的配置项说明请参考
OSCache
在线文档的
CacheFilter
配置部分
。
OSCache
提供的
CacheFilter
能够缓存
Response
,但不能供应用选择性的刷新某些
Response
,而
***CacheFilter
就能支持这一特性。
您可以按照以下的方式刷新某一组(
Filter
初始化参数中
groups
参数配置的内容)的
Responses:
ServletCacheAdministrator admin = null;
Filter
初始化参数中
scope
参数配置的内容
|
admin = ServletCacheAdministrator.getInstance(config
.getServletContext());
Filter
初始化参数中
groups
参数配置的内容
|
Cache cache = admin.getCache(httpRequest, cacheScope);
cache. flushGroup(group);
|
这种方案仅适用于普通的
web
应用,不适用于
Portlets
应用,因为在
Portlets
应用中,每个
Portlet
都是页面上一个可插拔的组件,如果被缓存的
Response
代表的页面中某个
Portlet
被删除了,那么这个页面产生的
Response
就会不一样,而这时应用却无法刷新缓存的
Response
。
可以在
JSP
页面中将要缓存的内容置于
<cache></cache>
标签之间,当更新数据源的事件产生时,在处理事件的方法中加入如下代码即可:
***OSCacheUtil.getInstance().flushGroup("group1");
|
我要缓存一个从数据源的
A
表取数据的
JSP
内容段,如下表所示:
<oscache:cache key="foobar" scope="application" time="-1" groups="group1" >
//business code
Select * from table A and Display
</oscache:cache>
|
数据源更新了,在处理数据更新事件的代码中,我加入下表的代码:
***OSCacheUtil.getInstance().flushGroup("group1");
|
这样就可以刷新缓存的
group1
组的数据了。
本方案在满足了
4.1
描述的需求的条件下,仅支持选择性的刷新存储在
application
域(
cache
标签中
scope
属性配置为
application
)的缓存。为什么不支持选择性的刷新
session
域的缓存呢?是因为数据更新的事件产生是随机的,当数据更新事件发生时,我们无法得到
web
服务器中的每个
session
,所以不能支持选择性的刷新
session
域的缓存。
可以在
web
应用的业务处理逻辑中将要缓存的对象采用如下的方式将对象缓存到
application
域中:
***OSCacheUtil.getInstance().putInCache(key, content, new String[]{“group1”});
|
当更新数据源的事件产生时,在处理事件的方法中加入如下代码即可:
***OSCacheUtil.getInstance().flushGroup("group1");
|
同
4.5.2
一致。
5
开始使用OSCache中的缓存组件
OSCache中按照缓存范围的不同分为两种不同的方式:一种是缓存JSP页面中部分或者全部内容,一种是基于整个页面文件的缓存。
4.1 JSP部分内容缓存
4.1.1 Cache-OSCache提供的缓存标签
这是OSCache提供的标签库中最重要的一个标签,包括在标签中的内容将应用缓存机制进行处理,处理的方式将取决于编程者对cache标签属性的设置。
第一次请求到达时,标签中的内容被处理并且缓存起来,当下一个请求到达时,缓存系统会检查这部分内容的缓存是否已经失效,主要是以下几项:
- 1. 缓存时间超过了cache标签设置的time或者duration属性规定的超时时间
- 2. cron属性规定的时间比缓存信息的开始时间更晚
- 3. 标签中缓存的内容在缓存后又被重新刷新过
- 4. 其他缓存超期设定
如果符合上面四项中的任何一项,被缓存的内容视为已经失效,这时被缓存的内容将被重新处理并且返回处理过后的信息,如果被缓存的内容没有失效,那么返回给用户的将是缓存中的信息。
cache标签的属性说明:
key - 标识缓存内容的关键词。在指定的作用范围内必须是唯一的。默认的key是被访问页面的URI和后面的请求字符串。
你可以在同一个页面中使用很多cache标签而不指定他的key属性,这种情况下系统使用该页面的URI和后面的请求字符串,另外再自动给这些key增加一个索引值来区分这些缓存内容。但是不推荐采用这样的方式。
scope - 缓存发生作用的范围,可以是application或者session
time - 缓存内容的时间段,单位是秒,默认是3600秒,也就是一个小时,如果设定一个负值,那么这部分被缓存的内容将永远不过期。
duration - 指定缓存内容失效的时间,是相对time的另一个选择,可以使用简单日期格式或者符合USO-8601的日期格式。如:duration='PT5M' duration='5s'等
refresh - false 或者true。
如果refresh属性设置为true,不管其他的属性是否符合条件,这部分被缓存的内容都将被更新,这给编程者一种选择,决定什么时候必须刷新。
mode - 如果编程者不希望被缓存的内容增加到给用户的响应中,可以设置mode属性为"silent"
其它可用的属性还包括:cron 、groups、language、refreshpolicyclass、refreshpolicyparam。
上面的这些属性可以单独使用,也可以根据需要组合使用,下面的例子将讲解这些常用属性的使用方式。
4.1.2 Cache标签实例分析:
1. 最简单的cache标签用法
使用默认的关键字来标识cache内容,超时时间是默认的3600秒
<cache:cache>
<%
//自己的JSP代码内容
%>
</cache:cache>
|
2. 用自己指定的字符串标识缓存内容,并且设定作用范围为session。
<cache:cache key="foobar" scope="session">
<%
//自己的JSP代码内容
%>
</cache:cache>
|
3.动态设定key值,使用自己指定的time属性设定缓存内容的超时时间,使用动态refresh值决定是否强制内容刷新。
因为OSCache使用key值来标识缓存内容,使用相同的key值将会被认为使用相同的的缓存内容,所以使用动态的key值可以自由的根据不同的角色、不同的要求决定使用不同的缓存内容。
<cache:cache key="<%= product.getId() %>" time="1800" refresh="<%= needRefresh %>">
<%
//自己的JSP代码内容
%>
</cache:cache>
|
4. 设置time属性为负数使缓存内容永不过期
<cache:cache time="-1">
<%
//自己的JSP代码内容
%>
|
5. 使用duration属性设置超期时间
<cache:cache duration='PT5M'>
<%
//自己的JSP代码内容
%>
|
6. 使用mode属性使被缓存的内容不加入给客户的响应中
<cache:cache mode='silent'>
<%
//自己的JSP代码内容
%>
|
参考资料:
[1]
http:/www.opensymphony.com/oscache/
引自: http://tb.blog.csdn.net/TrackBack.aspx?PostId=715519