本章内容概要

什么是自定义构建函数

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

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

如和使用装饰器

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

语法：

@Builder MyComponent(){}

使用方法

this.MyComponent()

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

完整代码

@Entry
@Component
struct BuilderNote {
  @State dataList:string[]=[
    '李白乘舟将欲行,',
    '忽闻岸上踏歌声.',
    '桃花潭水深千尺',
    '不及汪伦送我情'
  ]
//  定义自定义组件
  @Builder MyComponent(){
    Column(){
      List({space:20}){
        ForEach(this.dataList, (item)=>{
          ListItem(){
            Row(){
              Text(item).fontSize(20)
            }
          }
        })
      }
    }
  }
  build() {
    Row() {
      Column() {
        this.MyComponent()
      }
      .width('100%')
    }
    .height('100%')
  }
}

全局自定义构建函数

语法

@Builder function MyObj(){}

使用方法

MyObj()

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

完整代码

@Entry
  @Component
  struct BuilderNote {
    @State dataList:string[]=[
      '李白乘舟将欲行,',
      '忽闻岸上踏歌声.',
      '桃花潭水深千尺',
      '不及汪伦送我情'
    ]
    //  定义自定义组件
    @Builder MyComponent(){
      Column(){
        List({space:20}){
          ForEach(this.dataList, (item)=>{
            ListItem(){
              Row(){
                Text(item).fontSize(20)
              }
            }
          })
        }
      }
    }
    build() {
      Row() {
        Column({space:30}) {
          this.MyComponent()
          Divider().strokeWidth(5)
          MyObj()
        }
        .width('100%')
      }
      .height('100%')
    }
  }


// 全局自定义构建函数
@Builder function MyObj() {
  Text('这是全局自定义构建函数哦!!').fontSize(30)
}

效果演示

参数传递规则

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

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

按引用传递参数

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

语法

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

示例：

1. 定义传递参数

@State message:string ='按引用传参'

2. 将参数放在组件中进行传递

MyObj({childMsg: this.message})

3. 自定义组件接收参数并使用

// 全局自定义构建函数
@Builder function MyObj($$:{childMsg:string}) {
      Text($$.childMsg).fontSize(30)
}

4. 完整代码

@Entry
    @Component
    struct BuilderNote {
        @State dataList:string[]=[
            '李白乘舟将欲行,',
            '忽闻岸上踏歌声.',
            '桃花潭水深千尺',
            '不及汪伦送我情'
        ]
        @State message:string ='按引用传参'
        //  定义自定义组件
        @Builder MyComponent(){
            Column(){
                List({space:20}){
                    ForEach(this.dataList, (item)=>{
                        ListItem(){
                            Row(){
                                Text(item).fontSize(20)
                            }
                        }
                    })
                }
            }
        }
        build() {
            Row() {
                Column({space:30}) {
                    this.MyComponent()
                    Divider().strokeWidth(5)
                    MyObj({childMsg: this.message})
                }
                .width('100%')
            }
            .height('100%')
        }
    }


// 全局自定义构建函数
@Builder function MyObj($$:{childMsg:string}) {
    Text($$.childMsg).fontSize(30)
}

按值传递参数

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

1. 定义传递参数

  @State paramsData:string ='按值传递参数'

2. 将参数放在组件中进行传递

  Child(this.paramsData)

3. 自定义组件接收参数并使用

//全局自定义构建函数 - 按值传递参数
@Builder function Child(dataParams:string){
  Text(dataParams).fontSize(20)
}

4. 完整代码

@Entry
@Component
struct BuilderNote {
  @State dataList:string[]=[
    '李白乘舟将欲行,',
    '忽闻岸上踏歌声.',
    '桃花潭水深千尺',
    '不及汪伦送我情'
  ]
  @State message:string ='按引用传参'
  @State paramsData:string ='按值传递参数'
//  定义自定义组件
  @Builder MyComponent(){
    Column(){
      List({space:20}){
        ForEach(this.dataList, (item)=>{
          ListItem(){
            Row(){
              Text(item).fontSize(20)
            }
          }
        })
      }
    }
  }
  build() {
    Row() {
      Column({space:30}) {
        this.MyComponent()
        Divider().strokeWidth(5)
        MyObj({childMsg: this.message})
        Divider().strokeWidth(5)
        Child(this.paramsData)
      }
      .width('100%')
    }
    .height('100%')
  }
}


// 全局自定义构建函数
@Builder function MyObj($$:{childMsg:string}) {
      Text($$.childMsg).fontSize(30)
}

//全局自定义构建函数 - 按值传递参数
@Builder function Child(dataParams:string){
  Text(dataParams).fontSize(20)
}

5. 效果演示