Jetpack Compose中@Stable注解作用于函数的效果及性能影响疑问

问题描述 #

我发现所有Density方法都使用了@Stable注解，对此感到好奇。注解文档说明：

When applied to a function or a property, the Stable annotation indicates that the function will return the same result if the same parameters are passed in.

但我疑惑这是否真的会影响性能？我曾以为它会像remember一样跳过/缓存函数结果，于是用以下代码测试：

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            var counter by remember {
                mutableStateOf(0)
            }
            val key = foo(counter > 0)
            LaunchedEffect(key){
                while (isActive){
                    delay(1000)
                    counter++
                }
            }
        }
    }
}

@Stable
fun foo(toReturn: Boolean): Boolean{
    Log.d("TEST", toReturn.toString())
    return toReturn
}

但它每秒都会打印日志，这个注解似乎没有产生任何效果？

解答 #

@Stable注解不是用来缓存函数调用结果的，它的核心作用是给Jetpack Compose的重组系统提供元数据提示，帮助系统判断何时需要触发重组，而非跳过函数执行。

具体作用说明 #

• @Stable标记的函数/属性，向Compose承诺：相同输入一定会得到相同输出，如果是属性的话，其值变化时会通知Compose系统。
• 这个注解的价值在于优化重组范围：当Compose节点依赖某个@Stable函数的结果时，如果函数的输入参数没有变化，Compose可以确定结果不会变，从而避免不必要的节点重组。但它不会阻止函数在重组时被调用——只要当前Composable发生重组，函数依然会执行，只是依赖其结果的子节点可能不需要跟着重组。

测试代码无效果的原因 #

在你的代码中：

1. counter是mutableStateOf，每秒都会自增，每次变化都会触发整个setContent内的Composable重组。
2. 每次重组时，foo(counter > 0)都会被调用（因为重组发生了），所以日志会每秒打印。即使counter > 0在第一次变为true后不再变化，只要counter本身在变，上层Composable就会重组，foo依然会被执行。

如果想验证@Stable的作用，可以调整代码：让依赖foo结果的子Composable在参数不变时不重组，比如：

@Composable
fun ParentComposable() {
    var counter by remember { mutableStateOf(0) }
    val flag = counter > 0

    // 每次counter变化，Parent都会重组，foo会被调用
    val fooResult = foo(flag)

    // ChildComposable依赖fooResult，因为foo是@Stable，当flag不变时，Child不会重组
    ChildComposable(fooResult)

    LaunchedEffect(Unit) {
        while (true) {
            delay(1000)
            counter++
        }
    }
}

@Stable
fun foo(toReturn: Boolean): Boolean {
    Log.d("TEST", "foo called with $toReturn")
    return toReturn
}

@Composable
fun ChildComposable(value: Boolean) {
    Log.d("TEST", "Child recomposed with $value")
    Text(text = value.toString())
}

运行这段代码会发现：当counter从0变为1后，flag一直是true，后续counter再增加时，foo依然会被调用（因为Parent在重组），但ChildComposable不会再重组——这就是@Stable注解带来的优化效果。

为什么Density方法都用@Stable？ #

Density相关方法（比如dp.toPx()）的输入和输出是强关联的：相同的dp值在同一个Density下一定会得到相同的px值。标记@Stable后，Compose可以放心地基于输入是否变化来判断是否需要更新依赖这些方法结果的UI元素，避免无意义的重组，从而提升性能。

内容的提问来源于stack exchange，提问作者Kamil Bąk