官方core-ktx库能对SparseArray系列、Pair开发带来哪些便利?

本文是研究官方core-ktx库的第三篇文章,旨在探究该库中有哪些工具类或方法能够提高我们的开发效率。

前两篇文章的参考链接如下:

你需要了解的官方core-ktx库能对开发带来哪些便利1

官方core-ktx库能对富文本Span开发带来哪些便利?

本篇文章主要是研究core-ktx库对SparseArray系列和Pair开发能代码哪些便利!!

SparseArray系列

SparseArrayLongSparseArray系列就是一种支持key-value数据结构形式读写的封装类,相比较于HashMap的有点有两个:

image.png

  1. 键值key是一个基本数据类型,而不是一个基本数据类型对应的封装类,不需要装箱
  2. 它的数据结构是键值key一个数组,value值一个数组,不像HashMap,基于Entrykey-value进行封装再进行读写

PS:Android中还存在另一系列集合SparseIntArraySparseBooleanArraySparseLongArray,这些集合更厉害,key和value都是基本数据类型,不需要装箱,不要和上面的集合搞混了。不过这两种集合core-ktx提供的扩展封装都几乎相同,就不单独进行一一阐述了。

  1. SparseArray<T>.size()获取集合大小

    image.png

    这个没什么新奇,就是对SparseArray原来获取大小的方式size()进行了一层封装,借助于kotlin的语法糖,可以当成属性的形式调用(本质上还是调用的方法):

    private fun test5() {
        val sparseArray: SparseArray<String> = SparseArray<String>()
        val size = sparseArray.size
    }
    复制代码
  2. SparseArray<T>.contains(key: Int)判断包含指定key

    image.png

    可以看到这个方法使用了operator修饰,是一个运算符重载方法,重载了运算符in,使用如下:

    @RequiresApi(Build.VERSION_CODES.R)
    private fun test5() {
        val sparseArray: SparseArray<String> = SparseArray<String>()
        val isContain = 5 in sparseArray
    }
    复制代码

    不过这个api要求SDK>=30才能使用,我们可以直接将源码copy到项目工具类库中使用即可。

  3. SparseArray<T>.plus(other: SparseArray<T>)并合并两个集合为一个新集合

    image.png

    这也是一个运算符重载函数,重载了运算符+,项目中可以这样使用:

    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        val sparseArray2: SparseArray<String> = SparseArray<String>()
        val newArray = sparseArray1 + sparseArray2
    }
    复制代码
  4. SparseArray<T>.containsValue(value: T)判断是否存在指定value

    image.png

    这个和上面的contains方法类似,不过这个是判断某个value值是否在该集合中,同样也是重载了运算符in

  5. SparseArray<T>.set(key: Int, value: T)写入数据

    image.png

    重载了运算符[]的函数,可以这样向集合中写入数据:

    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        sparseArray1[10] = ""
    }
    复制代码
  6. SparseArray<T>.getOrDefault(key: Int, defaultValue: T)带默认值的读值

    image.png

    这个方法和HashMapgetOrDefault()类似,当获取的值为null时,就返回默认值:

    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        sparseArray1.getOrDefault(10, "null")
    }
    复制代码
  7. SparseArray<T>.getOrElse(key: Int, defaultValue: () -> T)带默认函数类型返回值的读值

    image.png

    这个和上面的getOrDefault()比较像,只不过提供默认值的不再是一个固定的具体类型的值,而是一个灵活的函数类型,我们可以在这个函数类型中进行额外的逻辑编写:

    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        sparseArray1.getOrElse(10) {
            val tmp = "哈哈哈${sparseArray1.size}"
            tmp
        }
    } 
    复制代码
  8. SparseArray<T>.isEmpty()判断集合是否为空的

    image.png

  9. SparseArray<T>.remove(key: Int, value: T)移除指定key-value

    image.png

  10. SparseArray<T>.forEach(action: (key: Int, value: T) -> Unit)遍历

    image.png

    使用:

    
    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        sparseArray1.forEach { key, value ->
            //执行操作
        }
    }
    复制代码
  11. SparseArray<T>.keyIterator()遍历键值key

    image.png

    这个方法会返回一个迭代器,这样我们就可以使用for in来遍历键值key了:

    private fun test5() {
        val sparseArray1: SparseArray<String> = SparseArray<String>()
        for (key in sparseArray1.keyIterator()) {
            //执行操作
        }
    }
    复制代码

    自定义迭代器就可以帮助我们实现通过for in关键字遍历,具体的可以参考我之前写的一篇文章:你需要懂的Kotlin开发技巧之八#运算符重载for in

  12. SparseArray<T>.valueIterator()遍历value

    image.png

    使用起来和上面的keyIterator()方法类似。

Pair<F, S>系列

  1. componentX()解构

    image.png

    这也是一个operator修饰的运算符重载函数,关于这个解构,我不太该怎么去用语言来描述,大家直接看下使用吧:

    private fun test6() {
        val pair = Pair(10, "ha")
        val (key, value) = pair
    }
    复制代码

    就是可以直接将这个对象的内部属性赋值给局部声明的变量,如果你只使用key或value,可以将不想要解构的属性使用_代替: val (key , _) = pair //只使用key

    这个结构的扩展方法是专门给Java(包括android和androidX包下的)的Pair对象提供的,而Kotlin自己实现的Pair是不需要的,因为其声明的Pair对象就是一个data class,而data class会默认给我们生成解构的方法:

    image.png

    反编译成java代码就可以看到生成的componentX()系列方法。

  2. javakotlinPair相互转换

  • toKotlinPairandroidx包Pair对象转成KotlinPair对象

    image.png

  • toAndroidXPairkotlinPair对象转成androidx包Pair对象

    image.png

  • toKotlinPairandroid包Pair对象转成KotlinPair对象

    image.png

  • toAndroidPairkotlinPair对象转成android包Pair对象

    image.png

总结

详细的源码请自行参考core-ktx包下的SparseArray.ktPair.ktSparseXXXArray.kt等文件源码。接下来就准备研究下core-ktxgraphics包下的关于View操作的一些扩展工具了(好多好多类):

image.png
看下能为我们常见的View开发带来哪些便利,请您敬请期待吧!!

我正在参与掘金技术社区创作者签约计划招募活动,点击链接报名投稿

猜你喜欢

转载自juejin.im/post/7118765812105609230