About

对象持久化库，方便本地存取对象

• 支持自定义数据格式，默认为Json格式
• 支持自定义底层存储，例如使用腾讯MMKV
• 支持单缓存和多缓存
• 支持LRU算法的缓存个数限制
• 支持缓存分组，例如根据不同账号信息保存缓存

Sample

初始化

CacheConfig.init(
    CacheConfig.Builder()
        // 设置缓存目录(可选参数)，默认为"Context.getFilesDir()/f_cache"
        .setDirectory(getExternalFilesDir("app_cache")!!)

        // 设置异常处理(可选参数)
        .setExceptionHandler(CacheExceptionHandler())

        // 设置对象转换器(可选参数)，默认为Gson转换器
        .setObjectConverter(MoshiObjectConverter())

        // Context
        .build(this)
)

单缓存

单缓存是指一个类只能持久化一个对象，例如TestModel类，只能存一个该类的实例到本地，常用于保存App配置信息等。
注意：库内部采用类的全类名做为缓存的key，所以修改类的名称或者包名后缓存会失效。

// 获取TestModel类对应的单缓存管理对象
val singleCache = FCache.getDefault().single(TestModel::class.java)

// 放入缓存对象
singleCache.put(TestModel())

// 获取缓存对象
singleCache.get()

// 移除缓存对象
singleCache.remove()

// 是否有缓存对象
singleCache.contains()

多缓存

多缓存是指一个类可以持久化多个对象，例如TestModel类，可以根据key保存多个该类的实例到本地，常用于缓存具有唯一ID的对象，可以把唯一ID当作key。
注意：库内部采用类的全类名计算缓存的key，所以修改类的名称或者包名后缓存会失效。

// 获取TestModel类对应的多缓存管理对象
val multiCache = FCache.getDefault().multi(TestModel::class.java)

// 根据key保存多个实例
multiCache.put("1", TestModel())
multiCache.put("2", TestModel())
multiCache.put("3", TestModel())

// 根据key获取缓存
multiCache.get("1")

// 根据key移除缓存
multiCache.remove("1")

// 是否有key对应的缓存
multiCache.contains("1")

缓存分组

缓存支持分组，分为DefaultGroup(默认组)和ActiveGroup(激活组)。

DefaultGroup(默认组)

DefaultGroup一直处于可用状态，常用于保存公用的配置信息或者缓存，即各个用户账号共享的信息。

// DefaultGroup，无限制大小的缓存
val cache = FCache.getDefault()

// DefaultGroup，id为"1"的无限制大小缓存
val cache1 = FCache.defaultGroupFactory().unlimited("1")

// DefaultGroup，id为"2"的限制个数的缓存
val cache2 = FCache.defaultGroupFactory().limitCount("2", 100)

ActiveGroup(激活组)

ActiveGroup默认为空，常用于保存当前用户自己的配置信息，当用户切换的时候，可以通过FCache.setActiveGroup("用户ID")方法把用户ID设置为激活组。
注意：如果ActiveGroup为空的情况下，通过FCache.activeGroupFactory()创建的缓存对象调用相关Api都会失败。

// ActiveGroup，无限制大小的缓存
val cache = FCache.getActive()

// ActiveGroup，id为"1"的无限制大小缓存
val cache1 = FCache.activeGroupFactory().unlimited("1")

// ActiveGroup，id为"2"的限制个数的缓存
val cache2 = FCache.activeGroupFactory().limitCount("2", 100)

自定义数据格式

默认情况下，采用Json数据格式存储，默认实现类：GsonObjectConverter
可以实现Cache.ObjectConverter接口，自定义数据格式，例如使用moshi的实现：MoshiObjectConverter

自定义底层存储

默认情况下，底层采用文件流存取数据，默认实现类：FileCacheStore
可以实现CacheStore接口，自定义底层数据如何存储，例如使用MMKV的实现：MMKVCacheStore