创建自定义修饰符

Compose 开箱即用地提供了许多用于常见行为的修饰符，但您也可以创建自己的自定义修饰符。

修饰符由多个部分组成

  • 修饰符工厂
    • 这是 Modifier 上的扩展函数，它为您的修饰符提供了惯用的 API，并允许修饰符轻松地进行链式调用。修饰符工厂会生成 Compose 用来修改界面的修饰符元素。
  • 修饰符元素
    • 您可以在此处实现修饰符的行为。

根据所需功能，有多种方法可以实现自定义修饰符。通常，实现自定义修饰符最简单的方法就是实现一个自定义修饰符工厂，它将其他已定义的修饰符工厂组合在一起。如果您需要更多自定义行为，可以使用 Modifier.Node API 实现修饰符元素，这些 API 级别较低，但提供了更大的灵活性。

将现有修饰符链式组合

通常可以通过使用现有修饰符来创建自定义修饰符。例如，Modifier.clip() 是使用 graphicsLayer 修饰符实现的。此策略使用现有修饰符元素，您只需提供自己的自定义修饰符工厂。

在实现自己的自定义修饰符之前，请查看是否可以使用相同的策略。

fun Modifier.clip(shape: Shape) = graphicsLayer(shape = shape, clip = true)
CustomModifierSnippets.kt

或者，如果您发现经常重复同一组修饰符，您可以将它们封装到自己的修饰符中

fun Modifier.myBackground(color: Color) = padding(16.dp)
    .clip(RoundedCornerShape(8.dp))
    .background(color)
CustomModifierSnippets.kt

使用可组合修饰符工厂创建自定义修饰符

您还可以使用可组合函数创建自定义修饰符，将值传递给现有修饰符。这被称为可组合修饰符工厂。

使用可组合修饰符工厂创建修饰符还允许使用更高级别的 Compose API，例如 animate*AsState 和其他由 Compose 状态支持的动画 API。例如，以下代码段显示了一个修饰符，当启用/禁用时，它会使 Alpha 值发生动画变化

@Composable
fun Modifier.fade(enable: Boolean): Modifier {
    val alpha by animateFloatAsState(if (enable) 0.5f else 1.0f)
    return this then Modifier.graphicsLayer { this.alpha = alpha }
}
CustomModifierSnippets.kt

如果您的自定义修饰符是用于从 CompositionLocal 提供默认值的便捷方法，那么最简单的实现方式就是使用可组合修饰符工厂

@Composable
fun Modifier.fadedBackground(): Modifier {
    val color = LocalContentColor.current
    return this then Modifier.background(color.copy(alpha = 0.5f))
}
CustomModifierSnippets.kt

这种方法有一些注意事项，详见下文。

CompositionLocal 值在修饰符工厂的调用站点解析

使用可组合修饰符工厂创建自定义修饰符时，组合局部变量会从其创建的组合树中获取值，而不是从其使用的位置获取值。这可能会导致意外结果。例如，请看上面略有不同地使用可组合函数实现的组合局部修饰符示例

@Composable
fun Modifier.myBackground(): Modifier {
    val color = LocalContentColor.current
    return this then Modifier.background(color.copy(alpha = 0.5f))
}

@Composable
fun MyScreen() {
    CompositionLocalProvider(LocalContentColor provides Color.Green) {
        // Background modifier created with green background
        val backgroundModifier = Modifier.myBackground()

        // LocalContentColor updated to red
        CompositionLocalProvider(LocalContentColor provides Color.Red) {

            // Box will have green background, not red as expected.
            Box(modifier = backgroundModifier)
        }
    }
}
CustomModifierSnippets.kt

如果这不是您期望的修饰符工作方式，请改用自定义的 Modifier.Node，因为组合局部变量将在使用站点正确解析，并且可以安全地提升。

可组合函数修饰符永不跳过

可组合工厂修饰符永远不会被跳过，因为具有返回值的可组合函数无法被跳过。这意味着您的修饰符函数将在每次重组时调用，如果重组频繁，这可能会很昂贵。

可组合函数修饰符必须在可组合函数内调用

