RxCache 整合 Android 的持久層框架 greenDAO、Room

Tony沈哲發表於2019-03-04

Android框架OOM

一. 背景

RxCache 是一個支援 Java 和 Android 的 Local Cache 。

之前的文章給 Java 和 Android 構建一個簡單的響應式Local Cache曾詳細介紹過它。

RxCache 包含了兩級快取： Memory 和 Persistence 。

下圖是 rxcache-core 模組的 uml 類圖

二. 持久層

RxCache 的持久層包括 Disk、DB，分別單獨抽象了 Disk、DB 介面並繼承 Persistence。

DB 介面:

package com.safframework.rxcache.persistence.db;

import com.safframework.rxcache.persistence.Persistence;

/**
 * Created by tony on 2018/10/14.
 */
public interface DB extends Persistence {

}
複製程式碼

在 RxCache 的持久層，嘗試整合 Android 常用的持久層框架。

2.1 整合 greenDAO

greenDAO 是一款開源的面向 Android 的輕便、快捷的 ORM 框架，將 Java 物件對映到 SQLite 資料庫。

首先，建立一個快取實體 CacheEntity ，它包含 id、key、data、timestamp、expireTime。其中 data 是待快取的物件並轉換成 json 字串。

@Entity
public class CacheEntity {

    @Id(autoincrement = true)
    private Long id;

    public String key;

    public String data;// 物件轉換的 json 字串

    public Long timestamp;

    public Long expireTime;

    ...... // getter 、setter
}
複製程式碼

建立一個單例的 DBService ，並提供返回 CacheEntityDao 的方法。其實，crud 的邏輯也可以放在此處。

public class DBService {

    private static final String DB_NAME = "cache.db";
    private static volatile DBService defaultInstance;
    private DaoSession daoSession;

    private DBService(Context context) {

        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, DB_NAME);

        DaoMaster daoMaster = new DaoMaster(helper.getWritableDatabase());

        daoSession = daoMaster.newSession();
    }

    public static DBService getInstance(Context context) {
        if (defaultInstance == null) {
            synchronized (DBService.class) {
                if (defaultInstance == null) {
                    defaultInstance = new DBService(context.getApplicationContext());
                }
            }
        }
        return defaultInstance;
    }

    public CacheEntityDao getCacheEntityDao(){
        return daoSession.getCacheEntityDao();
    }

}
複製程式碼

建立 GreenDAOImpl 實現 DB 介面，實現真正的快取邏輯。

import com.safframework.rxcache.config.Constant;
import com.safframework.rxcache.domain.Record;
import com.safframework.rxcache.domain.Source;
import com.safframework.rxcache.persistence.converter.Converter;
import com.safframework.rxcache.persistence.converter.GsonConverter;
import com.safframework.rxcache.persistence.db.DB;
import com.safframework.tony.common.utils.Preconditions;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;

/**
 * @FileName: com.safframework.rxcache4a.persistence.db.greendao.GreenDAOImpl
 * @author: Tony Shen
 * @date: 2018-10-15 11:50
 * @version: V1.0 <描述當前版本功能>
 */
public class GreenDAOImpl implements DB {

    private CacheEntityDao dao;
    private Converter converter;

    public GreenDAOImpl(CacheEntityDao dao) {

        this(dao,new GsonConverter());
    }

    public GreenDAOImpl(CacheEntityDao dao, Converter converter) {

        this.dao = dao;
        this.converter = converter;
    }

    @Override
    public <T> Record<T> retrieve(String key, Type type) {

        CacheEntity entity = dao.queryBuilder().where(CacheEntityDao.Properties.Key.eq(key)).unique();

        if (entity==null) return null;

        long timestamp = entity.timestamp;
        long expireTime = entity.expireTime;
        T result = null;

        if (expireTime<0) { // 快取的資料從不過期

            String json = entity.data;

            result = converter.fromJson(json,type);
        } else {

            if (timestamp + expireTime > System.currentTimeMillis()) {  // 快取的資料還沒有過期

                String json = entity.data;

                result = converter.fromJson(json,type);
            } else {        // 快取的資料已經過期

                evict(key);
            }
        }

        return result != null ? new Record<>(Source.PERSISTENCE, key, result, timestamp, expireTime) : null;
    }

    @Override
    public <T> void save(String key, T value) {

        save(key,value, Constant.NEVER_EXPIRE);
    }

