Kotlin委托属性-简化数据访问
一、概述
Kotlin有很多语法糖,最近看了委托属性, 用于改造笔者的开源组件LightKV, 确实提高了不少易用性。
关于LightKV,笔者在上一篇文章《LightKV-高性能key-value存储组件》中有介绍其原理,有兴趣的读者可以了解一下。
LightKV的用法和SharePreferences类似,都是key-value结构,通过指定key读写value。
key-value 的 API 适用于存储统计,缓存,配置......等各种信息,
随着APP的迭代,必然会有越来越多的信息需要存储,对应用开发而言,key-value的存储不可或缺。
笔者上一篇文章中,有热心网友提到:“想法很好,不过感觉用处不大,如果要存的数据很少那就sp …… ”
诚然,SDK已经提供了SharePreferences了,而且当用SharePreferences还没遇到性能瓶颈时,也就没有尝试别的组件的的动力了。
而且,之前的那一版,只做到了“高效”,没有做到“易用”。
二、旧版用法
public class AppData { private static final SyncKV DATA = new LightKV.Builder(GlobalConfig.getAppContext(), "app_data") .logger(AppLogger.getInstance()) .executor(AsyncTask.THREAD_POOL_EXECUTOR) .keys(Keys.class) .encoder(new ConfuseEncoder()) .sync(); // keys define public interface Keys { int SHOW_COUNT = 1 | DataType.INT; int ACCOUNT = 2 | DataType.STRING ; int TOKEN = 3 | DataType.STRING; int SECRET = 4 | DataType.ARRAY | DataType.ENCODE; } public static SyncKV data() { return DATA; } public static String getString(int key) { return DATA.getString(key); } public static void putString(int key, String value) { DATA.putString(key, value); DATA.commit(); } public static byte[] getArray(int key) { return DATA.getArray(key); } public static void putArray(int key, byte[] value) { DATA.putArray(key, value); DATA.commit(); } // ...... }
val account = AppData.getString(AppData.Keys.ACCOUNT) if(TextUtils.isEmpty(account)){ AppData.putString(AppData.Keys.ACCOUNT, "foo@gmail.com") }
该用法的复杂度在于:
如果想用静态方法(调用时简单一些),则每一个数据存储类都需要实现一份各种类型的get和set;
如果直接返回data()来读写, 写起来会比较长:
val account = AppData2.data().getString(Keys.ACCOUNT) if(TextUtils.isEmpty(account)){ AppData2.data().putString(Keys.ACCOUNT, "foo@gmail.com") }
直到后来了解了Kotlin委托, 仿佛看到了曙光……
三、新版用法
object AppData : KVData() { override fun createInstance(): LightKV { return LightKV.Builder(GlobalConfig.appContext, "app_data") .logger(AppLogger) .executor(AsyncTask.THREAD_POOL_EXECUTOR) .encoder(GzipEncoder) .sync() } var showCount by int(1) var account by string(2) var token by string(3) var secret by array(4 or DataType.ENCODE) }
val account = AppData.account if (TextUtils.isEmpty(account)) { AppData.account = "foo@gmail.com" }
使用Kotlin委托,省了各种put和set的方法调用,看起来像是在直接访问AppData的属性。
四、属性委托的实现
4.1 声明属性
语法: val/var <属性名>: <类型> by <表达式>。
class Example { var p: String by Delegate() }
by 后面的表达式是对应的委托, 属性的 get() 和 set() 会被委托给它的 getValue() 和 setValue() 方法。
当然,如果声明的是val, 则不会委托set()方法。
4.2 实现委托
属性的委托,需要提供一个 getValue() 函数和 setValue() 函数(如果声明的是var 的话),并以operator修饰。
class Delegate { operator fun getValue(thisRef: Any?, property: KProperty<*>): String { return "$thisRef, thank you for delegating '${property.name}' to me!" } operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) { println("$value has been assigned to '${property.name}' in $thisRef.") } }
例子中,thisRef 是 Example 的引用, 参数 property 保存了对属性p的描述,例如可以通过property.name获取p的名字.
4.3 访问属性
访问 p 时,将调用 Delegate 中的 getValue() 函数;
给 p 赋值时,将调用 setValue() 函数。
val e = Example() println(e.p) e.p = "NEW"
输出结果:
Example@33a17727, thank you for delegating ‘p’ to me!
NEW has been assigned to ‘p’ in Example@33a17727.
4.4 属性委托的原理
class C { var prop: Type by MyDelegate() }
// 由编译器生成的相应代码: class C { private val prop$delegate = MyDelegate() var prop: Type get() = prop$delegate.getValue(this, this::prop) set(value: Type) = prop$delegate.setValue(this, this::prop, value) }
前后对比,不难看出,其实属性委托的本质是“代理模式”的语法封装。
五、优化LightKV
5.1 定义抽象类
abstract class KVData{ internal var autoCommit = true abstract fun createInstance() : LightKV val data: LightKV by lazy { createInstance() } protected fun boolean(key: Int) = KVProperty<Boolean>(key or DataType.BOOLEAN) protected fun int(key: Int) = KVProperty<Int>(key or DataType.INT) protected fun float(key: Int) = KVProperty<Float>(key or DataType.FLOAT) protected fun double(key: Int) = KVProperty<Double>(key or DataType.DOUBLE) protected fun long(key: Int) = KVProperty<Long>(key or DataType.LONG) protected fun string(key: Int) = KVProperty<String>(key or DataType.STRING) protected fun array(key: Int) = KVProperty<ByteArray>(key or DataType.ARRAY) fun disableAutoCommit(){ autoCommit = false } fun enableAutoCommit(){ autoCommit = true data.commit() } }
该抽象类声明了LightKV, 添加了自动提交开关,以及定了个各种类型委托。
5.2 实现委托
为方便编写委托, Kotlin标准库定义了的ReadWriteProperty接口:
interface ReadWriteProperty<in R, T> { operator fun getValue(thisRef: R, property: KProperty<*>): T operator fun setValue(thisRef: R, property: KProperty<*>, value: T) }
使用时实现接口的方法即可。
为了统一定义各个类型委托,我们在构造函数传入key, 由key决定对应的类型操作。
通过thisRef.data(LightKV)和 key, 分别在getValue和setValue方法中实现取值和赋值。
class KVProperty<T>(private val key: Int) : ReadWriteProperty<KVData, T> { @Suppress("UNCHECKED_CAST", "IMPLICIT_CAST_TO_ANY") override operator fun getValue(thisRef: KVData, property: KProperty<*>): T = with(thisRef.data) { return when (key and DataType.MASK) { DataType.BOOLEAN -> getBoolean(key) DataType.INT -> getInt(key) DataType.FLOAT -> getFloat(key) DataType.LONG -> getLong(key) DataType.DOUBLE -> getDouble(key) DataType.STRING -> getString(key) DataType.ARRAY -> getArray(key) else -> throw IllegalArgumentException("Invalid Key: $key") } as T } override operator fun setValue(thisRef: KVData, property: KProperty<*>, value: T) = with(thisRef.data) { when (key and DataType.MASK) { DataType.BOOLEAN -> putBoolean(key, value as Boolean) DataType.INT -> putInt(key, value as Int) DataType.FLOAT -> putFloat(key, value as Float) DataType.LONG -> putLong(key, value as Long) DataType.DOUBLE -> putDouble(key, value as Double) DataType.STRING -> putString(key, value as String) DataType.ARRAY -> putArray(key, value as ByteArray) else -> throw IllegalArgumentException("Invalid Key: $key") } if(mMode == LightKV.SYNC_MODE && thisRef.autoCommit){ commit() } } }
在LightKV为SYNC_MODE时自动commit()。
当然,如果需要批量提交。可以调用disableAutoCommit()禁用自动提交。
最后,在使用时,继承KVData,声明属性,即可像访问变量一样读写LightKV的数据(参见第三节)。
六、下载
repositories { jcenter() } dependencies { implementation 'com.horizon.lightkv:lightkv:1.0.4' }
项目地址:
https://github.com/No89757/LightKV
七、结语
以前笔者对语法糖是不感兴趣的,觉得语法糖掩盖了细节,容易使人“只知其然而不知其所以然”;
但是后来渐渐地也开始接受了,技术的发展日新月异,不可能什么都从底层开始构筑。
业界流传有“人生苦短,我用python”,说的就是高级语言所带来的便利,可以节约不少时间。
当然,C语言,汇编语言,还是需要有人去写,要看问题领域。
对APP开发而言,诚然有大量的“搬砖”工作,砖头搬累了,来一发语法糖,也是不错的。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
LightKV-高性能key-value存储组件
LightKV是基于Java NIO的轻量级,高性能,高可靠的key-value存储组件。 一、起源 Android平台常见的本地存储方式, SDK内置的有SQLite,SharedPreference等,开源组件有ACache, DiskLruCahce等,有各自的特点和适用性。SharedPreference以其天然的 key-value API,二级存储(内存HashMap, 磁盘xml文件)等特点,为广大开发者所青睐。然而,任何工具都是有适用性的,参见文章《不要滥用SharedPreference》。当然,其中一些缺点是其定位决定的,比如说不适合存储大的key-value, 这个无可厚非;不过有一些地方可以改进,比如存储格式:xml解析速度慢,空间占用大,特殊字符需要转义等特点,对于高频变化的存储,实非良策。故此,有必要写一个改良版的key-value存储组件。 二、LightKV原理 2.1、存储格式 我们希望文件可以流式解析,对于简单key-value形式,完全可以自定义格式。例如,简单地依次保存key-value就好:key|value|key|value|key|val...
- 下一篇
Android轻量级事件通信方案
开发过程中,总会遇到一些需要通信的场景。如果逻辑比较简单,通过常规的传参,回调,返回值等即可实现。而如果调用层次较深(如跨模块,跨线程等),光靠传参和回调等手段,耦合度较高,对于需要主动通知,通知多个组件等场景,更是捉襟见肘。为解耦事件的发布与订阅主体,简化组件间通信,可引入事件通信机制。 事件通知包含哪些内容?事件的定义,注册/注销,通知。事件框架如何实现?一个接口,一个事件管理类,足矣。代码不足50行,名副其实的“轻量级”。 方案实现 定义接口 interface Observer { fun onEvent(event: Int, vararg args : Any?) fun listEvents(): IntArray } 接口定义了两个方法:listEvents: 返回关注的事件;onEvent: 发生事件时回调此接口并返回事件和参数(可缺省)。 事件管理 object EventManager { private val HANDLER = Handler(Looper.getMainLooper()) private val OBSERVER_ARRAY = Spars...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS关闭SELinux安全模块
- SpringBoot2编写第一个Controller,响应你的http请求并返回结果
- Mario游戏-低调大师作品
- CentOS6,CentOS7官方镜像安装Oracle11G
- SpringBoot2配置默认Tomcat设置,开启更多高级功能
- Windows10,CentOS7,CentOS8安装Nodejs环境
- Docker安装Oracle12C,快速搭建Oracle学习环境
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- CentOS8编译安装MySQL8.0.19
- MySQL8.0.19开启GTID主从同步CentOS8