与所有可组合函数一样，可组合工厂修饰符必须从组合内部调用。这限制了修饰符可以提升到的位置，因为它永远不能从组合中提升出去。相比之下，非可组合修饰符工厂可以从可组合函数中提升出去，以实现更轻松的重用并提高性能

val extractedModifier = Modifier.background(Color.Red) // Hoisted to save allocations

@Composable
fun Modifier.composableModifier(): Modifier {
    val color = LocalContentColor.current.copy(alpha = 0.5f)
    return this then Modifier.background(color)
}

@Composable
fun MyComposable() {
    val composedModifier = Modifier.composableModifier() // Cannot be extracted any higher
}
CustomModifierSnippets.kt

使用 Modifier.Node 实现自定义修饰符行为

Modifier.Node 是 Compose 中用于创建修饰符的较低级别 API。它是 Compose 实现其自身修饰符的相同 API，也是创建自定义修饰符的最高效方式。

使用 Modifier.Node 实现自定义修饰符

使用 Modifier.Node 实现自定义修饰符分为三个部分

  • 一个包含修饰符逻辑和状态的 Modifier.Node 实现。
  • 一个创建和更新修饰符节点实例的 ModifierNodeElement。
  • 一个可选的修饰符工厂，如上文所述。

ModifierNodeElement 类是无状态的，每次重组都会分配新实例，而 Modifier.Node 类可以是有状态的，并且可以在多次重组中存活，甚至可以被重用。

以下部分描述了每个部分，并展示了一个构建自定义修饰符来绘制圆形的示例。

Modifier.Node

The Modifier.Node 实现（在此示例中为 CircleNode）实现了自定义修饰符的功能。

// Modifier.Node
private class CircleNode(var color: Color) : DrawModifierNode, Modifier.Node() {
    override fun ContentDrawScope.draw() {
        drawCircle(color)
    }
}
CustomModifierSnippets.kt

在此示例中，它使用传递给修饰符函数的颜色绘制圆形。

一个节点实现了 Modifier.Node 以及零个或多个节点类型。根据修饰符所需的功能，有不同的节点类型。上面的示例需要能够绘制，因此它实现了 DrawModifierNode，这使其能够重写绘图方法。

可用类型如下：

节点

用途

示例链接

LayoutModifierNode

一个 Modifier.Node，它改变了其包裹内容的测量和布局方式。

示例

DrawModifierNode

一个 Modifier.Node，它在布局空间中进行绘制。

示例

CompositionLocalConsumerModifierNode

实现此接口可让您的 Modifier.Node 读取组合局部变量。

示例

SemanticsModifierNode

一个 Modifier.Node，它添加语义键/值，用于测试、无障碍功能和类似用例。

示例

PointerInputModifierNode

一个 Modifier.Node，它接收 PointerInputChanges。

示例

ParentDataModifierNode

一个 Modifier.Node，它向父布局提供数据。

示例

LayoutAwareModifierNode

一个 Modifier.Node，它接收 onMeasured 和 onPlaced 回调。

示例

GlobalPositionAwareModifierNode

一个 Modifier.Node，它在内容全局位置可能发生变化时，接收带有布局最终 LayoutCoordinates 的 onGloballyPositioned 回调。

示例

ObserverModifierNode

实现了 ObserverNode 的 Modifier.Node 可以提供自己的 onObservedReadsChanged 实现，该实现将在 observeReads 块中读取的快照对象发生更改时被调用。

示例

DelegatingNode

一个能够将工作委托给其他 Modifier.Node 实例的 Modifier.Node。

这对于将多个节点实现组合成一个非常有用。

示例

TraversableNode

允许 Modifier.Node 类在节点树中向上/向下遍历相同类型或特定键的类。

示例

当对其相应元素调用 update 时，节点会自动失效。由于我们的示例是 DrawModifierNode，因此每当在元素上调用 update 时，节点都会触发重绘，其颜色也会正确更新。可以如下文所述选择退出自动失效。

ModifierNodeElement

一个 ModifierNodeElement 是一个不可变类，它包含用于创建或更新自定义修饰符的数据

// ModifierNodeElement
private data class CircleElement(val color: Color) : ModifierNodeElement<CircleNode>() {
    override fun create() = CircleNode(color)

    override fun update(node: CircleNode) {
        node.color = color
    }
}
CustomModifierSnippets.kt

