ArkTS学习笔记_封装复用之@builder装饰器

ArkTS学习笔记_封装复用之@builder装饰器

封装复用UI，除了常见的自定组件外，ArkUI还提供了一个轻量级的UI元素复用机制@Builder，@Builder所装饰的函数要遵循build()函数语法规则，开发者可以将重复使用的UI元素抽象成一个方法，以便在build方法里调用。
使用@Builder装饰的函数也称为“自定义构建函数”，主要作用是像方法一样封装共同的UI元素，方便调用复用。

一、语法格式和使用方法

// 语法格式
@Builder MyBuilderFunction(){ ... }

// 使用方法
this.MyBuilderFunction()

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

二、全局自定义构建函数

// 语法格式
@Builder function MyGlobalBuilderFunction(){ ... }

// 使用方法
MyGlobalBuilderFunction()

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

三、参数传递规则

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

• 参数的类型必须与参数声明的类型一致，不允许undefined、null和返回undefined、null的表达式。
• 在自定义构建函数内部，不允许改变参数值。如果需要改变参数值，且同步回调用点，建议使用@Link。
• @Builder内UI语法遵循UI语法规则。
• 只有传入一个参数，且参数需要直接传入对象字面量才会按引用传递该参数，其余传递方式均为按值传递。

（一）、按引用传递参数

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

@Builder function overBuilder($$: { paramA: string }) {
  Row() {
    Text(`传入的引用参数: ${$$.paramA} `)
  }
}

@Entry
@Component
struct Parent {
  @State label: string = 'Hello';
  build() {
    Column() {
      // 在Parent组件中调用overBuilder的时候，将this.label引用传递给overBuilder
      overBuilder({ paramA: this.label })
      Button('Click me').onClick(() => {
        // 点击“Click me”后，UI从“Hello”刷新为“ArkUI”
        this.label = 'ArkUI';
      })
    }
  }
}

（二）、按值传递参数

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

@Builder function overBuilder(paramA: string) {
  Row() {
    Text(`传入的形参: ${paramA} `)
  }
}

@Entry
@Component
struct Parent {
  @State label: string = 'Hello';
  build() {
    Column() {
      overBuilder(this.label)
    }
  }
}