    @Override
    public <T> void save(String key, T value, long expireTime) {

        if (Preconditions.isNotBlanks(key,value)) {

            CacheEntity entity = new CacheEntity();
            entity.setKey(key);
            entity.setTimestamp(System.currentTimeMillis());
            entity.setExpireTime(expireTime);
            entity.setData(converter.toJson(value));
            dao.save(entity);
        }
    }

    @Override
    public List<String> allKeys() {

        List<CacheEntity> list = dao.loadAll();

        List<String> result = new ArrayList<>();

        for (CacheEntity entity:list) {

            result.add(entity.key);
        }

        return result;
    }

    @Override
    public boolean containsKey(String key) {

        List<String> keys = allKeys();

        return Preconditions.isNotBlank(keys) ? keys.contains(key) : false;
    }

    @Override
    public void evict(String key) {

        CacheEntity entity = dao.queryBuilder().where(CacheEntityDao.Properties.Key.eq(key)).unique();

        if (entity!=null) {

            dao.delete(entity);
        }

    }

    @Override
    public void evictAll() {

        dao.deleteAll();
    }
}
複製程式碼

2.2 整合 Room

Room 是 Google 開發的一個 SQLite 物件對映庫。使用它來避免樣板程式碼並輕鬆地將 SQLite 資料轉換為 Java 物件。 Room 提供 SQLite 語句的編譯時檢查，可以返回 RxJava 和 LiveData Observable。

同樣，需要先建立一個 CacheEntity，但是不能共用之前的 CacheEntity。因為 Room、greenDAO 使用的 @Entity不同。

@Entity
public class CacheEntity {

    @PrimaryKey(autoGenerate = true)
    private Long id;

    public String key;

    public String data;// 物件轉換的 json 字串

    public Long timestamp;

    public Long expireTime;

    ...... // getter 、setter
}
複製程式碼

建立一個 CacheEntityDao 用於 crud 的實現。

import java.util.List;

import androidx.room.Dao;
import androidx.room.Delete;
import androidx.room.Insert;
import androidx.room.Query;

import static androidx.room.OnConflictStrategy.IGNORE;

/**
 * @FileName: com.safframework.rxcache4a.persistence.db.room.CacheEntityDao
 * @author: Tony Shen
 * @date: 2018-10-15 16:44
 * @version: V1.0 <描述當前版本功能>
 */
@Dao
public interface CacheEntityDao {

    @Query("SELECT * FROM cacheentity")
    List<CacheEntity> getAll();

    @Query("SELECT * FROM cacheentity WHERE `key` = :key LIMIT 0,1")
    CacheEntity findByKey(String key);

    @Insert(onConflict = IGNORE)
    void insert(CacheEntity entity);

    @Delete
    void delete(CacheEntity entity);

    @Query("DELETE FROM cacheentity")
    void deleteAll();
}
複製程式碼

建立一個 AppDatabase 表示一個資料庫的持有者。

import androidx.room.Database;
import androidx.room.RoomDatabase;

/**
 * @FileName: com.safframework.rxcache4a.persistence.db.room.AppDatabase
 * @author: Tony Shen
 * @date: 2018-10-15 16:40
 * @version: V1.0 <描述當前版本功能>
 */
