ArkUI提供了一种轻量的UI元素复用机制@Builder，其内部UI结构固定，仅与使用方进行数据传递，开发者可以将重复使用的UI元素抽象成一个方法，在build方法里调用。

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

#装饰器使用说明

#私有自定义构建函数

定义的语法：

          
1
          @Builder MyBuilderFunction() {}

        

使用方法：

          
1
          this.MyBuilderFunction()

        

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

#全局自定义构建函数

定义的语法：

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

        

使用用法：

          
1
          MyGlobalBuilderFunction()

        

• 如果不涉及组件状态变化，建议使用全局的自定义构建方法。
• 全局自定义构建函数允许在build方法和其他自定义构建函数中调用。

#参数传递规则

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

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

#按引用传递参数

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

          
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
          class Tmp {
  paramA1: string = ''
}

@Builder function overBuilder(params: Tmp) {
  Row() {
    Text(`UseStateVarByReference: ${params.paramA1} `)
  }
}
@Entry
@Component
struct Parent {
  @State label: string = 'Hello';
  build() {
    Column() {
      // 在父组件中调用overBuilder组件时，
      // 把this.label通过引用传递的方式传给overBuilder组件。
      overBuilder({ paramA1: this.label })
      Button('Click me').onClick(() => {
        // 单击Click me后，UI文本从Hello更改为ArkUI。
        this.label = 'ArkUI';
      })
    }
  }
}

        

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

          
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
          class Tmp {
  paramA1: string = ''
}

@Builder function overBuilder($$: Tmp) {
  Row() {
    Column() {
      Text(`overBuilder===${$$.paramA1}`)
      HelloComponent({message: $$.paramA1})
    }
  }
}

@Component
struct HelloComponent {
  @Prop message: string;

  build() {
    Row() {
      Text(`HelloComponent===${this.message}`)
    }
  }
}

@Entry
@Component
struct Parent {
  @State label: string = 'Hello';
  build() {
    Column() {
      // 在父组件中调用overBuilder组件时，
      // 把this.label通过引用传递的方式传给overBuilder组件。
      overBuilder({paramA1: this.label})
      Button('Click me').onClick(() => {
        // 单击Click me后，UI文本从Hello更改为ArkUI。
        this.label = 'ArkUI';
      })
    }
  }
}

        

#按值传递参数

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

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

        

#注意

• @Builder通过按引用传递的方式传入参数，才会触发动态渲染UI，并且参数只能是一个。
• @Builder如果传入的参数是两个或两个以上，不会触发动态渲染UI。
• @Builder传入的参数中同时包含按值传递和按引用传递两种方式，不会触发动态渲染UI。
• @Builder的参数必须按照对象字面量的形式，把所需要的属性一一传入，才会触发动态渲染UI。