局部属性
var i by local { 0 }
Button {
TextFlatten(Modifier.padding(7.scaled)) { "counter: $i".emit() }
}.clickable { i++ }
这段代码生成了一个按钮,每次点击它,显示的数值就会+1。
关于kotlin属性委托语法:link
用法
以下写法如果没有被idea自动处理import,把鼠标点在by上并按Alt+Enter。
var a by local { 3 }
val b by local(customId) { "alice" }
var c by local.animatable { 20.0 }
val size by local.autoAnimate<Measure> { if(expanded) 50.px else 25.px }
val data by stable { loadData() }
var count by static { 0 }
// ...
local{}是local.property{}的简写。property{}为普通变量,animatable{}和autoAnimate{}是动画变量,cached(key){}为缓存变量。它们都必须以local为接收者调用。
local,stable,static表示变量的生命周期。
指定id
一般情况下不需要指定id。使用前述的语法即可。
默认使用的追加id为传入lambda对象的::class。可以手动传入指定的id。
local和stable变量存在每个Screen单独管理的map中。存储key为当前context的id后追加上传入的id。正常情况下每个变量应该有一个固定且唯一的id。
session变量存在所属Root的map中,static变量存储在一张进程级共享的map中。两者都使用裸key:同一个Root内(session)或整个进程内(static),同名声明指向同一个槽,与声明它的Screen或context id无关。因此共享key必须始终对应同一种值类型。
与普通val的区别
var a = 0
var b by local { 0 }
// ...
.clickable {
a++
b++
}
在ui中会发现a的值始终是0,而b的值随着点击自增。
只要你想让这个值像一个稳定的变量,反复读写它的值,那就应该使用 by local/stable/static
生命周期
local
一段ui代码如果在某帧内没有被执行,其中的local属性会全部被销毁。下次执行到此处时会重新调用lambda的内容来创建这个变量。
stable
stable属性的存活时间为首次创建到Screen销毁。延长了生命周期,可以使得用户切换页面再切回后依然保留之前的状态。这意味着其中的内存不会自动销毁,管理不当会造成泄露。如果不能确保不泄露,应优先使用local。
session
session属性存活到所属Root关闭。同一个Root上的所有Screen共享它,因此一个Screen写入、另一个Screen读取是正常用法;Root关闭后,从保留的Scope再声明、缓存或取协程Scope都会直接失败。
static
static属性是全局共享的,效果类似全局变量或static变量,存活到进程结束。如果有需要用static.property(id) { value }的方式手动指定id,会使得具有相同id的声明指向同一属性(包括其它mod中的声明)。所以尽量指定不会重复的id,除非有意使用这种方式与其它mod通信。
任何一种属性的声明在所属Screen或Root关闭后都会被拒绝,即使调用方还保留着旧的PropertyLifeScope或context。初始化块里关闭所属界面时也一样:初始化返回后会重新检查,未发布的属性不会写入。
动画
animatable和autoAnimate能自动给可以插值的变量插值。它们都可以指定插值函数和时长。
两者都同时提供Double版本和泛型版本,泛型版本要求目标类型实现Interpolatable。当目标值不是Double时必须显式写出类型参数,否则会解析到Double版本而报类型不符,例如local.animatable<Measure> { ... }。
animatable
var height by local.animatable<Measure> { 10.px }
//...
.clickable { height = 30.px }
点击后,读取height的值,会发现读到的值从10随着时间平滑变化到30。
autoAnimate
和前者类似,但是只能委托给只读属性,用法略有不同。初始值和目标值都以lambda给出。
val height by local.autoAnimate<Measure> { if(bl) width else 30.px }
动画只保存时钟,不保存第一次创建它的Screen:
local/stable读所属Screen的帧起始时间;session读所属Root的帧起始时间,一个Root帧只取一次,Root内的多个Screen读到同一个时刻;static读进程单调时钟,与任何Root或Screen无关。
因此创建动画的Screen关闭后,同一Root上的另一个Screen仍能推进session动画;static动画甚至能在另一个Root上继续推进。
共享属性的创建与并发
session/static的同一个key在并发访问时只会执行一次初始化,所有调用者拿到同一个槽。初始化抛异常不会留下占位,下一次访问会重试;cached替换失败时旧槽仍然可读。初始化块如果再次访问同一个key,会得到明确的递归初始化错误,而不是挂起;同一线程上通过同一共享map的另一个Scope视图访问同名key也算递归,不同Root的map即使key相同也互不冲突。
共享槽以写入共享map为提交点。提交前,初始化块返回时会重新确认Screen/Root仍然有效,未提交的工作会被丢弃;提交后,static归进程、session归Root,即使创建它的Screen随后关闭也保留该槽,其他已拿到它的调用者不会看到它被回滚。session的Root关闭竞态仍会清掉刚提交但已属于关闭Root的槽。清理用户的普通副作用不在回滚承诺内。
单个属性值的引用读写对所有线程可见,可以直接跨线程发布一个值。共享值本身若是可变对象,跨线程的复合读写仍由用户自行同步;框架不承诺跨多个key或跨任意IO的原子事务。static/session动画器的多字段状态由该动画器自身的锁保持一致,local/stable动画仍走无锁的单屏快路径。
缓存
使用cached可以缓存一个计算开销较大的值。普通的加减乘除不建议使用。
val result by local.cached(key) {
// compute...
}
对于计算耗时更长的值,建议使用协程调度到其它线程来执行,并缓存结果。
val deferred by local {
async(Dispatchers.IO) {
// ...
}
}
if(deferred.isCompleted) {
// ...
}
或者
var result by local<A?> { null }
local {
launch(Dispatchers.IO) {
// ...
result = xxx
}
}
属性槽的查找和创建在声明路径上完成,之后对槽内值的读写不会再碰作用域map。但这只说明槽的发布是安全的:如果槽里放的是可变对象,并发的复合修改仍需要用户自己同步。