ModifierNodeElement 实现需要重写以下方法

  1. create: 这是实例化修饰符节点的函数。当您的修饰符首次应用时，会调用此函数来创建节点。通常，这相当于构造节点并使用传递给修饰符工厂的参数对其进行配置。
  2. update: 当此修饰符在已存在此节点的同一位置提供，但属性已更改时，会调用此函数。这由类的 equals 方法决定。先前创建的修饰符节点作为参数发送到 update 调用。此时，您应该更新节点的属性以与更新后的参数对应。节点以这种方式重用的能力是 Modifier.Node 带来性能提升的关键；因此，您必须更新现有节点，而不是在 update 方法中创建新节点。在我们的圆形示例中，节点的颜色会更新。

此外，ModifierNodeElement 实现还需要实现 equals 和 hashCode。update 只有在前一个元素的相等比较返回 false 时才会被调用。

上面的示例使用数据类来实现这一点。这些方法用于检查节点是否需要更新。如果您的元素具有不影响节点是否需要更新的属性，或者出于二进制兼容性原因希望避免使用数据类，那么您可以手动实现 equals 和 hashCode，例如填充修饰符元素。

修饰符工厂

这是修饰符的公共 API 接口。大多数实现只是简单地创建修饰符元素并将其添加到修饰符链中

// Modifier factory
fun Modifier.circle(color: Color) = this then CircleElement(color)
CustomModifierSnippets.kt

完整示例

这三个部分组合在一起，使用 Modifier.Node API 创建了绘制圆形的自定义修饰符

// Modifier factory
fun Modifier.circle(color: Color) = this then CircleElement(color)

// ModifierNodeElement
private data class CircleElement(val color: Color) : ModifierNodeElement<CircleNode>() {
    override fun create() = CircleNode(color)

    override fun update(node: CircleNode) {
        node.color = color
    }
}

// Modifier.Node
private class CircleNode(var color: Color) : DrawModifierNode, Modifier.Node() {
    override fun ContentDrawScope.draw() {
        drawCircle(color)
    }
}
CustomModifierSnippets.kt

使用 Modifier.Node 的常见情况

使用 Modifier.Node 创建自定义修饰符时，您可能会遇到以下一些常见情况。

零参数

如果您的修饰符没有参数，那么它永远不需要更新，并且不需要是数据类。这是一个修饰符的示例实现，它为可组合项应用固定量的填充

fun Modifier.fixedPadding() = this then FixedPaddingElement

data object FixedPaddingElement : ModifierNodeElement<FixedPaddingNode>() {
    override fun create() = FixedPaddingNode()
    override fun update(node: FixedPaddingNode) {}
}

class FixedPaddingNode : LayoutModifierNode, Modifier.Node() {
    private val PADDING = 16.dp

    override fun MeasureScope.measure(
        measurable: Measurable,
        constraints: Constraints
    ): MeasureResult {
        val paddingPx = PADDING.roundToPx()
        val horizontal = paddingPx * 2
        val vertical = paddingPx * 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(paddingPx, paddingPx)
        }
    }
}
CustomModifierSnippets.kt

引用组合局部变量

Modifier.Node 修饰符不会自动观察 Compose 状态对象（如 CompositionLocal）的变化。Modifier.Node 修饰符相对于仅通过可组合工厂创建的修饰符的优势在于，它们可以使用 currentValueOf 从修饰符在您的 UI 树中使用的地方读取组合局部变量的值，而不是从修饰符分配的地方读取。

但是，修饰符节点实例不会自动观察状态变化。要自动响应组合局部变量的变化，您可以在作用域内读取其当前值

此示例观察 LocalContentColor 的值，以根据其颜色绘制背景。由于 ContentDrawScope 确实会观察快照变化，因此当 LocalContentColor 的值变化时，它会自动重绘

class BackgroundColorConsumerNode :
    Modifier.Node(),
    DrawModifierNode,
    CompositionLocalConsumerModifierNode {
    override fun ContentDrawScope.draw() {
        val currentColor = currentValueOf(LocalContentColor)
        drawRect(color = currentColor)
        drawContent()
    }
}
CustomModifierSnippets.kt

