五、解决附带效应
附带效应是指发生在可组合函数作用域之外的应用状态的变化,例如当进入页面的时候更新一下当前的位置,亦或者修改一下全局变量,如果直接在可组合函数里面引入这些附带效应的话,会让逻辑出现严重的问题,下面是两种常见的错误的附带效应的使用案例:
/** * 手机位置更新服务 */ object PhoneLocationUpdateService{ //... fun updateMyLocation(){ // TODO: 更新当前的位置 } //... } /** * 全局变量、可组合函数以外的变量 */ var globalParams:Int=0 @Composable fun TestScreen(){ //❎的做法一 PhoneLocationUpdateService.updateMyLocation() //❎错误的做法二 globalParams++ Column{ //... } }
为什么附带效应在Compose中存在问题?
这要结合Compose的生命周期来说,回归到生命周期的这张图中
如果我们希望可组合函数显示的时候,都让某个全局变量增加1的话,确实很容易直接在可组合函数的开头几句中直接让全局变量+1,但是需要重视的是,可组合函数会在生命周期期间多次重组的,也就是自身会被多次调用,这样就和我们需要的业务相违背了。
相似地,如果我们在AndroidView中的onLayout中插入某些访问全局变量的代码的话,可想而知会出现多大的问题(因为onLayout会频繁被调用而且次数未知)。
var globalParams:Int=0 class CrazyView @JvmOverloads constructor( context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0 ) : View(context, attrs, defStyleAttr) { override fun onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int) { super.onLayout(changed, left, top, right, bottom) //让人疯狂!!! globalParams++ } }
解决附带效应利器——SideEffect Api
如 Compose 编程思想文档中所述,可组合项应该没有附带效应。如果您需要更改应用的状态(如管理状态文档中所述),您应该使用 Effect API,以便以可预测的方式执行这些附带效应。
换句话说,我们的可组合函数确实有些情况需要带一点附带效应,但是我们希望以"可预测的方式
"的执行。
注:SideEffect较多,属于最难上手的部分,但是只要你搞懂了他们的使用场景和解决的问题,就可以大胆使用了。
1.LaunchedEffect:在某个可组合项的作用域内运行挂起函数
使用场景:希望在一个组合内进行异步操作
LaunchedEffect会提供一个协程作用域,这个作用域不会随着重组消失,它只会在该组合销毁的时候停止。
LaunchedEffect和remember一样,使用key作为是否重启的标志,当key发生变化的时候,会重新启动运行挂起函数
下图展示了一个组件显示3秒之后会弹出一个"我显示了"的文字的可组合函数
图中的key1传入了Unit,也就是LaunchedEffect不会重启,你可以通过改变key的方式让它重启,具体得看业务需要。
2.rememberCoroutineScope:获取组合感知作用域,以便在可组合项外启动协程
使用场景:希望在非重组作用域启动协程任务
Compose中并不都是重组作用域,有一些诸如点击回调的地方,我们也希望启动协程任务,这样LaunchedEffect就无法满足我们的需求了,因为LaunchedEffect是一个可组合函数,他无法在重组作用域以外的地方调用。
下面看看案例,我们在重组作用域使用rememberCoroutineScope()方法生成一个scope,这个scope的生命周期和组合的生命周期也是一致的,从组合出现到销毁,中间的重组并不会影响它,同时我们根据名字也可以知道,这个scope内部是被remember处理过,我们不用担心重组之后又生成一个Scope。
接着我们就可以在非重组作用域(图中是onClick回调)中使用协程来完成异步操作。
你看懂了吗,点击按钮的3秒后,Text就会显示一段文字。
3.rememberUpdatedState:在效应中引用某个值,该效应在值改变时不应重启
使用场景:LaunchedEffect中执行了一段异步操作之后,希望取到最新的方法参数的值
假设我们拥有这样一个可组合函数,他的逻辑希望是:3秒后显示传入的num。
实际上,当你在3秒内传入了不同的num,在3秒后显示的结果是第一次传入的num。
这是什么情况呢,还记得LaunchedEffect的设计吗,它的设计就是避免异步逻辑遭受重组的干扰,因此只有第一次传入的num会真正被LaunchedEffect的lambda拿走,其余的num都被LaunchedEffect自身的设计忽视了。
这个时候会有人想起,LaunchedEffect的key是可以让它重启的,于是会改造成这样:
每次num发生变化的时候,都重启LaunchedEffect,这样不就可以在3秒倒计时之后,取到的都是最新的num吗,最终结果来说这是没问题的,显示的也是最新的值,但是问题是:倒计时也重启了。
在这种场景下,就需要使用rememberUpdatedState()了,它本质上非常简单,让我们看看源码:
@Composable fun <T> rememberUpdatedState(newValue: T): State<T> = remember { mutableStateOf(newValue) }.apply { value = newValue }
实际上就是把一个值缓存在一个MutableState里面而已,这样有什么用呢,我们看看改造后的代码:
我们继续看代码,使用rememberUpdatedState()
把num
缓存在一个MutableState
中,当LaunchedEffect
内部的delay结束时,通过MutableState
访问到了最新的值。
等等,为什么这个时候获取到的是最新的值呢,不是说LaunchedEffect
不是不会受到重组影响吗,当然不会,还记得MutableState
的by
使用方式吗,我们访问rememberUpDatedNum
实际上是访问了MutableState
内部的value
变量,MutableState
自始至终都没发生过变化,而是它内部的value
发生了变化,因此我们可以取到最新的值。
4.DisposableEffect:需要清理的效应
使用场景:当前可组合函数去订阅某些信息,而且可组合函数销毁的时候取消订阅
假设我们有一个这样的天气服务,可以通知所有的订阅者当前的天气。
interface WeatherListener{ fun onUpdate(weather:String) } object WeatherService{ private val observerList=mutableListOf<WeatherListener>() fun addObserver(observer:WeatherListener)= observerList.add(observer) fun remove(observer: WeatherListener)=observerList.remove(observer) fun update(){ observerList.forEach { it.onUpdate("下雨了") } } }
我们希望在一个组合中订阅实时的天气,可以这样做:
@Composable fun Weather(){ var weatherString by remember{ mutableStateOf("") } DisposableEffect(Unit){ val listener=object:WeatherListener{ override fun onUpdate(weather: String) { weatherString=weather } } WeatherService.addObserver(listener) onDispose { WeatherService.remove(listener) } } Text("当前的天气:${weatherString}") }
DisposableEffect
和LaunchedEffect
很类似,都有key作为重启的标识,只是必须调用onDispose
方法结尾,在onDispose
中进行解绑操作。
5.derivedStateOf:将一个或多个状态对象转换为其他状态
使用场景:订阅可观察的列表变化、观察多个状态的变化等
有时候我们希望某个状态发生改变的时候,会改变另外一个状态的值,通常可以使用remember
的key
来完成这个业务,例如下图,showText的值会在num改变的时候重新生成。
但是有些可观察的状态我们是无法使用为remember
的key
的,因为变化并不是发生在它自身的值的变化,而是其内部的值发生了变化,例如常见的mutableListOf()生成的列表。
为什么会没用呢,因为remember
比较的额是对象自身,而不是对象内部的内容,对于list
来说,它从来没有改变为其他引用,我们只改变它内部的元素,因此remember是无法感知到list
的变化的,这时候我们就需要使用derivedStateOf
来感知。
derivedStateOf
传入的lambda里面的任意一个MutableState
发生变化的时候,就会重新生成一个新值。
其他类内部包含了其他State的也可以通过这种方式来观察其变化。
总结
笔者大致讲了一下Compose的基础概念和入门难点,希望大家在入门Compose的过程中少走弯路,多理解不同api在合适的场景下的作用,后续会出更多Compose和其他安卓开发的文章,请关注订阅点赞。