@Database(entities = {CacheEntity.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {

    public abstract CacheEntityDao cacheEntityDao();
}
複製程式碼

最後，建立 RoomImpl 實現 DB 介面，實現真正的快取邏輯。

import android.content.Context;

import com.safframework.rxcache.config.Constant;
import com.safframework.rxcache.domain.Record;
import com.safframework.rxcache.domain.Source;
import com.safframework.rxcache.persistence.converter.Converter;
import com.safframework.rxcache.persistence.converter.GsonConverter;
import com.safframework.rxcache.persistence.db.DB;
import com.safframework.tony.common.utils.Preconditions;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;

import androidx.room.Room;

/**
 * @FileName: com.safframework.rxcache4a.persistence.db.room.RoomImpl
 * @author: Tony Shen
 * @date: 2018-10-15 16:46
 * @version: V1.0 <描述當前版本功能>
 */
public class RoomImpl implements DB {

    private AppDatabase db;
    private Converter converter;
    private static final String DB_NAME = "cache";

    public RoomImpl(Context context) {

        this(context,new GsonConverter());
    }

    public RoomImpl(Context context, Converter converter) {

        this.db = Room.databaseBuilder(context, AppDatabase.class, DB_NAME).build();
        this.converter = converter;
    }

    @Override
    public <T> Record<T> retrieve(String key, Type type) {

        CacheEntity entity = db.cacheEntityDao().findByKey(key);

        if (entity==null) return null;

        long timestamp = entity.timestamp;
        long expireTime = entity.expireTime;
        T result = null;

        if (expireTime<0) { // 快取的資料從不過期

            String json = entity.data;

            result = converter.fromJson(json,type);
        } else {

            if (timestamp + expireTime > System.currentTimeMillis()) {  // 快取的資料還沒有過期

                String json = entity.data;

                result = converter.fromJson(json,type);
            } else {        // 快取的資料已經過期

                evict(key);
            }
        }

        return result != null ? new Record<>(Source.PERSISTENCE, key, result, timestamp, expireTime) : null;
    }

    @Override
    public <T> void save(String key, T value) {

        save(key,value, Constant.NEVER_EXPIRE);
    }

    @Override
    public <T> void save(String key, T value, long expireTime) {

        if (Preconditions.isNotBlanks(key,value)) {

            CacheEntity entity = new CacheEntity();
            entity.setKey(key);
            entity.setTimestamp(System.currentTimeMillis());
            entity.setExpireTime(expireTime);
            entity.setData(converter.toJson(value));
            db.cacheEntityDao().insert(entity);
        }
    }

    @Override
    public List<String> allKeys() {

        List<CacheEntity> list = db.cacheEntityDao().getAll();

        List<String> result = new ArrayList<>();

        for (CacheEntity entity:list) {

            result.add(entity.key);
        }

        return result;
    }

    @Override
    public boolean containsKey(String key) {

        List<String> keys = allKeys();

        return Preconditions.isNotBlank(keys) ? keys.contains(key) : false;
    }

    @Override
    public void evict(String key) {

        CacheEntity entity = db.cacheEntityDao().findByKey(key);

        if (entity!=null) {

            db.cacheEntityDao().delete(entity);
        }
    }

    @Override
    public void evictAll() {

        db.cacheEntityDao().deleteAll();
    }
}
複製程式碼

這兩種整合方式，都使用 CacheEntity 的 data 來儲存物件轉換後的 json 字串。使用這種方式，可以替換成任何的持久層框架。使得 DB 也可以成為 RxCache 的其中一級快取。

三. 使用

編寫單元測試，看一下整合 greenDAO 的效果。

分別測試多種物件的儲存、帶 ExpireTime 的儲存。

import android.content.Context;
import android.support.test.InstrumentationRegistry;
import android.support.test.runner.AndroidJUnit4;

import com.safframework.rxcache.RxCache;
import com.safframework.rxcache.domain.Record;
import com.safframework.rxcache4a.persistence.db.greendao.CacheEntityDao;
import com.safframework.rxcache4a.persistence.db.greendao.DBService;
import com.safframework.rxcache4a.persistence.db.greendao.GreenDAOImpl;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

/**
 * @FileName: com.safframework.rxcache4a.GreenDAOImplTest
 * @author: Tony Shen
 * @date: 2018-10-15 18:51
 * @version: V1.0 <描述當前版本功能>
 */
@RunWith(AndroidJUnit4.class)
public class GreenDAOImplTest {

    Context appContext;
    DBService dbService;

    @Before
    public void setUp() {
        appContext = InstrumentationRegistry.getTargetContext();
        dbService = DBService.getInstance(appContext);
    }

    @Test
    public void testWithObject() {

        CacheEntityDao dao = dbService.getCacheEntityDao();
        GreenDAOImpl impl = new GreenDAOImpl(dao);
        impl.evictAll();

        RxCache.config(new RxCache.Builder().persistence(impl));

        RxCache rxCache = RxCache.getRxCache();

        Address address = new Address();
        address.province = "Jiangsu";
        address.city = "Suzhou";
        address.area = "Gusu";
        address.street = "ren ming road";

        User u = new User();
        u.name = "tony";
        u.password = "123456";
        u.address = address;

        rxCache.save("user",u);

        Record<User> record = rxCache.get("user", User.class);

        assertEquals(u.name, record.getData().name);
        assertEquals(u.password, record.getData().password);
        assertEquals(address.city, record.getData().address.city);

        rxCache.save("address",address);

        Record<Address> record2 = rxCache.get("address", Address.class);
        assertEquals(address.city, record2.getData().city);
    }

    @Test
    public void testWithExpireTime() {

        CacheEntityDao dao = dbService.getCacheEntityDao();
        GreenDAOImpl impl = new GreenDAOImpl(dao);
        impl.evictAll();

        RxCache.config(new RxCache.Builder().persistence(impl));

        RxCache rxCache = RxCache.getRxCache();

        User u = new User();
        u.name = "tony";
        u.password = "123456";
        rxCache.save("test",u,2000);

        try {
            Thread.sleep(2500);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        Record<User> record = rxCache.get("test", User.class);

        assertNull(record);
    }
}
複製程式碼

兩個 test case 都順利通過，表示整合 greenDAO 沒有問題。當然，整合 Room 也是一樣。

四. 總結

我單獨建立了一個專案 RxCache4a 用於整合的 greenDAO、Room 等。

Github 地址: github.com/fengzhizi71…

未來，可能對框架增加一些 Annotation，以及增加 Cache 清除的演算法。

RxCache 系列的相關文章：

Java與Android技術棧：每週更新推送原創技術文章，歡迎掃描下方的公眾號二維碼並關注，期待與您的共同成長和進步。

MVVM的資料持久化（一）——ROOM的整合
2018-11-07
MVVM持久化OOM
Spring 持久層整合
2020-10-30
Spring
河青的持久層框架hqbatis
2020-06-09
框架BAT
Android資料庫框架——GreenDao初探
2017-04-27
Android資料庫框架
Java 持久層框架之 MyBatis
2020-12-22
Java框架MyBatis
MyBatis--優秀的持久層框架
2018-07-16
MyBatis框架
ORM框架之GreenDao3.0整合與註解(一)
2019-02-27
ORM框架
Java持久層框架Mybatis入門
2021-06-19
Java框架MyBatis
Android ORM 框架：GreenDao 資料庫升級
2017-07-04
AndroidORM框架資料庫
Android ORM 框架 greenDAO 使用經驗總結
2015-07-29
AndroidORM框架
Android ORM 框架：GreenDao 使用詳解（基礎篇）
2017-07-03
AndroidORM框架
Android ORM 框架：GreenDao 使用詳解（進階篇）
2017-07-03
AndroidORM框架
MVVM的資料持久化（二）——ROOM的使用
2018-11-07
MVVM持久化OOM
自己動手寫一個持久層框架
2020-11-10
框架
使用Room持久庫儲存資料
2017-12-14
OOM
SpringBoot2 基礎案例(09)：整合JPA持久層框架，簡化資料庫操作
2020-01-01
Spring Boot框架資料庫
Room-資料持久化儲存(入門)
2021-06-28
OOM持久化
Room ORM 資料庫框架
2017-05-18
OOMORM資料庫框架
Android架構元件Room的使用
2017-12-26
Android架構元件OOM
AutoCRUD - PHP 下的透明持久層
2008-01-03
PHP
Java資料持久層
2021-03-09
Java
ORM框架之GreenDao3.0使用詳解(二)
2019-02-13
ORM框架
SpringBoot整合任務排程框架Quartz及持久化配置
2020-12-27
Spring Boot框架quartz持久化
Android Room 之儲存 Objects 中的 List
2019-03-06
AndroidOOMObject
Android開源資料庫 GreenDao實踐
2017-12-26
Android資料庫
Jenkins持久化整合使用
2015-03-06
Jenkins持久化
Android O 遷移測試：Room
2017-08-30
AndroidOOM
閉關修煉180天--手寫持久層框架（mybatis簡易版）
2020-12-23
框架MyBatis
Android HAL 層框架分析以及程式碼示例
2019-02-22
Android框架
GreenDao的使用簡介
2017-11-15
第三方資料庫框架 - GreenDao簡介
2018-04-12
資料庫框架
Android資料儲存之GreenDao 3.0 詳解
2016-07-08
Android
SSM框架的整合
2019-06-22
SSM框架
Android Architecture Components 之 Room 篇
2019-03-04
AndroidOOM
Android Room2.0之@TypeConverters使用
2018-11-13
AndroidOOM
Android Architecture Components Part1:Room
2018-06-13
AndroidOOM
持久層Mybatis3底層原始碼分析，原理解析
2019-03-26
MyBatisS3原始碼
android 開源資料層框架。解放資料吧。
2017-09-28
Android框架