数据缓存6.0使用文档

数据缓存6.0使用文档
一：背景
NC6.0的数据缓存在5.X的基础上做了一系列的改进，随着NC6.0多组织的引入，在同一系统，同一集团下，跨组织、跨公司的业务交互为业务的常态，而5.X按照帐套+公司的缓存组织方式不再适用.
缓存6.0在尽可能保证用户使用习惯的前提下，对缓存的配置文件、用户界面、以及查询接口等方面进行了改进和优化，该文档将对于这些方面的变化进行详细地介绍。

二：缓存6.0的配置文件
6.0缓存的配置与5.5的配置有了一些改变，但对使用者来说，基本上使用方法相同。

在后台，仍然有一个通过各个模块的配置文件，合成模板配置文件的过程。

3.1：客户端配置文件位置：
NC_CLIENT_HOME: NC产品在客户端的根目录
NC_CURRENT_SYSTEM: 登陆的系统
NC_CURRENT_GROUP:登陆的集团
NC_CACHE_WORKDIR: 缓存的工作目录位置算法为
${NC_CLIENT_HOME}/CACHE/${ NC_CURRENT_SYSTEM }${NC_CURRENT_GR OUP}
3.2：服务器端配置文件的位置：
Cacheconfig.xml: NC_HOME/resources/cacheconfig/cacheconfig.xml
各模块的配置文件:模块目录/cacheconfig/tabconfig.xml
3.3：缓存的基本属性配置：
⏹appliable属性:缓存是否启用，如果为true,登陆桌面后缓存会自动启用。

如果为false,
需要进入缓存面板点击启用缓存按纽，缓存才会启动。

⏹autoRefresh属性：自动刷新，如果为true, 缓存启动后，会启动自动刷新服务，自
动刷新线程会每隔一段时间刷新一次前台缓存。

该属性对应缓存配置板上的“启动
数据同步服务”复选框。

⏹refreshInterval属性：自动刷新的间隔。

单位分钟。

⏹pagedSize属性：下载缓存数据时分页的大小。

单位是记录的条数。

⏹lfuMax属性：
⏹lruMax属性：lru最大的缓存列数
⏹activate属性：
⏹configurable属性：
⏹headSql：前置sql，只在初始化缓存前执行。

该标签有个属性ignoreRrror，当其值
为ture时，则忽略掉执行该sql时发生的异常。

格式固定为：分句1;分句2;分句3 …
⏹分句前如果有“--”则该分句不执行。

“--”表注释。

⏹每个分句结构举例如下:
⏹[select from sysobjects a, sysobjects b where a.parent_obj=b.id AND
a.xtype='PK' AND
= 'BD_CORP']ALTER TABLE BD_CORP DROP
CONSTRAINT @;
⏹endSql：后置sql，只在初始化缓存后执行。

其它情况同HeadSql。

3.4:数据源配置：
6.0的缓存数据源也在cacheconfig.xml文件中配置，默认的是hsql数据库。

该配置一般无需改变。

3.5缓存表配置：
⏹name:表的名字
⏹primaryKey：主键
⏹groupColumn：集团列，一般为pk_group，不配表示没有按照集团过滤
⏹strategy: LRU|LFU|FULL|LRU_LFU,分别表示进行LRU缓存算法的表，保存常见
档案的表，全表或者LRU,LFU同时提供的表，默认,或者不配为FULL
⏹column: column还有一个属性system，表示是否允许用户配置该列。

通常除了主键
以外，其他列都可以设为false.
⏹filterSql：如果某个表有特殊的业务条件则将配置这个属性。

其格式为：条件１and
条件２and 条件３,filterSql中支持变量，变量的语法为”${}“包围的部分，缓存
将根据需求，提供变量替换机制和一些内置的变量，用户出口部分的变量自动进入
变量解释计算中。

⏹postCreateSql：创表后的的SQL语句，比如建索引语句
三：缓存客户端界面
缓存的客户端主界面（图2-1）是大家接触缓存最直接的方式，界面的风格与5.5没有发生很大的变化。

