OSCache 缓存重建在 Race Condition 下的 NRE 问题

二，NRE 背景：

从2005年OSCache的版本到现在，它一直这么声称：

   * @throws  NeedsRefreshException Thrown when the object either

     * doesn't exist, or exists but is stale.  When this exception occurs,

     *  the CacheEntry corresponding to the supplied key will be locked

     * and other threads requesting this entry will potentially be blocked

     * until the caller repopulates the cache. If the caller choses not

     * to repopulate the cache, they <em>must</em> instead call

     * {@link #cancelUpdate(String)}.

即，

当 key 不存在，或者存在但数据过期（stale）时，

调用 getFromCache 函数时会抛出 NRE 异常；

当异常发生时，

对应于这个 key 的 CacheEntry 将被锁住，

而请求这个 entry 的其他线程将 可能（注意，仅仅是可能）被阻塞，直到调用者重建缓存。

如果调用者没有选择重建缓存，必须 调用 cancelUpdate 函数来“Cancels any pending update for this cache entry”。

三，缓存重建的 OSCache 官方推荐做法：

1 String myKey = "myKey";
2 String myValue;
3 int myRefreshPeriod = 1000;
4 try {
5 // Get from the cache
6 myValue = (String) admin. getFromCache(myKey, myRefreshPeriod);
7 } catch (NeedsRefreshException nre) {
8 try {
9 // Get the value (probably from the database)
10 myValue = "This is the content retrieved.";
11 // Store in the cache
12 admin. putInCache(myKey, myValue);
13 } catch ( Exception ex) {
14 // We have the current content if we want fail-over.
15 myValue = (String) nre.getCacheContent();
16 // It is essential that cancelUpdate is called if the
17 // cached content is not rebuilt
18 admin. cancelUpdate(myKey);
19 }
20 }

1 public OSCache get(String key,int myRefreshPeriod){
2 try{
3 return (OSCache)this.admin. getFromCache(key,myRefreshPeriod);
4 }catch(NeedsRefreshException ex){
5 this.admin. cancelUpdate(key);
6 return null;
7 }
8 }

四，OSCache 在 Race Condition 下缓存重建的特殊场景

简单地说，就是：

 

具体过程如下：

（0）缓存过期；

（1）线程 T1 获得 update lock，并开始调用 putInCache 函数 ；

（2） 线程 T2 在 T1 没有结束 update 之前，也开始 getCacheEntry 了；

（3）T2 调用的 getCacheEntry 函数捕获  NeedsRefreshException 异常；

（4）T2 调用 cancelUpdate 函数来“取消所有试图更新本 cache entry 的操作”， 于是 EntryUpdateState 变为 UPDATE_CANCELLED，它是一个正整数 2；

（5） T1 其实已经重建了缓存；

（6）T1 随后调用 completeUpdate（EntryUpdateState.java,93行） 来通知那些等着本次更新操作的线程； 但 completeUpdate 函数却发现当前 EntryUpdateState 居然不等于 UPDATE_IN_PROGRESS（对应0），而是 UPDATE_CANCELLED（对应2），于是抛出异常。即下面代码抛出的 IllegalStateException 异常，文字通常为：“Cannot complete cache update - current state ( 2) is not UPDATE_IN_PROGRESS”，其中的 2 就是指  UPDATE_CANCELLED：