百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Kotlin | 10分钟搞定by委托机制(kotlin 代理)

liuian 2025-04-01 19:46 35 浏览

本文已同步发表于我的微信公众号,搜索 代码说 即可关注,欢迎与我沟通交流。

类委托

委托机制是一种非常灵活的语言特性,它可以让我们将对象的某些属性或方法委托给其他对象来处理。示例:

interface ISay {
    fun sayHello()
}

class DelegateImp : ISay {
    override fun sayHello() {
        println("sayHello from DelegateImp")
    }
}

//delegate传入DelegateImp()
class RealImp (val delegate : ISay) : ISay {
    override fun sayHello() {
        delegate.sayHello()
    }
}
  • RealImp 类将 sayHello() 方法的实现委托给了 DelegateImp 对象,从而实现了代码复用和模块化。
  • 当调用 RealImpsayHello() 方法时,实际上是调用了 DelegateImp 对象的 sayHello()方法。

Kotlin 中通过使用 by 关键字进行委托,上述 RealImp 的实现方式可以直接通过下面的方式来替代:

class RealImp2 : ISay by DelegateImp()  //方式1
class RealImp3(delegate: ISay) : ISay by delegate //方式2

上述两种方式的结果是一样的,可以看到 by 关键字后面的表达式是为了得到 ISay 接口的实例对象。最后执行:

RealImp(DelegateImp()).sayHello() //方式1
RealImp2().sayHello() //方式2
RealImp3(DelegateImp()).sayHello() //方式3

上述执行结果都是一样的:

sayHello from DelegateImp

属性委托

除了上一节中的接口类委托,Kotlin 还支持属性委托,语法模板如下:

val/var <属性名>: <类型> by <表达式>

接口是把接口方法委托出去,那属性要委托什么呢?很简单,对于一个属性,无非有两个操作:获取属性以及修改属性,也就是对应的 get()/set()

属性委托即是将对应的 get()/set() 操作分发给指定委托对象getValue()/setValue() 方法执行;当然,如果是 val 修饰的属性,只需要提供 getValue() 即可。示例:

class Delegate {
    //对应属性中的get(),表示获取数据
    operator fun getValue(thisRef: Any?, property: KProperty<*>): String {
        return "$thisRef,${property.name}"
    }

    //对应属性中的set(),表示设置数据,只有var的属性会有
    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) {
        println("$thisRef , ${property.name} , $value")
    }
}
  • thisRef: 请求其值的对象,即被委托对象的实例
  • property: 被委托对象属性的元数据。包含了被委托对象属性的名称、类型、可见性等信息。
  • valuesetValue() 中要设置的值。

使用示例

class DelegateProperty {
    var p1: String by Delegate()
}

fun main() {
   val property = DelegateProperty()
   println(property.p1) //getValue()
   property.p1 = "小马快跑" //setValue()
}

执行结果:
DelegateProperty@6d5380c2, p1  //getValue()
DelegateProperty@6d5380c2 , p1 , 小马快跑 //setValue()

上述 Delegate中的 getValue()/setValue()方法需要我们手动编写,有点麻烦,Kotlin为我们提供了ReadOnlyPropertyReadWriteProperty接口:

//只读
public fun interface ReadOnlyProperty {
    public operator fun getValue(thisRef: T, property: KProperty<*>): V
}

//读写都支持
public interface ReadWriteProperty : ReadOnlyProperty {
    public override operator fun getValue(thisRef: T, property: KProperty<*>): V
    public operator fun setValue(thisRef: T, property: KProperty<*>, value: V)
}

使用示例:

class DelegateR : ReadOnlyProperty {
    override fun getValue(thisRef: Any, property: KProperty<*>): String {
        return "getValue:$thisRef,${property.name}"
    }
}
class DelegateRW : ReadWriteProperty {
    override fun getValue(thisRef: Any, property: KProperty<*>): String {
        return "getValue:$thisRef,${property.name}"
    }

    override fun setValue(thisRef: Any, property: KProperty<*>, value: String) {
        println("setValue:$thisRef,${property.name},$value")
    }
}

class DelegateProperty {
    val p2: String by DelegateR()
    var p3: String by DelegateRW()
}

fun main() {
   val property = DelegateProperty()
   println(property.p2) //p2取值
   println(property.p3) //p3取值
   property.p3 = "小马快跑" //p3设值
}

执行结果:
getValue:DelegateProperty@77a567e1,p2
getValue:DelegateProperty@77a567e1,p3
setValue:DelegateProperty@77a567e1,p3,小马快跑

可以看到利用ReadOnlyPropertyReadWriteProperty实现的结果跟手动实现的结果是一致的,但是对比手动编写更方便、更快捷。

延迟委托 (by lazy)

//1
public actual fun  lazy(initializer: () -> T): Lazy = SynchronizedLazyImpl(initializer)

