GreenDao3.0 高阶玩法

07 August 2018

最近碰到一个对某个页面添加缓存的需求(缓存失效时间为30m)。两个方案：

1. 数据保存到文件

2. 数据保存到数据库

考虑到未来这样的需求可能蔓延到其他诸多的页面，同时项目中采用了GreenDao3.0数据库，基于GreenDao数据库的简易和高效性，所以决定选择方案2. 首先说一下我的采用数据库作为缓存数据方式的一个预期。

所有缓存页面的数据保存在一张表中
每个页面在表中对应一条数据(eg：如果有10个页面的数据需要缓存，那么就会有10条数据)
每个页面在每次缓存的时候都会覆盖相同的一条数据
每次读取缓存的时候会根据页面的ID(ID类型为String Int)进行读取

按照上述预期的第一条，我们首先需要定义一张表，能定义好这张表，那么我们的需求可以说就完成了一半(不夸张吧)。如下所示是我前期定义的一张表

@Entity(nameInDb = "pageCache")
public class PageCache {

  @Id
  private Long id;

  @Property(nameInDb = "cacheSegment")
  private String cacheSegment;

  /**扩展域(预留)*/
  @Property(nameInDb = "extensionCacheSegment")
  private String extensionCacheSegment;

  @Property(nameInDb = "cacheTime")
  private long cacheTime;

  //表示 来至哪个页面的缓存数据
  @Property(nameInDb = "pageId")
  private String pageId;
}

表中包含了缓存内容，缓存时间，页面缓存Id，还有预留等字段。针对【发现页】页面数据进行缓存，我在每次缓存数据到表中的时候出现了问题，表中会每次新增一条数据，这个结果违背了我们的预期。这是我的GreenDao缓存操作片段代码 (为了避免阻塞主线程，所以会在子线程中完成缓存操作)

Observable.create(new ObservableOnSubscribe<Object>(){
    @Override public void subscribe (ObservableEmitter < Object > emitter) {
    try {
      PageCache cache = new PageCache();
      cache.setCacheTime(System.currentTimeMillis());
      cache.setPageId(pageId);
      bean.setCacheTime(System.currentTimeMillis());
      String data = JsonUtil.toJson(bean);
      cache.setCacheSegment(data);
      GreenDaoManager.getInstance().getPageCacheDao().insertOrReplace(cache);
    } catch (Throwable t) {
      t.printStackTrace();
    }
  }
  }).compose(Rx2Schedulers.applyObservableAsync()).subscribe();

可以看到，针对【发现页】pageId是相同的。出现上面的问题其实是可以通过if判断来解决的。每次在存储前读取pageId的数据data，如果data不为null，那么去执行update操作，否则执行insert操作。这样可以解决问题，但会带来一定的性能损耗，不是最优操作。为了获得最优操作，网上搜了好几发，获取有用的信息比较少。猜想GreenDao应该能覆盖这样的需求，最终翻到1个注解 @Index 这个注解就是将某个字段变成索引，那么我们就可以保证数据库表中每一行数据的唯一性。然后我们的表就定义成了这样

@Entity(nameInDb = "pageCache")
public class PageCache {

  @Id
  private Long id;

  @Property(nameInDb = "cacheSegment")
  private String cacheSegment;

  /**扩展域(预留)*/
  @Property(nameInDb = "extensionCacheSegment")
  private String extensionCacheSegment;

  @Property(nameInDb = "cacheTime")
  private long cacheTime;

  //表示 来至哪个页面的缓存数据
  @Index(unique = true)  
  @Property(nameInDb = "pageId")
  private String pageId;
}

下图是我缓存了3个页面后得到的数据结果

读取缓存就非常简单了，根据pageId读取缓存的操作如下：

public static String getCacheFromDBByPageId(String pageId) {
    String cacheStr = null;
    try {
      List<PageCache> caches = GreenDaoManager.getInstance().getPageCacheDao()
          .queryBuilder()
          .where(PageCacheDao.Properties.PageId.eq(pageId))
          .build().list();
      PageCache cache = (caches == null || caches.isEmpty()) ? null : caches.get(0);
      if (cache != null) {
        cacheStr = cache.getCacheSegment();
      }
    } catch (Throwable t) {
      t.printStackTrace();
    }

    return cacheStr;
  }

最后说一下GreenDao3.0数据库升级的问题。因为我在数据库中新增了一张表，所以数据库需要进行升级。默认GreenDao升级操作会先将所有的表drop掉，然后再重新create，这种方式过于暴力。如下图：

但这也是GreenDao提供的一种默认的操作。我们可以自定义自己的升级策略。自定义需要继承DevOpenelper类，复写onUpgrade方法。下图是我的简单升级策略

可见GreenDao的升级是非常灵活简单的。虽然 greenrobot 推出GreenDao没有多久，但是，greenrobot已经建议开发者在新开发的App中使用 ObjectBox ，感觉GreenDao是要被时代所淘汰了。

— J.Chou