OSCache 详细使用文档<一>

一、简介

     Cache是一种用于提高系统响应速度、改善系统运行性能的技术。尤其是在Web应用中,通过缓存页面的输出结果,可以很显著的改善系统运行性能。

OSCache标记库由OpenSymphony设计,它是一种开创性的缓存方案,它提供了在现有JSP页面之内实现内存缓存的功能。OSCache是个一个被广泛采用的高性能的J2EE缓存框架,OSCache还能应用于任何Java应用程序的普通的缓存解决方案。

OSCache是当前运用最广的缓存方案,JBoss,Hibernate,Spring等都对其有支持。

Oscache的使用非常方便,特别是jsp cache用的非常广泛。Oscache的文档中也对jsp cache tag的配置有详细说明。

 对使用Cache的测试结论:

使用cache,随着循环的增多,用时增长较缓慢,而不使用cache基本是等比例增长。在循环次数较多时,使用cache cpu利用率显著提高,能达到90%以上。不使用cache则只能上到50%左右,更多是在等待数据库返回结果。所以使用cache能大大减轻数据库的压 力,提高应用服务器的利用率,符合我们对应用服务器进行水平扩展的要求。

二、OSCache的特点和主要特征

(一)、OSCache有以下特点

1、缓存任何对象:你可以不受限制的缓存部分jsp页面或HTTP请求,任何java对象都可以缓存。

2、拥有全面的APIOSCache API允许你通过编程的方式来控制所有的OSCache特性。

3、永久缓存:缓存能被配置写入硬盘,因此允许在应用服务器的多次生命周期间缓存创建开销昂贵的数据。

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

5、缓存过期:你可以有最大限度的控制缓存对象的过期,包括可插入式的刷新策略(如果默认性能不能满足需要时)。

(二)、主要特征

1. 兼容多种支持JSPweb服务器

已经通过兼容测试的web服务器包括OrionServer (1.4.0或者以上版本) Macromedia JRun (3.0或者以上版本) BEA Weblogic (7.x或者以上版本) IBM Websphere (5.0版本)Silverstream (3.7.4版本)Caucho Resin (1.2.3或者以上版本)Tomcat (4.0或者以上版本) ,其他支持servlet2.3jsp1.2web服务器应该都是完全兼容OSCache的。

2. 可选的缓存区

你可以使用内存、硬盘空间、同时使用内存和硬盘或者提供自己的其他资源(需要自己提供适配器)作为缓存区。

使用内存作为缓存区将可以提供更好的性能

使用硬盘作为缓存区可以在服务器重起后迅速恢复缓存内容

同时使用内存和硬盘作为缓存区则可以减少对内存的占用

3. 灵活的缓存系统

OSCache支持对部分页面内容或者对页面级的响应内容进行缓存,编程者可以根据不同的需求、不同的环境选择不同的缓存级别。

4. 容错

在一般的web应用中,如果某个页面需要和数据库打交道,而当客户请求到达时,web应用和数据库之间无法进行交互,那么将返回给用户"系统出错"或者类似的提示信息,如果使用了OSCache的话,你可以使用缓存提供给用户,给自己赢得维护系统或者采取其他补救的时间。

其它特性还包括对集群的支持、缓存主动刷新等特性,大家可以参考OpenSymphony网站上的其他资源获取更多的信息。

 

二、OSCache使用指南

一、下载安装

OSCache是一个基于web应用的组件,他的安装工作主要是对web应用进行配置,大概的步骤如下:

1. 下载、解压缩OSCache

http://www.opensymphony.com/oscache/download.html下载合适的OSCache版本, 解压缩下载的文件到指定目录

2、新建立一个web应用

3、将OSCache集成到web项目当中。

1)从解压缩目录取得oscache.jar 文件放到 /WEB-INF/lib 或相应类库目录中,jar文件名可能含有版本号和该版本的发布日期信息等。

2)将oscache.propertiesoscache.tld放入WEB-INF\class目录(确切说是放在项目的src目录下,编译的时候会自动生成在WEB-INF\class目录)。

3)配置项目对应的oscache.properties参数信息。

4)具体使用

A、缓存对象:直接调用API的接口即可(详见[Java]OSCache进行缓存对象)

