Kotlin反射全解析3 -- 大展身手的KProperty

2022-04-25 本文已影响0人蜗牛是不是牛

前言

前面我们说了Kotlin的反射就是把类的信息保存到了KClass，通过KClass可以获取类的一些信息

可以查看文章：

但是对于类最关键的属性和方法信息，它是保存在：

//KClass中保存类属性和方法的变量
override val members: Collection<KCallable<*>>

所以我们来看看类中的属性和方法在Kotlin的反射中是如何保存的。

正文

上面我们发现Kotlin把类的属性和方法都定义成了KCallable接口的子类，我们就从这个KCallable开始看起。

KCallable

KCallable是函数和属性的超接口，理解这个还是蛮关键的，我们直接还是看源码：

//Kcallable表示一个可调用的实体，比如函数或者属性
public actual interface KCallable<out R> : KAnnotatedElement {
    
    //这个可调用对象在代码中声明的名称
    public actual val name: String

    //调用这个可调用对象所需要的参数，假如调用这个对象需要this实例或者扩展接收器参数，把这些
    //参数类型放在列表首位
    public val parameters: List<KParameter>

    //这个可调用对象的返回类型
    public val returnType: KType

    //类型参数列表，也就是使用泛型时会用到
    @SinceKotlin("1.1")
    public val typeParameters: List<KTypeParameter>

    //使用指定的参数列表调用这个可调用对象并且返回结果
    public fun call(vararg args: Any?): R

    //访问权限可见性，即public、protected等
    @SinceKotlin("1.1")
    public val visibility: KVisibility?

    //是否是final
    @SinceKotlin("1.1")
    public val isFinal: Boolean

    //是否是open
    @SinceKotlin("1.1")
    public val isOpen: Boolean

    //是否是抽象的
    @SinceKotlin("1.1")
    public val isAbstract: Boolean

    //是否是挂起函数
    @SinceKotlin("1.3")
    public val isSuspend: Boolean
}

这里其实就把一个函数和属性它的公共点给抽离出来，包括属性/方法的可见性、参数、返回值等等，我们这里主要关注的是这个call方法。

call方法

call方法说的是调用这个可调用对象，把参数传递给它，然后便可以调用该实例，返回结果。

其实当Callable是属性的话，就是调用属性的getter函数，当Callable是函数时，也就是调用函数它本身。

我们还是先看个例子：

//定义一个类叫做ChildClass
class ChildClass : ParentClass(){
    //有一个属性
    val childClassValue: Int = 20
    //有一个方法
    fun childClassFunction() {
        println("childClassFunction")
    }
}

根据前面一篇文章我们介绍了KClass，假如我想获取这个childClassValue的话那需要先获取memebers，再进行筛选，其实大可不必，在前面文章我们介绍过 :: 这个叫做成员引用的东西，它的原理其实就是利用反射，以这个例子我们看下面代码：

//能获取ChildClass的childValue这个属性的Callable
val kcallable = ChildClass::childClassValue
//需要一个接收者
val child = ChildClass()
//进行调用
val value = kcallable.call(child)
println("ChildClass value = $value")

这里的 :: 符号就比较神奇了，它可以直接获取该类的属性，而且返回的是一个Callable对象。

这里要注意一点就是调用call的参数，这里kcallable是一个属性，它虽然没有参数，但是它需要一个接收者，具体看IDE的提示：

会发现它的类型叫做KProperty1类型，关于这个我们后面细说。

call方法调用函数

前面我们以ChildClass为例，调用了其属性，也就是调用了其属性的getter方法，那调用函数呢我们继续看一下代码：

//定义一个测试类
class ChildClass : ParentClass(){

    val childClassValue: Int = 20
    //它包含一个方法，只有一个参数
    fun childClassFunction(intValue: Int) {
        println("childClassFunction $intValue")
    }

}

同样我们这里使用 :: 符号来获取这个函数的实例引用，它也就是一个Callable类的实例：

//获取该类该方法的引用
val kcallable = ChildClass::childClassFunction
val child = ChildClass()
//调用
kcallable.call(child,20)

