harmonyOS杂谈 - @Builder装饰器：自定义构建函数

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

装饰器使用说明

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

定义的语法：

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

// TODO 装饰器
@Entry
@Component
struct Page {
  @State message: string = 'Hello World'

  // 私有构造函数
  @Builder PrivateBuilderFunction() {
    Text(this.message)
      .fontSize(50)
      .fontWeight(FontWeight.Bold)
  }

  build() {
    Row() {
      Column() {
        // 构造函数调用
        this.PrivateBuilderFunction()
        publicBuilderFunction({ message: this.message })
        publicBuilderFunction2(this.message)
        Button("点击修改message").onClick(() => {
          this.message = "ArkTs"
        })
      }
      .width('100%')
    }
    .height('100%')
  }
}

// 全局构造函数
// 函数使用引用传递值，当传递的值变动的时候 Ui会跟刷新
@Builder function publicBuilderFunction($$: { message: String }) {
  Row() {
    // 使用$$ 来调用传入进来 的引用参数
    Text(`公共的构造函数，不允许申明在组件内${$$.message}`)
  }
}

// 函数默认按值传递，当传递的值变动的时候 Ui不会有变动
@Builder function publicBuilderFunction2(message: String) {
  Row() {
    Text(`不会刷新UI的值传递${message}`)
      .fontColor(Color.Red)
  }
}

运行截图：