Android本地存储工具Reservoir替代SharedPreferences

SharedPreferences使用起来有些局限，以及它调用比较复杂，并且只支持基本数据类型和String的存储，不支持自定义对象存储。记得以前有次为了不使用SQLite整个项目又只为了存储一个对象，我只得把对象转成JsonString，再把JsonString作为字符串存入SharedPreferences。

后来接触到Reservoir后用它进行本地存储轻量级的数据，一直使用至今。Reservoir是使用DiskLruCache建立磁盘缓存进行存储，当应用卸载时，缓存也会被系统清除。DiskLruCache也是开发者常用的图片缓存技术之一。

GitHub地址：
https://github.com/anupcowkur/Reservoir
gradle链接：
implementation 'com.anupcowkur:reservoir:3.1.0'

开始Reservoir食用

在项目的build.gradle中添加

buildscript {
    ...
    repositories {
        jcenter()
    }
    ...
}

在app的build.gradle中添加依赖

dependencies {
    ...
    // 本地存储替代shareprefer
    implementation 'com.anupcowkur:reservoir:3.1.0'
    ...
}

此时已经完成Reservoir的所有导入步骤。

在项目中使用时需要先给Reservoir开辟内存空间做初始化，单位：bytes。
例子中我在Activity的onCreate()中进行了初始化，当然它也可以在Application中的onCreate()或是Fragment里初始化，关键是要获得到Context即可。

class TestActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // 初始化
        Reservoir.init(this, 2048)
    }
}

建立自己的Reservoir管理类，如下代码演示了一个String、自定义对象、以及List的存储方式，其余类型就不一一举例，毕竟存储对象和List才是关键。

object ReservoirHelper {
    ...
    // 所在城市
    fun setCity(city: String) {
        Reservoir.put("city", city)
    }

    fun getCity(): String {
        if (Reservoir.contains("city"))
            return Reservoir.get("city", String::class.java)
        else
            return "北京市"
    }

    // 天气数据
    fun setWeatherFreeInfo(weatherFreeInfo: WeatherFreeInfo) {
        Reservoir.put("weatherFreeInfo", weatherFreeInfo)
    }

    fun getWeatherFreeInfo(): WeatherFreeInfo {
        if (Reservoir.contains("weatherFreeInfo"))
            return Reservoir.get("weatherFreeInfo", WeatherFreeInfo::class.java)
        else
            return WeatherFreeInfo()
    }

    // 房间数据
    fun setRoomList(roomList: List) {
        Reservoir.put("roomList", roomList)
    }

    fun getRoomList(): List {
        if (Reservoir.contains("roomList"))
            return Reservoir.get("roomList", object : TypeToken>() {}.type)
        else
            return ArrayList()
    }
    ...
}

接下来我们就可以调用管理类进行数据存储，此处只举例了List的存取

        val roomList = ArrayList()
        val r1 = Room()
        val r2 = Room()
        val r3 = Room()
        roomList.add(r1)
        roomList.add(r2)
        roomList.add(r3)
        // 进行存储
        ReservoirHelper.setRoomList(room)

        // 进行读取
        val roomList = ReservoirHelper.getRoomList()
        Log.d(TAG, "-->> 第二个房间温度是${roomList[1].temperature}℃")

只要封装得当，即可在项目低耦合的引用到它。它可以出现在任何地方，任何地方，任何地方（重要的事情说三遍），任何一个独立的Java类都可以进行存取操作。

Reservoir常用方法

UI线程存取方法：

        // 存
        Reservoir.put("myKey", myObject)
        // 取
        Reservoir.get("myKey", MyClass.class)

异步存取方法：

        Reservoir.putAsync("myKey", myObject, object : ReservoirPutCallback {
            override fun onSuccess() {
                //success
            }

            override fun onFailure(e: Exception) {
                //error
            }
        })

        Reservoir.getAsync("myKey", MyClass::class.java, object : ReservoirGetCallback {
            override fun onSuccess(myObject: MyClass) {
                //success
            }

            override fun onFailure(e: Exception) {
                //error
            }
        })

检查是否存在：

        val isExists = Reservoir.contains("myKey")

删除：

        // UI线程执行删除
        Reservoir.delete("myKey")

        // 异步删除
        Reservoir.deleteAsync("myKey", object : ReservoirDeleteCallback {
            fun onSuccess(myObject: MyClass) {
                //success
            }

            override fun onFailure(e: Exception) {
                //error
            }
        })

清空Reservoir的缓存：

        Reservoir.clear()

        Reservoir.clearAsync(object : ReservoirClearCallback {
            override fun onSuccess() {
                try {
                    assertEquals(0, Reservoir.bytesUsed())
                } catch (e: Exception) {

                }

            }

            override fun onFailure(e: Exception) {

            }
        })

到此，Reservoir已经食用差不多，需要深度学习与RxJava交互，可以参考开头的GitHub原作者链接进行学习。