2017-05-16 利用Guava Cache＋Tair＋MD

业务原因

产品鼓励用户分享商品，为用户分享增加内容，在分享模块中增加了数十条分享文案以及两组图片（商品详情图 和 买家秀图片）。客户端唤起微信／微博分享时 需要获取文案及图片。

第一版设计 集中式缓存＋数据库

计划使用Tair＋MySQL的设计，将每个商品的文案和图片（图片已上传到外部文件网关，存在业务端的也是字符串）以商品ID纬度存储到Tair和MySQL中。

优点：逻辑简单，维护容易。后台更新逻辑仅需更新DB和Tair。
缺点：Tair压力大。

第二版设计 增加本地缓存

利用guava cache构建一个本地缓存，前端接口获取数据按照 本地缓存－集中缓存－数据库的顺序获取数据。场景一：本地缓存无，集中缓存有，则从集中缓存更新到本地缓存。场景二：本地缓存无，集中缓存无，数据库有，则从数据库更新到集中缓存和本地缓存。

优点：集中式缓存压力小
缺点：前端逻辑复杂，后台更新三处地方，数据一致性难以保证。

第三版设计 利用一致性算法（MD5摘要）减少复杂性

集中式缓存仅保存MD5摘要，不再保存业务内容；本地缓存除了保存业务内容，附加保存当前内容的MD5摘要。
前端获取数据，场景一：发现本地缓存无／本地缓存摘要和集中缓存不一样，则从DB更新到本地缓存，并更新最新内容摘要到集中缓存。场景二：后台更新，仅需要更新DB和集中缓存的MD5摘要值即可。

优点：前后端逻辑一致，比第二版设计简单，兼具第二版优点。
缺点：集中缓存仍面临多次更新MD5摘要。

实例（重要代码段）

业务接口：

/**
 * 根据spuId 获取分享文案列表
 *
 * @param spuId
 * @return
 */
public ItemShareWords doGetItemShareWords(long spuId) {
    ItemShareWords itemShareWords = new ItemShareWords();
    itemShareWords.spuId = spuId;
    if (spuId <= 0) {
        return itemShareWords;
    }
    if(!onlyFillItemShareWords(itemShareWords)) {
        logger.warn("doGetItemShareWords failed. spuId=" + spuId);
    }
    return itemShareWords;
}

/**
 * 仅填充分享文案相关信息
 *
 * @param itemShareWords
 */
private boolean onlyFillItemShareWords(ItemShareWords itemShareWords) {
    itemShareWords.levelMessages = new ArrayList<>();

    try {
        long spuId = itemShareWords.spuId;
        DigestCacheObject<LeaveMessagesBGO> lmDigestCacheObject =
                shareMaterialCacheManager.getLeaveMessagesFromCache(spuId);
        if (!isLeaveMessageValidCache(lmDigestCacheObject, spuId)) {
            MerItemShareMaterialDO merItemShareMaterialDO = merItemShareMaterialDao.queryBySpuId(spuId);
            lmDigestCacheObject = buildLeaveMessagesCache(merItemShareMaterialDO.getLeaveMessages());

            //保存缓存
            if (shareMaterialCacheManager.storeLeaveMessagesCache(spuId, lmDigestCacheObject)) {
                //保存相应的MD5摘要
                itemCacheManager.saveLeaveMessagesDigest(spuId, lmDigestCacheObject.getDigestStr());
            }
        }
        itemShareWords.levelMessages = lmDigestCacheObject.getValue().getLeaveMessages();    //朋友留言列表

        return true;
    } catch (Exception e) {
        // do something more.
        logger.error("onlyFillItemShareWords exception, itemShareWords=" + itemShareWords, e);
    }

    return false;
}

本地缓存Guava Cache：

// spring config class
@Configuration
public class CacheConfig {

    @Bean(destroyMethod="cleanUp")
    public Cache<String, DigestCacheObject<?>> cache() {
        return CacheBuilder.newBuilder().maximumSize(1000).build();
    }
}

// ShareMaterialCacheManager.java
@Autowired
private Cache<String, DigestCacheObject<?>> cache;
......

/**
 * 本地缓存保存朋友留言
 * 
 * @param spuId
 * @param value
 * @return
 */
public boolean storeLeaveMessagesCache(long spuId, DigestCacheObject<LeaveMessagesBGO> value) {
    try {
        if (value != null) {
            cache.put(getLeaveMessagesKey(spuId), value);
            return true;
        }
    } catch (Exception e) {
        logger.error("storeLeaveMessagesCache cache exception, spuId=" + spuId, e);
    }
    
    return false;
}

集中缓存Tair：

/**
 * 保存spuId对应的朋友留言的摘要
 * 
 * @param spuId
 * @param lmDigest
 * @return
 */
public boolean saveLeaveMessagesDigest(long spuId, String lmDigest) {
    try {
        if (!MD5CryptoUtil.isEffectiveMD5(lmDigest)) {
            logger.warn("invalid md5, squId={}, lmDigest={}", spuId, lmDigest);
            return false;
        }
        
        String key = TairConstant.getItemLeaveMessagesDigestKey(spuId);
        return baseCacheManager.addToTair(key, lmDigest);
    } catch (Exception e) {
        logger.error("saveLeaveMessagesDigest exception, spuId=" + spuId + ", lmDigest=" + lmDigest, e);
    }
    
    return false;
}