要在作用域之外响应状态变化并自动更新修饰符，请使用 ObserverModifierNode。

例如，Modifier.scrollable 使用此技术来观察 LocalDensity 的变化。下面显示了一个简化示例

class ScrollableNode :
    Modifier.Node(),
    ObserverModifierNode,
    CompositionLocalConsumerModifierNode {

    // Place holder fling behavior, we'll initialize it when the density is available.
    val defaultFlingBehavior = DefaultFlingBehavior(splineBasedDecay(UnityDensity))

    override fun onAttach() {
        updateDefaultFlingBehavior()
        observeReads { currentValueOf(LocalDensity) } // monitor change in Density
    }

    override fun onObservedReadsChanged() {
        // if density changes, update the default fling behavior.
        updateDefaultFlingBehavior()
    }

    private fun updateDefaultFlingBehavior() {
        val density = currentValueOf(LocalDensity)
        defaultFlingBehavior.flingDecay = splineBasedDecay(density)
    }
}
CustomModifierSnippets.kt

动画修饰符

Modifier.Node 实现可以访问 coroutineScope。这允许使用Compose Animatable API。例如，此代码段修改了上面的 CircleNode，使其重复淡入淡出

class CircleNode(var color: Color) : Modifier.Node(), DrawModifierNode {
    private lateinit var alpha: Animatable<Float, AnimationVector1D>

    override fun ContentDrawScope.draw() {
        drawCircle(color = color, alpha = alpha.value)
        drawContent()
    }

    override fun onAttach() {
        alpha = Animatable(1f)
        coroutineScope.launch {
            alpha.animateTo(
                0f,
                infiniteRepeatable(tween(1000), RepeatMode.Reverse)
            ) {
            }
        }
    }
}
CustomModifierSnippets.kt

使用委托在修饰符之间共享状态

Modifier.Node 修饰符可以委托给其他节点。这有很多用例，例如从不同修饰符中提取通用实现，但它也可以用于在修饰符之间共享通用状态。

例如，一个可点击修饰符节点的基本实现，它共享交互数据

class ClickableNode : DelegatingNode() {
    val interactionData = InteractionData()
    val focusableNode = delegate(
        FocusableNode(interactionData)
    )
    val indicationNode = delegate(
        IndicationNode(interactionData)
    )
}
CustomModifierSnippets.kt

选择退出节点自动失效

当对应的 ModifierNodeElement 调用 update 时，Modifier.Node 节点会自动失效。有时，在更复杂的修饰符中，您可能希望选择退出此行为，以对修饰符何时使阶段失效进行更精细的控制。

如果您的自定义修饰符同时修改布局和绘图，这会特别有用。选择退出自动失效可让您仅在与绘图相关的属性（例如 color）更改时使绘图失效，而不使布局失效。这可以提高修饰符的性能。

下面显示了一个假设示例，其中一个修饰符具有 color、size 和 onClick lambda 作为属性。此修饰符仅使所需内容失效，并跳过任何不必要的失效

class SampleInvalidatingNode(
    var color: Color,
    var size: IntSize,
    var onClick: () -> Unit
) : DelegatingNode(), LayoutModifierNode, DrawModifierNode {
    override val shouldAutoInvalidate: Boolean
        get() = false

    private val clickableNode = delegate(
        ClickablePointerInputNode(onClick)
    )

    fun update(color: Color, size: IntSize, onClick: () -> Unit) {
        if (this.color != color) {
            this.color = color
            // Only invalidate draw when color changes
            invalidateDraw()
        }

        if (this.size != size) {
            this.size = size
            // Only invalidate layout when size changes
            invalidateMeasurement()
        }

        // If only onClick changes, we don't need to invalidate anything
        clickableNode.update(onClick)
    }

    override fun ContentDrawScope.draw() {
        drawRect(color)
    }

    override fun MeasureScope.measure(
        measurable: Measurable,
        constraints: Constraints
    ): MeasureResult {
        val size = constraints.constrain(size)
        val placeable = measurable.measure(constraints)
        return layout(size.width, size.height) {
            placeable.place(0, 0)
        }
    }
}
CustomModifierSnippets.kt

上一页
约束和修饰符顺序
下一页
修饰符列表