这里也是可以调用成功的，通过call方法可以调用它自己，假如有接收者的话需要传入一个接收者，还是来看一下IDE的提示：

这是一个KFunction2类型的函数。

call方法调用顶层属性

基本说完了定义在类中的属性和方法你需要如何去调用，假如我有个属性它就是顶层属性，比如下面例子：

//定义的顶层属性
var topLevelValue = 10

然后我同样可以通过 :: 成员引用来获取它的Callable实例：

val kcallable = ::topLevelValue
println("value = ${kcallable.call()}")

然后我们看一下这个kcallable的类型，因为调用这个方法不需要接受者：

会发现它是KProperty0类型的。

KProperty

通过上面几个例子我们发现当KCallable是一个属性时，想调用它需要可能需要传递参数，也可能不需要，而且我想调用其setter方法呢，该如何是好，所以Kotlin反射库的重要角色KProperty就登场了。

KProperty就是在反射中的属性，这个属性包含类中的成员属性、顶层属性和扩展属性，我们直接来看一下源码：

//Kotlin反射表示属性，继承至KCallable
public actual interface KProperty<out V> : KCallable<V> {
    
    //该属性是否是延迟初始化
    @SinceKotlin("1.1")
    public val isLateinit: Boolean

    //该属性是否是const
    @SinceKotlin("1.1")
    public val isConst: Boolean

    //get函数
    public val getter: Getter<V>
}

表示一个属性，比如在代码中用val或者var来声明的属性，可以用 :: 操作符来获取它。

由于Kotlin中定义属性有val和var之分，所以这个KProperty也有个可修改的版本：

//对于var定义的属性
public actual interface KMutableProperty<V> : KProperty<V> {
    public val setter: Setter<V>
    public interface Setter<V> : KProperty.Accessor<V>, KFunction<Unit>
}

既然有了更好用KProperty就不用再使用KCallable来表示属性了，就不用再调用call方法了，比如下面例子：

//获取顶层属性的引用
val kcallable = ::topLevelValue
//调用set方法设置属性值
kcallable.set(100)
//调用get方法来获取值
println("value = ${kcallable.get()}")

上面的用法就比直接使用Callable要方便很多。

由于属性定义的地方不一样，当调用其反射对象时需要传递的参数也不一样，在Kotlin中可以分为下面3种。

KProperty0

无接收的属性，这种情况是定义在顶层函数中的属性或者属性定义时它自带get方法，源码如下：

public actual interface KProperty0<out V> : KProperty<V>, () -> V {
    //不用传递参数即可获取属性的值
    public actual fun get(): V
}

public actual interface KMutableProperty0<V> : KProperty0<V>, KMutableProperty<V> {
    //直接传递属性值即可赋值
    public actual fun set(value: V)
}

KProperty1

一个接收者的属性，这种也是最常见的，比如定义在类中的非扩展属性，定义的扩展属性，这种属性获取其值必须要传入其接收者，该类源码如下：

public actual interface KProperty1<T, out V> : KProperty<V>, (T) -> V {
    //必须传递一个接收者，才可以获取属性值
    public actual fun get(receiver: T): V
}

public actual interface KMutableProperty1<T, V> : KProperty1<T, V>, KMutableProperty<V> {
    //必须传递一个接收者，也就是给哪个对象的属性设置值
    public actual fun set(receiver: T, value: V)
}

KProperty2

2个接收者的属性，这种比较少见，只有定义在类中的扩展属性才可以，当然要获取这种属性的值或者给它赋值需要传入2个接收者。

public actual interface KProperty2<D, E, out V> : KProperty<V>, (D, E) -> V {

    public actual fun get(receiver1: D, receiver2: E): V
}

public actual interface KMutableProperty2<D, E, V> : KProperty2<D, E, V>, KMutableProperty<V> {
   
    public actual fun set(receiver1: D, receiver2: E, value: V)
}

总结

本篇文章主要说了当使用反射时，其类的属性是如何表示的，其实也非常简单，主要要了解其属性在哪里定义，分为几类即可。

在接下来文章，我们再分析一些其他常用类，以及利用反射来实现一个序列化库。