HarmonyOS（六）——@Builder装饰器_鸿蒙中@builder

前言

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

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

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

自定义构建函数（装饰器）使用说明

1:自定义组件内自定义构建函数：

定义的语法：

@Builder MyBuilderFunction({ ... })
1

使用方法：

this.MyBuilderFunction({ ... })
1

• 允许在自定义组件内定义一个或多个自定义构建函数，该函数被认为是该组件的私有、特殊类型的成员函数。
• 自定义构建函数可以在所属组件的build方法和其他自定义构建函数中调用，但不允许在组件外调用。
• 在自定义函数体中，this指代当前所属组件，组件的状态变量可以在自定义构建函数内访问。建议通过this访问自定义组件的状态变量而不是参数传递。

2:全局自定义构建函数

定义的语法：

@Builder function MyGlobalBuilderFunction({ ... })
1

使用方法：

MyGlobalBuilderFunction()
1

• 全局的自定义构建函数可以被整个应用获取，不允许使用this和bind方法。
• 如果不涉及组件状态变化，建议使用全局的自定义构建方法。

自定义构建函数参数传递规则

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

• 参数的类型必须与参数声明的类型一致，不允许undefined、null和返回undefined、null的表达式。
• 在自定义构建函数内部，不允许改变参数值。如果需要改变参数值，且同步回调用点，建议使用@Link。
• @Builder内UI语法遵循UI语法规则。（详细规则见如何创建自定义组件一文中build()函数描述详细细节）

1:按引用传递参数

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

ABuilder( $$ : { paramA1: string, paramB1 : string } );
1

举个例子：

@Builder function ABuilder($$: { paramA1: string }) {
  Row() {
    Text(`UseStateVarByReference: ${$$.paramA1} `)
  }
}
@Entry
@Component
struct Parent {
  @State label: string = 'Hello';
  build() {
    Column() {
      // 在Parent组件中调用ABuilder的时候，将this.label引用传递给ABuilder
      ABuilder({ paramA1: this.label })
      Button('Click me').onClick(() => {
        // 点击“Click me”后，UI从“Hello”刷新为“ArkUI”
        this.label = 'ArkUI';
      })
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

2:按值传递参数

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

举个例子：

@Builder function ABuilder(paramA1: string) {
  Row() {
    Text(`UseStateVarByValue: ${paramA1} `)
  }
}
@Entry
@Component
struct Parent {
  label: string = 'Hello';
  build() {
    Column() {
      ABuilder(this.label)
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

总结

1. @Builder装饰器一种更轻量的UI元素复用机制，@Builder所装饰的函数遵循build()函数语法规则，开发者可以将重复使用的UI元素抽象成一个方法，在build方法里调用。
2. @Builder装饰的函数也称为“自定义构建函数”。“自定义构建函数”又分为“自定义组件内自定义构建函数”和“全局自定义构建函数”，俩种构建函数使用机制不同，日常开发中我们可以更具俩种构建函数特性灵活选择使用那种类型的构建函数。
3. 自定义构建函数的参数传递有按值传递和按引用传递两种，均需遵守对应规则，具体规则见本文参数传递规则一节。
4. 按值传递和按引用传递使用时机不同，当使用状态变量的时候，推荐使用按引用传递。反之使用按值传递。