• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# \@Builder装饰器：自定义构建函数
2
3
4前面章节介绍了如何创建一个自定义组件。该自定义组件内部UI结构固定，仅与使用方进行数据传递。ArkUI还提供了一种更轻量的UI元素复用机制\@Builder，\@Builder所装饰的函数遵循build()函数语法规则，开发者可以将重复使用的UI元素抽象成一个方法，在build方法里调用。
5
6
7为了简化语言，我们将\@Builder装饰的函数也称为“自定义构建函数”。
8
9
10> **说明：**
11>
12> 从API version 9开始，该装饰器支持在ArkTS卡片中使用。
13
14
15## 装饰器使用说明
16
17
18### 自定义组件内自定义构建函数
19
20定义的语法：
21
22
23```ts
24@Builder MyBuilderFunction() { ... }
25```
26
27使用方法：
28
29
30```ts
31this.MyBuilderFunction() { ... }
32```
33
34- 允许在自定义组件内定义一个或多个自定义构建函数，该函数被认为是该组件的私有、特殊类型的成员函数。
35
36- 自定义构建函数可以在所属组件的build方法和其他自定义构建函数中调用，但不允许在组件外调用。
37
38- 在自定义函数体中，this指代当前所属组件，组件的状态变量可以在自定义构建函数内访问。建议通过this访问自定义组件的状态变量而不是参数传递。
39
40
41### 全局自定义构建函数
42
43定义的语法：
44
45
46```ts
47@Builder function MyGlobalBuilderFunction() { ... }
48```
49
50使用方法：
51
52
53```ts
54MyGlobalBuilderFunction()
55```
56
57
58- 全局的自定义构建函数可以被整个应用获取，不允许使用this和bind方法。
59
60- 如果不涉及组件状态变化，建议使用全局的自定义构建方法。
61
62
63## 参数传递规则
64
65自定义构建函数的参数传递有[按值传递](#按值传递参数)和[按引用传递](#按引用传递参数)两种，均需遵守以下规则：
66
67- 参数的类型必须与参数声明的类型一致，不允许undefined、null和返回undefined、null的表达式。
68
69- 在@Builder修饰的函数内部，不允许改变参数值。
70
71- \@Builder内UI语法遵循[UI语法规则](arkts-create-custom-components.md#build函数)。
72
73
74### 按引用传递参数
75
76按引用传递参数时，传递的参数可为状态变量，且状态变量的改变会引起\@Builder方法内的UI刷新。ArkUI提供$$作为按引用传递参数的范式。
77
78
79```ts
80class ABuilderParam {
81  paramA1: string = ''
82  paramB1: string = ''
83}
84
85@Builder function ABuilder($$ : ABuilderParam) {...}
86```
87
88
89
90```ts
91class ABuilderParam {
92  paramA1: string = ''
93}
94
95@Builder function ABuilder($$: ABuilderParam) {
96  Row() {
97    Text(`UseStateVarByReference: ${$$.paramA1} `)
98  }
99}
100@Entry
101@Component
102struct Parent {
103  @State label: string = 'Hello';
104  build() {
105    Column() {
106      // 在Parent组件中调用ABuilder的时候，将this.label引用传递给ABuilder
107      ABuilder({ paramA1: this.label })
108      Button('Click me').onClick(() => {
109        // 点击“Click me”后，UI从“Hello”刷新为“ArkUI”
110        this.label = 'ArkUI';
111      })
112    }
113  }
114}
115```
116
117
118### 按值传递参数
119
120调用\@Builder装饰的函数默认按值传递。当传递的参数为状态变量时，状态变量的改变不会引起\@Builder方法内的UI刷新。所以当使用状态变量的时候，推荐使用[按引用传递](#按引用传递参数)。
121
122
123```ts
124@Builder function ABuilder(paramA1: string) {
125  Row() {
126    Text(`UseStateVarByValue: ${paramA1} `)
127  }
128}
129@Entry
130@Component
131struct Parent {
132  label: string = 'Hello';
133  build() {
134    Column() {
135      ABuilder(this.label)
136    }
137  }
138}
139```
140