//2
public actual fun  lazy(mode: LazyThreadSafetyMode, initializer: () -> T): Lazy =
    when (mode) {
        LazyThreadSafetyMode.SYNCHRONIZED -> SynchronizedLazyImpl(initializer)
        LazyThreadSafetyMode.PUBLICATION -> SafePublicationLazyImpl(initializer)
        LazyThreadSafetyMode.NONE -> UnsafeLazyImpl(initializer)
    }

lazy() 是接受一个 lambda 表达式, 并返回一个 Lazy 实例的函数,返回的实例可以作为实现延迟属性的委托: 第一次调用属性的 get() 会执行已传递给 lazy()lambda 表达式并记录结果; 后续调用直接返回已经记录的结果。示例:

val lazyView by lazy {
  println("我只有第一次初始化的时候才执行哟~")
  "Come on"
}

//调用:
println("第1次:${property.lazyView}")
println("第2次:${property.lazyView}")

//执行结果:
我只有第一次初始化的时候才执行哟~
第1次:Come on
第2次:Come on

从结果可以看出只有第一次执行时走到了 lambda 表达式中的逻辑,第二次执行时直接返回第一次生成的结果。 另外再调用 lazy() 函数时可以传入一个 LazyThreadSafetyMode 参数,有下面三个值,分别代表不同的意思:

  • LazyThreadSafetyMode.SYNCHRONIZED:该值只在一个线程中计算,并且所有线程会看到相同的值。
  • LazyThreadSafetyMode.PUBLICATION:可以在并发访问未初始化的Lazy实例值时调用多次,但只有第一次返回的值将被用作Lazy实例的值。
  • LazyThreadSafetyMode.NONE:不会有任何线程安全的保证以及相关的开销,当初始化与使用总是位于相同线程中时使用。

如果lazy 属性的求值时不传 LazyThreadSafetyMode 参数,那么默认情况下走的是是
LazyThreadSafetyMode.SYNCHRONIZED
模式。

使用案例

先编写一个顶级扩展函数,注意其内部使用 lazy 包裹:

fun  Activity.id(id: Int) = lazy {
    findViewById(id)
}

接下来就可以使用了:

//Activity
class ViewPager2DispatchActivity : AppCompatActivity() {
    //注意看是在这里使用的
    private val mTvTxNews: TextView by id(R.id.tv_tx_news)

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_view_pager2_dispatch)
        mTvTxNews.text = "我已经初始化好了,可以使用了"
    }
}

//XML中(activity_view_pager2_dispatch.xml)


    

可以看到通过private val mTvTxNews: TextView by id(R.id.tv_tx_news) 声明后,下面就可以正常使用该TextView了,其原理本质上就是通过 by lazy 延迟初始化了该属性,这种写法不需要每次去调用findViewById()了,跟我们使用ButterKnife 库的效果是一样的。同理,如果在Fragment中或其他场景中使用,继续写类似的扩展函数即可。 嗯,Kotlin 的语法糖真甜!

可观察属性(observable properties)

Delegates.observable()可以认为是一个属性监听器,当监听的属性变更时会收到通知。其接受两个参数:初始值initialValueonChange()函数,当属性被赋值后就会触发onChange(),内部有三个参数:被赋值的属性、旧值与新值

public inline fun  observable(initialValue: T, crossinline onChange: (property: KProperty<*>, oldValue: T, newValue: T) -> Unit): ReadWriteProperty =
        object : ObservableProperty(initialValue) {
            override fun afterChange(property: KProperty<*>, oldValue: T, newValue: T) = onChange(property, oldValue, newValue)
        }

Delegates.observable() 可以帮助我们在属性值发生变化时自动执行一些操作,例如更新UI保存数据防抖动等。它适用于需要对属性值进行监听和处理的场景。

使用案例

这里以实现一个防抖动功能为例:

class ExampleActivity : AppCompatActivity()  {
    private var lastClickTime by Delegates.observable(0L) { _, old, new ->
        // 在lastClickTime属性值发生变化时执行点击事件
        if (new - old > 1000) {
            onClick()
        }
    }

    override fun onClick(view: View) {
        //每次点击都会触发Delegates.observable()
        lastClickTime = System.currentTimeMillis()
    }

    private fun onClick() {
        // 点击事件代码
    }
}

上述代码中,在 lastClickTime 属性值发生变化时,判断两次点击时间的间隔是否大于 1 秒:如果是,则执行点击事件;如果不是,什么都不做。如此通过 Delegates.observable 便实现了防抖动能力。

在属性被赋新值生效之前想截获赋值,可以使用 vetoable() 取代 observable()onChange()中会返回一个Boolean值来决定是否生效本次赋值

属性之间的委托

Kotlin 1.4 开始,一个属性可以把它的 gettersetter 委托给另一个属性,被委托的属性属于顶层或普通类属性都可。

为将一个属性委托给另一个属性,可以使用 :: 限定符,例如,this::delegateMyClass::delegate