B、部分页面缓存:使用OSCache提供的taglib(修改web.xml文件,在web.xml文件中增加下面的内容,增加对OSCache 提供的taglib的支持:<taglib> <taglib-uri>oscache</taglib-uri> <taglib-location>/WEB-INF/classes/ oscache.tld</taglib-location></taglib>或者在jsp页面使用以下标签

<%@ taglib uri="/WEB-INF/classes/oscache.tld" prefix="cache"%>

C、整个页面的缓存:用CashFilter实现页面级缓存,可缓存单个文件、缓存URL pattern和自己设定缓存属性的缓存。

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

<!-对所有jsp页面内容进行缓存-->

<url-pattern>*.jsp</url-pattern>

</filter-mapping>

[] 只有客户访问时返回http头信息中代码为200(也就是访问已经成功)的页面信息才能够被缓存

4、配置日志输出信息。

二、oscache.properties 文件配置向导

oscache.properties 中的配置项详解:

1cache.memory

是否使用内存缓存; true false。默认为true; 如设置为false,那cache只能缓存到数据库或硬盘中。

2cache.capacity

缓存的最大数量。默认是不限制,cache不会移走任何缓存内容。负数被视不限制。

3cache.algorithm

运算规则。为了使用规则,cachesize必须是指定的。

如果cachesize不指定的话, 将不会限制缓存对象的大小。如果指定了cachesize,但不指定algorithm,那它会默认使用:com.opensymphony.oscache.base.algorithm.LRUCache

有下面三种规则:

      com.opensymphony.oscache.base.algorithm.LRUCache:

last in first out(最后插入的最先调用)。默认选项。

      com.opensymphony.oscache.base.algorithm.FIFOCache:

first int first out(最先插入的最先调用)

      com.opensymphony.oscache.base.algorithm.UnlimitedCache :

cache中的内容将永远不会被丢弃。

如果cache.capacity不指定值的话,它将被设为默认选项。

4cache.blocking

是否同步。true 或者 false。一般设为true,避免读取脏数据。

5cache.unlimited.disk

指定硬盘缓存是否要作限制。默认值为falsefalse的状况下,disk cache capacity cache.capacity的值相同。

6cache.persistence.class

指定类是被持久化缓存的类。class必须实现PersistenceListener接口。

作为硬盘持久,可以实现

com.opensymphony.oscache.plugins.diskpersistence.HashDiskPersistenceListener接口。

它把classtoString()输出的hash值作为文件的名称。如果你要想文件名易读些(自己设定),DiskPersistenceListener 的父类也能使用,但其可能有非法字符或者过长的名字。

注意:HashDiskPersistenceListener DiskPersistenceListener 需要设定硬盘路径:cache.path

 

7cache.path

指定硬盘缓存的路径。目录如果不存在将被建立。同时注意oscache应该要有权限写文件系统。

:

cache.path=c:\\myapp\\cache

cache.path=/opt/myapp/cache

8cache.persistence.overflow.only (NEW! Since 2.1)

指定是否只有在内存不足的情况下才使用硬盘缓存。

默认值false。但推荐是true如果内存cache被允许的话。这个属性彻底的改变了cache的行为,使得persisted cachememory是完全不同。

9cache.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的生命周期中记录所有entry的事件。

* com.opensymphony.oscache.extra.CacheMapAccessEventListenerImpl : 记录count of cache map eventscache hitsmisses and state hits.

10cache.key

application session的作用域时 用于标识cache 对象的, 

用于ServletCacheAdministrator;此属性不是指定为"__oscache_cache"格式时为默认值, 如果代码中需要用到默认值时可以通使用

com.opensymphony.oscache.base.Const.DEFAULT_CACHE_KEY 来取得;

11cache.use.host.domain.in.key

当配置多个服务器时,想通过服备器名称自动生成cache key,可将此属性设为true. 默认值为false;

12Additional Properties

在以上基础选项之上可以加入一些额外的属性到此文件中.

:  JavaGroupsBroadcastingListener 便是额外的.

13cache.cluster.multicast.ip

用于缓存集群. 默认为231.12.21.132

14cache.cluster.properties

指集群中的额外配置项. 以下是默认设置:(此属性的相关说将在集群文档中说明)

UDP(mcast_addr=231.12.21.132;mcast_port=45566;ip_ttl=32;\

mcast_send_buf_size=150000;mcast_recv_buf_size=80000):\

PING(timeout=2000;num_initial_members=3):\

MERGE2(min_interval=5000;max_interval=10000):\

FD_SOCK:VERIFY_SUSPECT(timeout=1500):\

pbcast.NAKACK(gc_lag=50;retransmit_timeout=300,600,1200,2400,4800;max_xmit_size=8192):\

UNICAST(timeout=300,600,1200,2400):\

pbcast.STABLE(desired_avg_gossip=20000):\

FRAG(frag_size=8096;down_thread=false;up_thread=false):\

pbcast.GMS(join_timeout=5000;join_retry_timeout=2000;shun=false;print_local_addr=true)

 

三、OSCache的基本用法(缓存JSP页面中部分)

(一):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 groupslanguagerefreshpolicyclassrefreshpolicyparam

上面的这些属性可以单独使用,也可以根据需要组合使用,下面的例子将讲解这些常用属性的使用方式。

(二) 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代码内容 %>

</cache:cache>

5. 使用duration属性设置超期时间

 

你可能感兴趣的:(编程,应用服务器,Web,jsp,cache)