kotlin中的委托属性

创建时间: 2025-03-03 23:57:37

前言

在学原生安卓的时候跟着官方的案例学习发现一个和我以前学的编程语言都没见过的语法——委托属性,就是这行代码,真是太奇怪了

// 正常按照所有的编程语言,不都是 变量 = 值,
// 但是在kotlin中还能出现by这样的类型,真是太太太神奇了
// 怪不得那么多人吐槽kotlin中的语法糖太多,以前我还不相信,现在我是相信了
var result by remember { mutableIntStateOf(1) }

官方的定义

下面内容摘要至kotlin的官方 文档

对于某些常见类型的属性,即使每次需要时都可以手动实现它们,但实现一次,将它们添加到库中,并在以后重用它们会更有帮助。例如:

  • Lazy properties:仅在首次访问时计算该值。

  • Observable properties:侦听器会收到有关此属性更改的通知。

  • 将属性存储在映射中,而不是为每个属性存储单独的字段。

为了涵盖这些(和其他)情况,Kotlin 支持委托属性

基本语法

在官方的教程里有一个简单的案例如下所示

, value: String) { println("$value has been assigned to 'NULL' in $thisRef.") } } fun main() { val e = Example() e.p = "John" println(e.p) } ``` ">
import kotlin.reflect.KProperty

class Example {
    var p: String by Delegate()

}

class Delegate {
    operator fun getValue(thisRef: Any?, property: KProperty<*>): String {
        return "$thisRef, thank you for delegating 'NULL' to me!"
    }

    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) {
        println("$value has been assigned to 'NULL' in $thisRef.")
    }
}

fun main() {
    val e = Example()
    e.p = "John"
    println(e.p)
}

上述的这段代码运行结果如下:

John has been assigned to 'p' in Example@7a07c5b4.
Example@7a07c5b4, thank you for delegating 'p' to me!

可以看到这个Example对象里的p属性已经委托给了Delegate对象来处理,每当调用p的getValue或者setValue时,都会委托Delegate对象来进行调用。至此我们已经知道了委托属性具体是啥了,简单来说就是委托我们的属性给一个对象来处理,这样可以减少很多对象的实例化的代码,确实还可以。【糖有点多,快吃吐了,@jetbrians,消停消停叭】

变量使用委托属性

当然官方的案例中只介绍了在对象的属性中使用委托属性,但是官方也补充了一句话:”您可以在函数或代码块中声明委托属性;它不必是类的成员。“

下面是在变量中使用委托属性

// Delegate对象如上所示
var x: String by Delegate()
println(x)
x = "111"

运行结果如下:

null, thank you for delegating 'x' to me!
111 has been assigned to 'x' in null.

其实和类中的委托属性一样,不能说毫不相干简直是一模一样。

标准代表

Kotlin 标准库为几种有用的委托提供了工厂方法。

惰性属性

val lazyValue: String by lazy {
    println("computed!")
    "Hello"
}

fun main() {
    println(lazyValue)
    println(lazyValue)
}

运行结果如下:

computed!
Hello
Hello

怎么感觉这个惰性属性就是go语言的sync.onceValue,不能说毫不相干简直是一模一样,只是go语言没有这个by的关键字误导我叭了,(jetbrians你怎么看【手动狗头】)

Observable 属性

") { props, old, new -> println("$old -> $new") } } fun main() { val user = User() user.name = "first" user.name = "second" } ``` ">
import kotlin.properties.Delegates

class User {
    var name: String by Delegates.observable("<no name>") { props, old, new ->
        println("$old -> $new")
    }
}

fun main() {
    val user = User()
    user.name = "first"
    user.name = "second"
}

运行结果如下:

<no name> -> first
first -> second

oh!!!这个我熟,这个就是观察者模式嘛,不过用法类似vue里面的watch。这个糖。。。。无法评价。。。。

委托给另一个属性

class MyClass {
    var newName: Int = 0

    @Deprecated("Use 'newName' instead", ReplaceWith("newName"))
    var oldName: Int by this::newName
}

fun main() {
    val myClass = MyClass()
    myClass.oldName = 42
    println(myClass.newName)

}

运行结果如下:

42

这个感觉还挺有用的,不过我刚入门可能还用不到,毕竟这个一般在开源的库中还挺常见的。

在 Map 中存储属性

class User(private val map: Map<String, Any?>) {
    val name: String by map
    val age: Int by map
}

fun main() {
    val user = User(
        mapOf(
            "name" to "John Doe",
            "age" to 25,
        )
    )

    println(user.name)
    println(user.age)
}

运行结果如下:

John Doe
25

额。。。这个玩意和别的编程语言中直接把json转成对象有啥区别,我反而觉得这样还更麻烦了。

属性委托要求

我觉得这个地方没啥归纳总结的,直接贴出官方文档的原话叭:

只读属性

对于只读属性,委托应提供具有以下参数的运算符函数:valgetValue()

  • thisRef必须与属性所有者的类型相同或超类型(对于扩展属性,它应该是被扩展的类型)。

  • property必须是 type 或其 supertype。KProperty<*>

  • getValue()必须返回与属性 (或其子类型) 相同的类型。

可变属性

对于可变属性 ,委托必须另外提供具有以下参数的运算符函数:varsetValue()

  • thisRef必须与属性所有者的类型相同或超类型(对于扩展属性,它应该是被扩展的类型)。

  • property必须是 type 或其 supertype。KProperty<*>

  • value必须与 property (或其超类型) 属于同一类型。

理解

我的理解大概知道是什么情况了,为什么谷歌的jetpack compose这个框架需要用到委托属性了,他就类似于react中的useState,因为javascript没有委托属性,所以在useState中需要用setValue这样的函数来实现通知ui的渲染。但是kotlin中存在委托属性这样的东西,那么在android中更改当前的状态后就会经过委托的对象然后触发界面重渲染。委托属性确实好,比react的setValue好用,我觉得也比flutter中的StatefulWidget好用,setValue需要两个参数,StatefulWidget需要准备两个类。确实都要比jetpack compose中的by复杂一点点,但是也就仅仅只是一点点。