使用案例

class DelegateProperty {
    @Deprecated("Use [newName] instead", ReplaceWith("newName"))
    var oldName by this::newName //this可以省略
    var newName = ""
}

fun main() {
    val property = DelegateProperty()
    property.oldName = "2023"
    println("oldName: ${property.oldName}")
    println("newName: ${property.newName}")
}

//执行结果:
oldName: 2023
newName: 2023

当想要以一种向后兼容的方式重命名一个属性的时候:引入一个新的属性、 使用 @Deprecated 注解来注解旧的属性、并委托其实现。

相关推荐

教你把多个视频合并成一个视频的方法

一.情况介绍当你有一个m3u8文件和一个目录,目录中有连续的视频片段,这些片段可以连成一段完整的视频。m3u8文件打开后像这样:m3u8文件,可以理解为播放列表,里面是播放视频片段的顺序。视频片段像这...

零代码编程:用kimichat合并一个文件夹下的多个文件

一个文件夹里面有很多个srt字幕文件,如何借助kimichat来自动批量合并呢?在kimichat对话框中输入提示词:你是一个Python编程专家,完成如下的编程任务:这个文件夹:D:\downloa...

Java APT_java APT 生成代码

JavaAPT(AnnotationProcessingTool)是一种在Java编译阶段处理注解的工具。APT会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,...

Unit Runtime:一键运行 AI 生成的代码,或许将成为你的复制 + 粘贴神器

在我们构建了UnitMesh架构之后,以及对应的demo之后,便着手于实现UnitMesh架构。于是,我们就继续开始UnitRuntime,以用于直接运行AI生成的代码。PS:...

挣脱臃肿的枷锁:为什么说Vert.x是Java开发者手中的一柄利剑?

如果你是一名Java开发者,那么你的职业生涯几乎无法避开Spring。它如同一位德高望重的老国王,统治着企业级应用开发的大片疆土。SpringBoot的约定大于配置、SpringCloud的微服务...

五年后,谷歌还在全力以赴发展 Kotlin

作者|FredericLardinois译者|Sambodhi策划|Tina自2017年谷歌I/O全球开发者大会上,谷歌首次宣布将Kotlin(JetBrains开发的Ja...

kotlin和java开发哪个好,优缺点对比

Kotlin和Java都是常见的编程语言,它们有各自的优缺点。Kotlin的优点:简洁:Kotlin程序相对于Java程序更简洁,可以减少代码量。安全:Kotlin在类型系统和空值安全...

移动端架构模式全景解析:从MVC到MVVM,如何选择最佳设计方案?

掌握不同架构模式的精髓,是构建可维护、可测试且高效移动应用的关键。在移动应用开发中,选择合适的软件架构模式对项目的可维护性、可测试性和团队协作效率至关重要。随着应用复杂度的增加,一个良好的架构能够帮助...

颜值非常高的XShell替代工具Termora,不一样的使用体验!

Termora是一款面向开发者和运维人员的跨平台SSH终端与文件管理工具,支持Windows、macOS及Linux系统,通过一体化界面简化远程服务器管理流程。其核心定位是解决多平台环境下远程连接、文...

预处理的底层原理和预处理编译运行异常的解决方案

若文章对您有帮助,欢迎关注程序员小迷。助您在编程路上越走越好![Mac-10.7.1LionIntel-based]Q:预处理到底干了什么事情?A:预处理,顾名思义,预先做的处理。源代码中...

为“架构”再建个模:如何用代码描述软件架构?

在架构治理平台ArchGuard中,为了实现对架构的治理,我们需要代码+模型描述所要处理的内容和数据。所以,在ArchGuard中,我们有了代码的模型、依赖的模型、变更的模型等,剩下的两个...

深度解析:Google Gemma 3n —— 移动优先的轻量多模态大模型

2025年6月,Google正式发布了Gemma3n,这是一款能够在2GB内存环境下运行的轻量级多模态大模型。它延续了Gemma家族的开源基因,同时在架构设计上大幅优化,目标是让...

比分网开发技术栈与功能详解_比分网有哪些

一、核心功能模块一个基本的比分网通常包含以下模块:首页/总览实时比分看板:滚动展示所有正在进行的比赛,包含比分、比赛时间、红黄牌等关键信息。热门赛事/焦点战:突出显示重要的、关注度高的比赛。赛事导航...

设计模式之-生成器_一键生成设计

一、【概念定义】——“分步构建复杂对象,隐藏创建细节”生成器模式(BuilderPattern):一种“分步构建型”创建型设计模式,它将一个复杂对象的构建与其表示分离,使得同样的构建过程可以创建...

构建第一个 Kotlin Android 应用_kotlin简介

第一步:安装AndroidStudio(推荐IDE)AndroidStudio是官方推荐的Android开发集成开发环境(IDE),内置对Kotlin的完整支持。1.下载And...