Cache设计说明书.doc

数据字典管理组件设计说明书 Cache管理设计说明书拓维信息系统股份有限公司第 11 页 共 12 页文档标识： 当前版本：1.0当前状态：草稿发布日期：2011-7-7发布修改历史日期版本作者修改内容评审号变更控制号2011-7-71.0新建目 录1概述31.1功能说明31.2读者对象31.3参考文档31.4术语与缩写32功能设计32.1数据模型32.2类图42.3功能点说明42.3.1配置文件42.3.1.1属性解析42.3.1.2节点解析52.3.2设置Session52.3.3获取Session52.3.4销毁Session52.3.5重置过期时间52.4接口说明51 概述1.1 功能说明 通过可配参数，实现本地化的Ehcache及分布式的Memcached、redis缓存的统一配置和集中式管理。1.2 读者对象项目经理、设计人员、开发人员。1.3 参考文档WEB2.0基础应用平台二次开发手册模板_基础平台.doc1.4 术语与缩写缩写英文描述中文描述1.5 命名规则对象规则示例2 功能设计2.1 UML类图设计统一接口IMultiCacheManager，屏蔽具体的缓存实现的差异性，CacheManager实现统一接口、实现对cache进行的增加、删除、获取。不同类别的cache是根据cachename来进行区分。如要进行CacheManager的改变，增加新的CacheManager，新的CacheManager必须实现IMultiCacheManager统一接口，在具体使用时指向新的实例即可。Ehcache扩展实现：分布式Cache扩展实现(Memcached、Redis)：Icache接口：缓存采用可扩展的设计模式，需要扩展缓存时，比较容易扩展，不必修改原来的代码。Cache的具体操作类，即实现缓存具体的增加、删除和获取的类，要实现Channel接口，Channel接口继承自IChache接口；具体实现的方法如下：IChache接口public interface ICache /对cache中增加数据 public boolean put(String key,Serializable value) throws Exception;/ 对cache中增加数据,并且设置数据超时public boolean put(String key,Serializable value, int waitTimes) throws Exception;/从cache中获取数据public Serializable get(String key) throws Exception;/从cache中获取数据,并且设置数据超时public Serializable get(String key, int waitTimes) throws Exception;/ 从cache中删除数据public boolean remove(String key) throws Exception;/从cache中删除数据,并且设置数据超时public boolean remove(String key, int waitTimes) throws Exception;/ 从cache中清空所有数据public boolean removeAll() throws Exception; / 得到cache名称 public String getName() throws Exception;Channel接口public interface Channel extends ICache public boolean isAlive();public void close() throws Exception;public RemoteSourceItem getRemoteSourceItem();具体缓存的使用要通过一个缓存通道池来管理，缓存池的统一接口为ChannelPool，各不同的缓存统一实现此接口，并各自编写实现方法。ChannelPool接口public interface ChannelPool public Channel getChannel() throws Exception;public void close() throws Exception ;2.2 功能点说明2.2.1 配置文件使用twdpe-core工程中系统配置文件cache.xml，内容节点如下：缓存模块的配置分为：本地缓存配置、分布式缓存配置(Memcached、Redis)。1) 增加本地缓存对象向本地缓存增加对象的前提是该缓存已经存在，如缓存尚未建立需按以下步骤执行：首先在cache.xml（下图）配置本地缓存echcache_wadelib.xml；，如缓存的最大元素数，内存溢出时是否持久化等；2) 增加分布式缓存Memcached对象memcached分布式缓存在上图中的type为memcache，它需要一个分布式主机信息的配置文件在path中指定，此memcache的id即为cachename；Memcached的配置：配置说明：配置项说明host缓存主机地址port端口timeout超时时间(秒)maxActive最大连接数maxIdle初始连接数maxWait连接池等待超时时间expire默认缓存时间mainSleep主线程休眠时间3) 增加分布式缓存Redis对象分布式缓存在上图中的type为redis，它需要一个分布式主机信息的配置文件在path中指定，此redis的id即为cachename；Redis的配置：配置说明：配置项说明host缓存主机地址port端口timeout超时时间(秒)maxActive最大连接数maxIdle初始连接数maxWait连接池等待超时时间expire默认缓存时间2.2.2 设置Cache根据输入的cache关键字，将需要保存的对象以KEY-VALUE对的方式保存于Ehcache或Memcache、Redis中。如：l 放置需要缓存的可序列化对象，根据缓存名称：putObject(String cacheName, String key, Serializable value)l 根据缓存名称，放置需要缓存的可序列化对象，并设轩超时时间：putObject(String cacheName, String key,Serializable value, int waitTimes)l 根据缓存名称，放置需要缓存的可序列化对象及指定缓存时间， putObjectExpire(String cacheName, String key, Serializable value, int expire)2.2.3 获取Cache根据输入的关键字，从Cache缓存服务中获取它所对应的对象，如：l 获取缓存的对象，根据缓存名称及键值：getObject(String cacheName, String key)l 获取缓存的对象，根据缓存名称、键值及等待时间：getObject(String cacheName, String key,int waitTimes)2.2.4 销毁Cache根据输入的关键字，从Cache缓存服务中将它移除，如：l 移除缓存