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

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

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

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

类委托

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

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 注解来注解旧的属性、并委托其实现。

相关推荐

系统引导启动项怎么设置(系统引导按哪个键)

如果您想在计算机启动时添加系统启动引导选项,可以按照以下步骤进行操作:1.打开“运行”窗口,可以通过快捷键Win+R打开“运行”窗口。2.在“运行”窗口中输入“msconfig”命令,并点击“...

win10录屏快捷键ctrl+alt+(win10录屏功能快捷键)

答,笔记本电脑录屏快捷键是ctrl+alt+s。绝大多数人录制屏幕时,第一个想到的就是电脑自带的录屏功能,比较的方便快捷。这种方法运用起来时非常简单的,只需在键盘上同时按下“ctrl+alt+s”键就...

壁纸下载(壁纸下载安装)

回答如下:要下载电视屏保相册,您需要先找到适用于您的电视的屏保应用程序。这些应用程序可能会根据您的电视品牌和型号而有所不同,您可以在电视的应用商店中搜索或查看电视制造商的网站以获取更多信息。一旦您找到...

木马病毒下载安装(木马病毒下载安装不实名认证)

现在1,你自己机器上下载个杀毒软件,安装之后不要删除安装包2,运行杀毒软件3,插入优盘,杀毒软件会自动扫描优盘发现病毒然后提示你4,选择处理/杀毒/清理这些字样5,把杀毒软件安装包复制到优盘6,右键优...

免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
手机cdr转jpg最简单的方法(手机cdr转换jpg)

cdr文件怎么转换成jpg,快来看下操作方法吧。方法/步骤1、打开电脑中的cdr软件,点击文件,打开,打开需要转换格式的cdr文件。2、点击菜单栏的文件,导出。3、打开导出对话框选择保存文件路径。4、...

xp永久激活工具(xp永久激活码)

如果你需要重置XP的激活器,你需要先打开“开始”菜单,然后选择“运行”。在运行对话框中,输入“regedit”,然后按回车键。这会打开注册表编辑器。在编辑器中,使用左侧面板来导航到“HKEY_LOCA...

cad2008激活序列号(激活cad的序列号)

1.首先运行“AutoCAD2008安装包”中的“Setup.exe”安装AutoCAD2008,安装过程需要十分钟左右;2.第一次运行AutoCAD2008时,请在注册界面输入序列号666-9...

自己可以重装电脑系统么(可以自己重装系统吗)

电脑自身也可以重装系统。1.电脑是一个可编程的设备,通过特定的步骤和操作,用户可以自行进行系统重装。2.重装系统的过程包括备份重要数据、获取系统安装介质、重新启动电脑进入安装界面、按照指引选择系统...

win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
苹果处理器性能排行(苹果处理器性能排行榜平板)

1、截止至最新的iPhoneXS上搭载的A12,从iPhone4首次搭载A4处理器开始,目前已经有9代的苹果A系列处理器;2、A4是一颗45nm制程的ARMCortex-A8的单核心处理器,GP...

苹果手机怎么录屏(苹果手机怎么录屏在哪里打开)

iPhone手机的屏幕录制功能需要在设置里面进行添加,添加成功之后,就可以使用录屏功能了。点击控制中心进入iPhone手机的设置,来到设置之后,找到控制中心选项并点击。点击加号添加录屏功能来到控制中心...

电脑怎么打开系统还原(电脑怎么开启系统还原的功能)

右键此电脑,属性,系统保护,配置,勾选启用系统保护,确定,创建,输入还原点描述,点击创建,系统提示已成功创建还原点,点击关闭,当需要还原的时候,点击上面的系统还原,选择需要还原的节点,点击完成,即可开...

ghost系统下载xp(非ghostxp下载)

蒲公英系统网站能下载。下载后缀为gho的xp系统,使用体验非常棒效果非常好。以上信息根据美国华盛顿操作系统邮报最新消息显示。不能装钉钉的。在WindowsXP系统上是不能安装钉钉来上网课的。要使用钉...