主要的功能有：
启动、停止数据缓存
启动、停止缓存后台自动刷新线程
更改后台刷新线程的运行时间间隔
缓存的状态显示
缓存的配置以及错误查询
当第一次启动缓存界面时，由于客户端的缓存配置、前台数据库都没有准备好，所以缓存处于不可用状态：
这时点击启动数据缓存，则界面会弹出一个选择对话框，要求用户选择配置方案，一般来说，选择default即可，default方案是在服务器端的一个完整的缓存表配置方案，点击确定后，界面开始加载配置，并连接前台数据源, 然后前台缓存就进入可用状态了。

虽然缓存可用，但前台缓存并没有初始化地下载后台数据库中的数据，所以此时前台数据库没有任何数据。

所有通过缓存的查询都仍然后到后台查询。

所以接下来要做的就是初始化数据。

初始化进度对话框较5.x有较大的改变，可以实时的查看到下载过程的各种信息，包括下载进度、错误等等。

下载信息类似于日志的功能，是为了让用户在下载过程中，明确缓存正在做些什么，这样，在下载大表数据时，用户能更有耐心地等待。

通常在初始化完成以后，用户就可以关闭缓存配置界面了，因为配认的配置模板已经将其它的详细信息配置好了。

缓存下载或刷新过程中出现的错误将被记录，可以在错误日志项中查找到相应的错误，以更快地定位错误发生的原因。

这里不但能查到下载错误的记录，前台缓存的查询错误也会被记录。

如某列未缓存，但是试图查询这一列，就会出现异常，这也将被记录到查询错误记录。

可以在前台增加、删除、修改缓存表的配置，修改后需重新初始化，使新的配置生效。

数据源的配置与5.x版类似。

四：缓存API
4.1：DBCacheFacade
该API有量个实现，一个对于后台，一个对于前台。

之所以提供两个实现主要是解决该API可能在服务器端和客户端同时使用到。

initDBCahce方法主要用于客户端登陆桌面时异步地初始化缓存。

destroyDBCache方法用于客户端注销时，关闭缓存。

将内存中的数据持久化。

refreshTable方法用于刷新前台缓存表。

findColumnsValues系列方法主要用于公式查询，使用方法与5.5一致。

方法中将判断缓存是否可用，如果不可用，直接去后台查询。

如果可用，在前台查询，如果前台查询出现异常或查询结果为空，则查询为空的参数，到后台查询。

matchPK、getFromDBCache、runQuery、runDynamicQuery都是基本的查询方法，matchPK 和getFromDBCahce是使用VectorProcessor处理结果集的查询方法，而runQuery、runDynamicQuery是通用的查询方法，查询时，如果缓存不可用，则到后台查询，否则在前台查询。

如果前台查询异常或查询结果为空时，到后台查询。

runSmartQuery是批量查询方法。

查询的逻辑也是前台查询不到，到后台查询。

runLocalQuery只在本地查询。

如果缓存不可用，则返回空。

refreshLfuData刷新常用档案表的缓存数据。

requestLfuCacheData当前台查询了一条LFU类型的表数据时，调用这个方法，可以更改这条数据在前台缓存中的权重，权重高的将继续保存在前台缓存中，权重低的有可能将被置换出缓存。

权重的高低与数据被请求的次数成正比。

方法要求传入两个参数，一个是表名，一个是这张表被请求的PK数组。

runLfuDataQuery同runSmartQuery.
4.2：DBCacheEnv:
isCacheEnabled()判断缓存是否可用。

缓存是否可用是指前台缓存是否已经连接上数据库了。

isTableCached()在缓存可用的前提下，该方法进一步判断缓存数据库是是否已经缓存了指定的表数据。

3:IDBCacheBS:
RunSQLQuery、runQuery、findColumnsValues这些查询方法代理了IDBCacheFacade后台实现类的对应方法。

LoadData、getTables、getChangedNumber、getSolutions、loadServerCacheConfig、getServerDBInfo、isTableExist这些方法主要用于缓存内部使用。

delByWhereClause、delPKs方法用于更新后台数据库时，通知缓存更改后台bd_del_log 表的信息。

4:CacheProxy:
同5.5，没有发生大的改变，fireDataInserted、fireDataUpdated分别增加了一个参数的方法，不用传递修改数据的PK.。