OpenHarmony 自定义构建函数：@Builder 装饰器

2023-09-26
北京
本文字数：1350 字
阅读完需：约 4 分钟

前面章节介绍了如何创建一个自定义组件。该自定义组件内部 UI 结构固定，仅与使用方进行数据传递。ArkUI 还提供了一种更轻量的 UI 元素复用机制 @Builder，@Builder 所装饰的函数遵循 build()函数语法规则，开发者可以将重复使用的 UI 元素抽象成一个方法，在 build 方法里调用。

为了简化语言，我们将 @Builder 装饰的函数也称为“自定义构建函数”。

说明：

从 API version 9 开始，该装饰器支持在 ArkTS 卡片中使用。

装饰器使用说明

自定义组件内自定义构建函数

定义的语法：

@Builder MyBuilderFunction() { ... }

复制代码

使用方法：

this.MyBuilderFunction() { ... }

复制代码

● 允许在自定义组件内定义一个或多个自定义构建函数，该函数被认为是该组件的私有、特殊类型的成员函数。

● 自定义构建函数可以在所属组件的 build 方法和其他自定义构建函数中调用，但不允许在组件外调用。

● 在自定义函数体中，this 指代当前所属组件，组件的状态变量可以在自定义构建函数内访问。建议通过 this 访问自定义组件的状态变量而不是参数传递。

全局自定义构建函数

定义的语法：

@Builder function MyGlobalBuilderFunction() { ... }

复制代码

使用方法：

MyGlobalBuilderFunction()

复制代码

● 全局的自定义构建函数可以被整个应用获取，不允许使用 this 和 bind 方法。

● 如果不涉及组件状态变化，建议使用全局的自定义构建方法。

参数传递规则

自定义构建函数的参数传递有按值传递和按引用传递两种，均需遵守以下规则：

● 参数的类型必须与参数声明的类型一致，不允许 undefined、null 和返回 undefined、null 的表达式。

● 在 @Builder 修饰的函数内部，不允许改变参数值。

● @Builder 内 UI 语法遵循UI语法规则。

按引用传递参数

按引用传递参数时，传递的参数可为状态变量，且状态变量的改变会引起 @Builder 方法内的 UI 刷新。ArkUI 提供 $$作为按引用传递参数的范式。

class ABuilderParam {  paramA1: string = ''  paramB1: string = ''}
@Builder function ABuilder($$ : ABuilderParam) {...}class ABuilderParam {  paramA1: string = ''}
@Builder function ABuilder($$: ABuilderParam) {  Row() {    Text(`UseStateVarByReference: ${$$.paramA1} `)  }}@Entry@Componentstruct Parent {  @State label: string = 'Hello';  build() {    Column() {      // Pass the this.label reference to the ABuilder component when the ABuilder component is called in the Parent component.      ABuilder({ paramA1: this.label })      Button('Click me').onClick(() => {        // After Click me is clicked, the UI text changes from Hello to ArkUI.        this.label = 'ArkUI';      })    }  }}

复制代码

按值传递参数

调用 @Builder 装饰的函数默认按值传递。当传递的参数为状态变量时，状态变量的改变不会引起 @Builder 方法内的 UI 刷新。所以当使用状态变量的时候，推荐使用按引用传递。

@Builder function ABuilder(paramA1: string) {  Row() {    Text(`UseStateVarByValue: ${paramA1} `)  }}@Entry@Componentstruct Parent {  label: string = 'Hello';  build() {    Column() {      ABuilder(this.label)    }  }}

复制代码

发布于: 刚刚阅读数: 5

OpenHarmony开发者

关注

OpenHarmony开发者官方账号 2021-12-15 加入

OpenHarmony是由开放原子开源基金会（OpenAtom Foundation）孵化及运营的开源项目，目标是面向全场景、全连接、全智能时代，基于开源的方式，搭建一个智能终端设备操作系统的框架和平台，促进万物互联产业的繁荣发展

发布

暂无评论

创作场景

OpenHarmony 自定义构建函数：@Builder 装饰器

装饰器使用说明

自定义组件内自定义构建函数

全局自定义构建函数

参数传递规则

按引用传递参数

按值传递参数

OpenHarmony开发者

评论