自定义

手动处理事件、渲染,自由地制作DSL组件。

框架提供两个公开的基座:Spacer() 构造一个空白组件(DslComponent),Scope() 构造一个容器(DslScope)。用 change 在基座上叠加自己的实现即可。

context(ctx: DslContext)
fun MyComponent(
    modifier: Modifier = Modifier,
    color: Color,
    id: Any
) = Spacer(modifier, id).change {
    object: DslComponent by it {
        var prop by local { false }

        override fun onPointer(event: PointerEvent): PointerResult {
            // 这里只处理自身;需要点击时可直接使用 clickable。
            return it.onPointer(event)
        }
    }
}

Spacer(modifier, id) 会创建组件并把它加入外部作用域(如Row,Box),change 则替换掉该组件的实现,槽位和身份都不变。在这里也可以使用local/stable/static等函数来存储状态。

如果想给一个已有组件加上行为,而不是自己创建组件,就不需要基座:

context(ctx: DslContext)
fun DslChild.myDecorator(
    color: Color
) = change {
    object: DslComponent by it {
        var prop by local { false }

        override fun onPointer(event: PointerEvent): PointerResult {
            // 这里只处理自身;需要点击时可直接使用 clickable。
            return it.onPointer(event)
        }
    }
}

向change传入一个(DslComponent) -> DslComponent,能override其中的函数,给一个已有组件加上装饰。

容器用Scope(),它的参数可以指定两个轴的空间分配方式(Box/Row/Column 就是常见的几种组合):

context(ctx: DslContext)
fun MyColumn(
    modifier: Modifier = Modifier,
    id: Any,
    function: DslFunction
) = Scope(modifier, id, Aligner.close(Align.MID), Aligner.weightedStrictByMin, function).change {
    object: DslScope by it as DslScope {
        override val contentMinWidth get() = 100.scaled
    }
}

接口委托

DslComponent是一个接口,Spacer 返回的是一个final类实现(容器的 Scope 同理)。接口委托可以达到接近于继承final类的效果:object: DslComponent by it 把一个对象的接口函数转发到另一个对象上,无论被转发的对象是final class,匿名object,还是普通的open class,都能转发并override其中的接口函数。

这种模式的好处是委托并不侵入修改原对象,减少了逻辑上的混乱。缺点是委托是编译期产生,如果接口有修改,需要重新编译(建议执行./gradlew clean避免编译缓存造成的bug)。

this super instance delegate的区别

DslComponent有instance这个成员。设计这个成员是因为每次委托都产生一个新对象,所以一级装饰无法获得后级装饰的结果。

override fun onPointer(event: PointerEvent): PointerResult {
    if (instance.focusable && event is PointerEvent.Down) {
        return PointerResult.HANDLED
    }
    return delegate.onPointer(event)
}

在下一级装饰中

override val focusable get() = true

如果不传instance,前一级装饰不知道组件的focusable已经被设为了true,造成逻辑错乱。

instance的值应该在build()前被正确设置,必须是已经加上全部装饰后的最终DslComponent对象。

delegate访问的是前一级装饰后的对象。这个名称不是固定的,比如前面的例子里是it。this访问的是当前装饰产生的对象。super访问的是接口,调用的是接口中的默认实现。instance是最终装饰完成的对象。

布局过程

build(),layoutHorizontal(),layoutVertical(),render()这四个函数会依次被调用。

构建一个组件时需要保证调用顺序,但是不需要一一对应。例如:LazyColumn在自身的layoutVertical()中才开始调用子组件的build(),因为此时才知道有哪些组件需要构建。

子控件需要实现outerMinHeight和outerMinWidth供外部读取,让父控件在layout时给它分配至少这么多空间(不一定遵循)。

先水平布局再竖直布局的原因是TextAutoFold需要先确定宽度,才知道高度。如果反过来调用,会导致outerMinHeight不能正确计算。

画矩形以外的形状

框架有两个绘制原语:四边形与三角形列表。矩形、贴图、九宫格都由四边形表达,任意三角形与多边形不在其中——仿射映射只能把矩形映成平行四边形。四边形与三角形列表各有无纹理、带纹理两个重载,格式由重载固定:

context(backend: DslRootRenderer<RP>, renderParam: RP)
override fun <RP> render() {
    // 凸多边形:一个顶点一种颜色,内部展开成三角扇
    backend.fillPolygon(points, colors)
    // 任意三角形表:每三个顶点一个三角形,`vertices`每顶点 2 个 Measure
    val vertices = MeasureArray(6)
    val colors = ColorArray(3)
    vertices[0] = 0.px
    // ...
    backend.renderTriangles(vertices, colors)
    // 带纹理时每顶点 4 个 Measure(x, y, u, v),并传入非空图片
}

fillPolygon每次调用都会重建类型化数组,适合偶尔绘制的图形;每帧都画的多边形应当自己复用MeasureArray与ColorArray。顶点和颜色只在调用期间有效,延迟后端必须自己拷一份。


Table of contents


This site uses Just the Docs, a documentation theme for Jekyll.