Modifier.composed se introdujo en Compose 1.0 para permitirte acceder a elementos de composición desde modificadores. Por ejemplo, un caso de uso clave es crear un modificador con estado que recuerde el estado local y lo comparta con otros modificadores en la fábrica Modifier.composed:
// ❌ BAD: Using Modifier.composed is no longer recommended fun Modifier.pressScale( pressedScale: Float = 0.95f, onClick: () -> Unit ): Modifier = composed( inspectorInfo = debugInspectorInfo { name = "pressScale" properties["pressedScale"] = pressedScale } ) { val interactionSource = remember { MutableInteractionSource() } val isPressed by interactionSource.collectIsPressedAsState() val scale by animateFloatAsState( targetValue = if (isPressed) pressedScale else 1f, animationSpec = spring(), label = "pressScale" ) this .graphicsLayer { scaleX = scale scaleY = scale } .clickable( interactionSource = interactionSource, indication = null, onClick = onClick ) }
Usa Modifier.Node en lugar de Modifier.composed, ya que Modifier.Node mejora la forma en que se administra el estado dentro de los modificadores. Un Modifier.Node es un objeto con estado de larga duración que se crea una vez por cada Modifier.Element aplicado a un LayoutNode, y sobrevive a la recomposición en lugar de materializarse de nuevo a través de la composición en cada paso. Para obtener más información sobre por qué y cómo diseñamos Modifier.Node, consulta Análisis detallado de los modificadores de Compose.
En este documento, se describe cómo migrar de Modifier.composed a Modifier.Node. Para obtener más información sobre el uso general de esta API, consulta Implementa el comportamiento del modificador personalizado con Modifier.Node.
Beneficios de rendimiento de Modifier.Node
El uso de Modifier.composed introduce varios cuellos de botella fundamentales en el rendimiento:
- Sobrecarga de administración de estados: Administrar el estado en este alcance requiere llamadas a
remembery objetos de estado de instantánea, lo que infla la tabla de ranuras con grupos de composición innecesarios y aumenta la presión de la memoria. - Acceso costoso al ciclo de vida: Para acceder al ciclo de vida del modificador, se deben usar efectos como
DisposableEffect, lo que aumenta rápidamente el trabajo requerido para los casos de uso más simples. - Falta de capacidad de omisión: Debido a que la expresión lambda que se pasa a
composeddevuelve unModifier, el compilador de Compose no puede marcarla como omitible, lo que obliga a volver a ejecutarla cada vez que se recompone el diseño. - Memorización y equivalencia interrumpidas: Debido a que la función de extensión externa en sí no es un
@Composable, el compilador no puede memorizar la expresión lambda interna, lo que genera asignaciones de lambda nuevas en cada llamada. Esta falta de memoización interrumpe directamente la igualdad del modificador (equals), ya queComposedModifiercompara lambdas por referencia. Por lo tanto, Compose trata el modificador como si hubiera cambiado en cada fotograma, incluso cuando los parámetros son estáticos. - Sin propagación de cambios inteligente: Sin el seguimiento de parámetros componibles de nivel superior, no hay forma de comparar las entradas nuevas con las anteriores para la propagación de cambios inteligente.
En general, la forma de la API de Modifier.composed fomenta la escritura de código costoso y evita que el tiempo de ejecución de Compose aplique optimizaciones adicionales de modificadores.
Pasos principales de la migración
En el siguiente ejemplo, se muestra un modificador personalizado típico implementado con Modifier.composed. Para obtener más información, consulta Implementa el comportamiento de modificadores personalizados con Modifier.Node.
fun Modifier.underline( color: Color, thickness: Dp = 2.dp, animationDurationMillis: Int = 300 ): Modifier = composed { val density = LocalDensity.current val strokePx = with(density) { thickness.toPx() } // Drives how much of the underline is drawn: 0f -> 1f val progress = remember { Animatable(0f) } LaunchedEffect(color, thickness) { progress.snapTo(0f) progress.animateTo( targetValue = 1f, animationSpec = tween(durationMillis = animationDurationMillis) ) } drawBehind { val y = size.height - strokePx / 2 drawLine( color = color, start = Offset(0f, y), end = Offset(size.width * progress.value, y), strokeWidth = strokePx ) } }
Crea un
Modifier.Node(oDelegatingNode) personalizado:private class UnderlineNode( private var color: Color, private var thickness: Dp, private var animationDurationMillis: Int ) : Modifier.Node() { fun update(color: Color, thickness: Dp, durationMillis: Int) { } }
Implementa una o más de las APIs auxiliares de
Modifier.Node, según lo que necesite tu modificador personalizado (por ejemplo,PointerInputModifierNodesi necesita acceso a las APIs de entrada del puntero):private class UnderlineNode( private var color: Color, private var thickness: Dp, private var animationDurationMillis: Int ) : Modifier.Node(), DrawModifierNode { private val progress = Animatable(0f) private var animationJob: Job? = null override fun onAttach() { restartAnimation() } fun update(color: Color, thickness: Dp, durationMillis: Int) { val needsRestart = this.color != color || this.thickness != thickness this.color = color this.thickness = thickness this.animationDurationMillis = durationMillis if (needsRestart) restartAnimation() } private fun restartAnimation() { animationJob?.cancel() animationJob = coroutineScope.launch { progress.snapTo(0f) progress.animateTo(1f, tween(animationDurationMillis)) } } override fun ContentDrawScope.draw() { val strokePx = thickness.toPx() val y = size.height - strokePx / 2 drawLine( color = color, start = Offset(0f, y), end = Offset(size.width * progress.value, y), strokeWidth = strokePx ) drawContent() } }
Crea un
ModifierNodeElementque cree y actualice tu nodo personalizado:private class UnderlineElement( private val color: Color, private val thickness: Dp, private val animationDurationMillis: Int ) : ModifierNodeElement<UnderlineNode>() { override fun create() = UnderlineNode(color, thickness, animationDurationMillis) override fun update(node: UnderlineNode) { node.update(color, thickness, animationDurationMillis) } override fun InspectorInfo.inspectableProperties() { name = "underline" properties["color"] = color properties["thickness"] = thickness properties["animationDurationMillis"] = animationDurationMillis } override fun hashCode(): Int { var result = color.hashCode() result = 31 * result + thickness.hashCode() result = 31 * result + animationDurationMillis.hashCode() return result } override fun equals(other: Any?): Boolean { if (this === other) return true val otherElement = other as? UnderlineElement ?: return false return color == otherElement.color && thickness == otherElement.thickness && animationDurationMillis == otherElement.animationDurationMillis } }
Actualiza la fábrica de modificadores para que apunte a
ModifierNodeElement:fun Modifier.underline( color: Color, thickness: Dp = 2.dp, animationDurationMillis: Int = 300 ): Modifier = this then UnderlineElement(color, thickness, animationDurationMillis)
Recetas de migración comunes
Las siguientes recetas muestran cómo migrar patrones comunes de Modifier.composed a fábricas de modificadores Modifier.Node o @Composable.
Cómo acceder a un CompositionLocal
Patrón: Lectura de un solo CompositionLocal, como LocalDensity, Theme o LocalView.
Ruta de migración: Marca el modificador con @Composable. Existe una diferencia semántica entre usar un modificador composed y una fábrica de modificadores @Composable para acceder a un CompositionLocal. Con una fábrica de @Composable, los valores de CompositionLocal se resuelven en el sitio de llamada de la fábrica de modificadores. Si este no es el comportamiento deseado, usa una implementación personalizada de Modifier.Node que lea CompositionLocals con CompositionLocalConsumerModifierNode.
Para obtener más información, consulta Cómo crear un modificador personalizado con una fábrica de modificadores componible.
// ❌ BAD: Using Modifier.composed to read a single CompositionLocal fun Modifier.themedContainerBorder(): Modifier = composed { Modifier.border( BorderStroke( width = 2.dp, color = LocalColorScheme.current.primaryColor, ) ) .clipToBounds() }
// ✅ GOOD: If the modifier is @Composable, it should be able to access the locals. @Composable fun Modifier.themedContainerBorder() = this then Modifier.border( BorderStroke( width = 2.dp, color = MyTheme.mainColor, ) ) .clipToBounds()
Patrón: Lectura de un CompositionLocal que se podría aplicar a un modificador posterior.
Ruta de migración: Crea un Modifier.Node personalizado que implemente CompositionLocalConsumerModifierNode y combine todas las capacidades de los modificadores.
// ❌ BAD: Using Modifier.composed to read a CompositionLocal then using it in another modifier. fun Modifier.adaptiveAccessibilityPadding(basePadding: Dp): Modifier = composed { // Reading LocalThemePadding.current.small (CompositionLocal) val extraPadding = LocalThemePadding.current.small Modifier.padding(basePadding + extraPadding) }
// ✅ GOOD: A custom Modifier that combines the capabilities of both (layout and composition local reader) modifiers. fun Modifier.adaptiveAccessibilityPadding(basePadding: Dp): Modifier = this.then(AdaptivePaddingElement(basePadding)) private data class AdaptivePaddingElement( val basePadding: Dp, ) : ModifierNodeElement<AdaptivePaddingNode>() { override fun create() = AdaptivePaddingNode(basePadding) override fun update(node: AdaptivePaddingNode) { node.basePadding = basePadding } override fun InspectorInfo.inspectableProperties() { name = "adaptiveAccessibilityPadding" properties["basePadding"] = basePadding } } private class AdaptivePaddingNode( var basePadding: Dp, ) : Modifier.Node(), LayoutModifierNode, CompositionLocalConsumerModifierNode { override fun MeasureScope.measure( measurable: Measurable, constraints: Constraints, ): MeasureResult { val extraPadding = currentValueOf(LocalThemePadding).small val total = (basePadding + extraPadding).roundToPx() val horizontal = total * 2 val vertical = total * 2 val placeable = measurable.measure(constraints.offset(-horizontal, -vertical)) val width = constraints.constrainWidth(placeable.width + horizontal) val height = constraints.constrainHeight(placeable.height + vertical) return layout(width, height) { placeable.place(total, total) } } }
Accede a una función de componibilidad que no es de diseño
Patrón: El modificador necesita acceder a una función que se anota con @Composable y muestra un objeto (por ejemplo, colorResource o ScrollableDefaults.flingBehavior).
Ruta de migración: Anota el modificador con @Composable.
// ❌ BAD: Using Modifier.composed to access a composable function such as colorResource fun Modifier.niceBackground() = composed { // Reading composable function colorResource val gradientColor1 = colorResource(R.color.my_special_color) background(color = gradientColor1, shape = CircleShape) }
// ✅ GOOD: A modifier can be annotation with @Composable to reference composable functions. @Composable // Modifier can be Composable itself. private fun Modifier.niceBackground(): Modifier { val gradientColor1 = colorResource(R.color.my_special_color) return this.background(color = gradientColor1, shape = CircleShape) }
Accede a un alcance de corrutina
Patrón: Se usa Modifier.composed para ejecutar rememberCoroutineScope y acceder a un objeto coroutineScope para iniciar corrutinas.
Ruta de migración: Usa un Modifier.Node personalizado, que tiene una propiedad coroutineScope vinculada al ciclo de vida del modificador (como rememberCoroutineScope dentro de Modifier.composed):
// ❌ BAD: Using Modifier.composed to get access to a coroutine scope. fun Modifier.onClickAsyncComposed(onClick: suspend () -> Unit): Modifier = composed { val scope = rememberCoroutineScope() Modifier.pointerInput(onClick) { detectTapGestures { // Needs a coroutine scope to launch suspend lambda. scope.launch { onClick() } } } }
// ✅ GOOD: A custom Modifier.Node has a scoped (modifier lifecycle) coroutineScope that can be used to launch async work. fun Modifier.onClickAsync(onClick: suspend () -> Unit): Modifier = this.then(OnClickAsyncElement(onClick)) private data class OnClickAsyncElement(val onClick: suspend () -> Unit) : ModifierNodeElement<OnClickAsyncNode>() { override fun create(): OnClickAsyncNode = OnClickAsyncNode(onClick) override fun update(node: OnClickAsyncNode) { node.update(onClick) } override fun InspectorInfo.inspectableProperties() { name = "onClickAsync" properties["onClick"] = onClick } } private class OnClickAsyncNode(private var onClick: suspend () -> Unit) : DelegatingNode(), PointerInputModifierNode { private val pointerInputNode = delegate( SuspendingPointerInputModifierNode { detectTapGestures { // Modifier.Node provides `coroutineScope` directly. coroutineScope.launch { onClick() } } } ) fun update(onClick: suspend () -> Unit) { if (this.onClick != onClick) { this.onClick = onClick pointerInputNode.resetPointerInputHandler() } } override fun onPointerEvent( pointerEvent: PointerEvent, pass: PointerEventPass, bounds: IntSize, ) { pointerInputNode.onPointerEvent(pointerEvent, pass, bounds) } override fun onCancelPointerInput() { pointerInputNode.onCancelPointerInput() } }
Cómo recordar un estado
Patrón: Usar remember en Modifier.composed para guardar el estado entre recomposiciones
Ruta de migración: Modifier.Node se creó para mantener el estado de la misma manera. El estado se puede mantener dentro de una instancia, al igual que cualquier otra propiedad de clase con un ciclo de vida más claro:
// ❌ BAD: Using Modifier.composed to make the modifier stateful. fun Modifier.tapCountHighlightComposed(colors: List<Color>): Modifier = composed { // 1. Must use `remember` so `tapCount` isn't reset to 0 on every recomposition var tapCount by remember { mutableIntStateOf(0) } Modifier .pointerInput(colors) { detectTapGestures { tapCount++ } } .drawBehind { drawRect(colors[tapCount % colors.size]) } }
// ✅ GOOD: Modifier.Node is the recommended way of creating stateful modifiers. fun Modifier.tapCountHighlight(colors: List<Color>): Modifier = this then TapCountHighlightElement(colors) private data class TapCountHighlightElement( val colors: List<Color>, ) : ModifierNodeElement<TapCountHighlightNode>() { override fun create() = TapCountHighlightNode(colors) override fun update(node: TapCountHighlightNode) { node.updateColors(colors) } override fun InspectorInfo.inspectableProperties() { name = "tapCountHighlight" properties["colors"] = colors } } private class TapCountHighlightNode( private var colors: List<Color>, ) : DelegatingNode(), DrawModifierNode { private var tapCount = 0 // Stateful modifier, this property will survive recompositions since Modifier.Nodes are held in the modifier tree. private val pointerInputNode = delegate( SuspendingPointerInputModifierNode { detectTapGestures { tapCount++ invalidateDraw() } } ) override fun ContentDrawScope.draw() { drawRect(colors[tapCount % colors.size]) drawContent() } fun updateColors(colors: List<Color>) { this.colors = colors invalidateDraw() } }
Cómo usar un efecto
Patrón: Usar efectos para ejecutar operaciones vinculadas al ciclo de vida de la composición (por ejemplo, cuando Modifier.composed entró o salió de la composición).
Ruta de migración: Modifier.Node tiene devoluciones de llamada de ciclo de vida claras que se pueden usar para ejecutar las mismas operaciones. Por ejemplo, un LaunchedEffect se puede reemplazar, por lo general, con el uso de coroutineScope dentro del método Modifier.Node onAttach:
// ❌ BAD: Using Modifier.composed to launch/run an effect. fun Modifier.logImpressionComposed( targetId: String, onLog: suspend (targetId: String) -> Unit, ): Modifier = composed { // LaunchedEffect is tied to Composition lifecycle LaunchedEffect(targetId) { onLog(targetId) } this }
// ✅ GOOD: Modifier.Node has lifecycle callbacks (e.g onAttach, onDetach) that can be used to emulate effects behaviors. fun Modifier.logImpression(targetId: String, onLog: suspend (targetId: String) -> Unit): Modifier = this.then(LogImpressionElement(targetId, onLog)) private data class LogImpressionElement( val targetId: String, val onLog: suspend (targetId: String) -> Unit, ) : ModifierNodeElement<LogImpressionNode>() { override fun create(): LogImpressionNode = LogImpressionNode(targetId, onLog) override fun update(node: LogImpressionNode) { node.update(targetId, onLog) } override fun InspectorInfo.inspectableProperties() { name = "logImpression" properties["targetId"] = targetId } } private class LogImpressionNode( var targetId: String, var onLog: suspend (targetId: String) -> Unit, ) : Modifier.Node() { private var job: Job? = null override fun onAttach() { super.onAttach() runEffect() // Uses onAttach to track modifier lifecycle. } fun update(targetId: String, onLog: suspend (targetId: String) -> Unit) { // Re-run the effect if the key (`targetId`) changed if (this.targetId != targetId) { runEffect() } this.targetId = targetId this.onLog = onLog } private fun runEffect() { job?.cancel() job = coroutineScope.launch { onLog(targetId) } } }
Cómo mantener un estado de animación
Diseño: Modifier.composed con animate*AsState.
Ruta de migración: animate*AsState se puede desglosar en un modificador personalizado que supervisa las devoluciones de llamada del ciclo de vida y mantiene un estado Animatable:
// ❌ BAD: Using Modifier.composed to save an animation state. fun Modifier.fadeInOnHoverComposed(isHovered: Boolean): Modifier = composed { val alpha by animateFloatAsState( targetValue = if (isHovered) 1f else 0.4f, animationSpec = tween(durationMillis = 300), label = "alphaAnimation", ) Modifier.graphicsLayer { this.alpha = alpha } }
// ✅ GOOD: Animation state can be saved in Modifier.Node like other types of stateful implementations. fun Modifier.fadeInOnHover(isHovered: Boolean): Modifier = this.then(FadeInOnHoverElement(isHovered)) private data class FadeInOnHoverElement(val isHovered: Boolean) : ModifierNodeElement<FadeInOnHoverNode>() { override fun create(): FadeInOnHoverNode = FadeInOnHoverNode(isHovered) override fun update(node: FadeInOnHoverNode) { node.update(isHovered) } override fun InspectorInfo.inspectableProperties() { name = "fadeInOnHover" properties["isHovered"] = isHovered } } private class FadeInOnHoverNode(var isHovered: Boolean) : Modifier.Node(), LayoutModifierNode { // 1. Persistent Animatable field on the Node instance private val alphaAnimatable = Animatable(if (isHovered) 1f else 0.4f) override fun onAttach() { super.onAttach() startAnimation(isHovered) } // 2. Trigger animation imperatively when `isHovered` argument changes fun update(isHovered: Boolean) { if (this.isHovered != isHovered) { this.isHovered = isHovered if (isAttached) { startAnimation(isHovered) } } } private fun startAnimation(hovered: Boolean) { val targetAlpha = if (hovered) 1f else 0.4f // Use Node's built-in coroutineScope coroutineScope.launch { alphaAnimatable.animateTo( targetValue = targetAlpha, animationSpec = tween(durationMillis = 300), ) } } override fun MeasureScope.measure( measurable: Measurable, constraints: Constraints, ): MeasureResult { val placeable = measurable.measure(constraints) return layout(placeable.width, placeable.height) { // Read current animation value during layout placement layer placeable.placeWithLayer(0, 0) { alpha = alphaAnimatable.value } } } }