48、鸿蒙/@Builder装饰器：自定义构建函数

ArkUI还提供了一种更轻量的UI元素复用机制@Builder，@Builder所装饰的函数遵循build()函数语法规则，开发者可以将重复使用的UI元素抽象成一个方法，在build方法里调用。

装饰器使用说明

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

定义的语法：

@Builder MyBuilderFunction() { ... }

使用方法：

this.MyBuilderFunction()

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

局部组件案例

@Component
export struct BuilderLayout {
  build() {
    this.myComponent()
  }

  // 自定义局部组件
  @Builder myComponent() {
    Row(){
      Column(){
        Text('首页')
      }.layoutWeight(1)
      Column(){
        Text('新闻')
      }.layoutWeight(1)
      Column(){
        Text('推荐')
      }.layoutWeight(1)
      Column(){
        Text('我的')
      }.layoutWeight(1)
    }.backgroundColor(Color.Gray)
    .height(60)
  }
}

效果

image.png

全局自定义构建函数

定义的语法：

@Builder function MyGlobalBuilderFunction() { ... }

使用方法：

MyGlobalBuilderFunction()

全局组件案例

// 全局组件
@Builder function qjComponent() {
  Row(){
    Column(){
      Text('首页1')
    }.layoutWeight(1)
    Column(){
      Text('新闻1')
    }.layoutWeight(1)
    Column(){
      Text('推荐1')
    }.layoutWeight(1)
    Column(){
      Text('我的1')
    }.layoutWeight(1)
  }.backgroundColor(Color.Orange)
  .height(60)
}

@Component
export struct BuilderLayout {
  build() {
    Column(){
      // 局部
      this.myComponent()
      // 全局
      qjComponent()
    }
  }

  // 自定义局部组件
  @Builder myComponent() {
    Row(){
      Column(){
        Text('首页')
      }.layoutWeight(1)
      Column(){
        Text('新闻')
      }.layoutWeight(1)
      Column(){
        Text('推荐')
      }.layoutWeight(1)
      Column(){
        Text('我的')
      }.layoutWeight(1)
    }.backgroundColor(Color.Gray)
    .height(60)
  }
}

效果

全局组件.png

参数传递规则

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

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

按引用传递参数

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

// 定义参数类型
class myParams {
  message: string = ''
}

@Component
export struct BuilderLayout {
  //
  @State homeTxt: string = '首页'
  build() {
    Column(){
      // 局部
      this.myComponent({ message: this.homeTxt})
      Button('点击改变首页').onClick((e)=>{
        this.homeTxt = 'Home'
        console.log('btn click', this.homeTxt);
      })
    }
  }

  // 自定义局部组件
  @Builder myComponent(params: myParams) {
    Row(){
      Column(){
        Text(`${params.message}`)
      }.layoutWeight(1)
      Column(){
        Text('新闻')
      }.layoutWeight(1)
      Column(){
        Text('推荐')
      }.layoutWeight(1)
      Column(){
        Text('我的')
      }.layoutWeight(1)
    }.backgroundColor(Color.Gray)
    .height(60)
  }
}

效果

引用参数.png

按引用传递参数时，如果在@Builder方法内调用自定义组件，ArkUI提供$$作为按引用传递参数的范式。

class myParams {
  message: string = ''
}

//
@Component
struct myCompoenent2 {
  // 接受从外部获取参数
  @Prop msg:string = ''
  build() {
    Text(this.msg)
  }
}

@Component
export struct BuilderLayout {
  //
  @State homeTxt: string = '首页'
  build() {
    Column(){
      // 局部
      this.myComponent({ message: this.homeTxt})
      Button('点击改变首页').onClick((e)=>{
        this.homeTxt = 'Home'
        console.log('btn click', this.homeTxt);
      })
      // 全局
      // qjComponent()
    }
  }

  // 自定义局部组件
  @Builder myComponent($$: myParams) {
    Row(){
      Column(){
        Text(`${$$.message}`)
        // 调用另外一个组件
        myCompoenent2({msg: $$.message});

      }.layoutWeight(1)
      Column(){
        Text('新闻')
      }.layoutWeight(1)
      Column(){
        Text('推荐')
      }.layoutWeight(1)
      Column(){
        Text('我的')
      }.layoutWeight(1)
    }.backgroundColor(Color.Gray)
    .height(60)
  }
}

效果

$$值引用.png

按值传递参数

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

@Component
export struct BuilderLayout {
  //
  @State homeTxt: string = '首页'
  build() {
    Column(){
      // 局部
      this.myComponent(this.homeTxt)
      Button('点击不改变首页').onClick((e)=>{
        this.homeTxt = 'Home'
        console.log('btn click', this.homeTxt);
      })
    }
  }

  // 自定义局部组件
  @Builder myComponent(homeTxt: string) {
    Row(){
      Column(){
        Text(`${homeTxt}`)
      }.layoutWeight(1)
      Column(){
        Text('新闻')
      }.layoutWeight(1)
      Column(){
        Text('推荐')
      }.layoutWeight(1)
      Column(){
        Text('我的')
      }.layoutWeight(1)
    }.backgroundColor(Color.Gray)
    .height(60)
  }
}

效果

按值引用.png