pphdsny / cache

灵活的缓存实现，支持内存、网络、本地、资源、自定义，支持不同的缓存策略。

前言

某天，做搜索的时候，期望筛选条件的配置文件能缓存起来，不要每次都从网络获取，减少异常的发生。于是乎刷刷的开始写大量的判断逻辑if/else，做了个三级缓存，从内存、网络、本地读取数据，写完了测试也通过了，非常完美！！！

突然说要加个本地资源（asset）缓存，没问题，又加了段if/else...

哪天缓存的顺序又期望改成"网络->内存->本地->资源文件"，好...改...

后来某个需求也想用缓存，但没有本地和资源文件缓存，难道又得重新来一遍，瞬间GG...

我们是不是该理一理，顺一顺，构建个灵活的缓存机制！

理一理需求

• 需要缓存
• 需要多级缓存
• 需要缓存策略可变
• 需要可以自定义缓存
• 需要使用时候简单便捷

顺一顺实现

##简要说明

• 设计思路是工厂模式和责任链模式的结合
• 基于RxJava的数据流
• ICahce定义了一个getData请求方法，自定义缓存策略可以实现
• 请求参数有ICacheParams（是否开启各级别缓存、业务参数等）
• 默认实现了内存、网络、本地、资源Asset的缓存
  • 内存缓存利用LruCache
  • 网络缓存利用eTag
  • 本地缓存利用SP存储
  • 资源Asset缓存利用本地文件
• 通过ICacheStrategy进行缓存策略组装，基于RxJava的error捕获，将处理转到一下个cache中进行处理
  • 默认读取策略是按序处理数据
  • 默认保存策略是全部更新

核心代码

ECache

/**
 * Created by wangpeng on 2018/7/9.
 * Cache中用到的一些key
 */
public interface ECache {

    String TAG = "Lib-Cache";

    //map中cache的key
    String CACHE_KEY = "cache_key";
    //map中内存cache的key，如没有设置会以CACHE_KEY作为key
    String MEMORY_KEY = "memory_key";
    //map中本地cache的key，如没有设置会以CACHE_KEY作为key
    String LOCAL_KEY = "local_key";
    //map中资源cache的key，如没有设置会以CACHE_KEY作为key
    String ASSET_KEY = "asset_key";
    //Context对象
    String CONTEXT_KEY = "context_key";
}

ICache

/**
 * Created by wangpeng on 2018/6/28.
 * 全局cache的协议
 */
public interface ICache<T> {

    Observable<T> getData(ICacheParams<T> cacheParams);

    void saveData(ICacheParams<T> cacheParams,T t);
}

ICacheParams

/**
 * Created by wangpeng on 2018/6/29.
 * 定义cache请求需要参数
 */
public interface ICacheParams<T> {

    /**
     * 缓存带参
     *
     * @return
     */
    Map<String, Object> getParams();

    /**
     * 获取缓存需实例化的类
     *
     * @return
     */
    Class<T> getDataClass();

    /**
     * 设置缓存时间，单位是ms
     *
     * @return
     */
    long getExpityTime();
}

ICacheStrategy

/**
 * Created by wangpeng on 2018/7/9.
 * 缓存策略
 */
public interface ICacheStrategy<T> {

    Observable<T> getDataStrategy(ICacheParams<T> cacheParams);

    void saveDataStrategy(ICacheParams<T> cacheParams,T t);

}

CacheFactory

/**
 * Created by wangpeng on 2018/6/28.
 * Cache工厂类，获取Cache数据
 * Cache的执行顺序可以自由控制
 */
public class CacheFactory<T> {

    private ICacheStrategy<T> cacheStrategy;

    public CacheFactory(ICache<T>... cacheArr) {
        this.cacheStrategy = new DefaultCacheStrategy<>(cacheArr);
    }

    public CacheFactory(ICacheStrategy<T> cacheStrategy) {
        this.cacheStrategy = cacheStrategy;
    }

    public Observable<T> getData(ICacheParams<T> cacheParams) {
        return cacheStrategy.getDataStrategy(cacheParams);
    }

    public void saveData(ICacheParams<T> cacheParams, T t) {
        cacheStrategy.saveDataStrategy(cacheParams, t);
    }
}

应用场景

• 一些配置文件的缓存
• 可以结合网络请求，一键缓存业务数据

如何用

Gradle依赖

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

dependencies {
    implementation 'com.github.pphdsny:cache:1.0.2'
    implementation 'io.reactivex:rxjava:1.2.2'
    implementation 'com.google.code.gson:gson:2.6.2'
}

使用

        CacheFactory cacheFactory = new CacheFactory(new DefaultCacheStrategy(
                new MemoryCache(),
                new LocalCache(),
                new AssetCache()
        ));
        //获取数据
        cacheFactory.getData(cacheParams);
        //缓存数据
        cacheFactory.saveData(cacheParams,dataObject);

更多用法详见demo

其他

如果你正好要做缓存，也是使用RxJava，这个方案可供参考。欢迎拍砖。

源码地址：https://github.com/pphdsny/cache/