• 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- 允许在自定义组件内定义一个或多个@Builder方法，该方法被认为是该组件的私有、特殊类型的成员函数。
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### 按引用传递参数
77
78按引用传递参数时，传递的参数可为状态变量，且状态变量的改变会引起\@Builder方法内的UI刷新。
79
80
81```ts
82class Tmp {
83  paramA1: string = ''
84  paramB1: string = ''
85}
86
87@Builder function overBuilder(params : Tmp) {...}
88```
89
90
91
92```ts
93class Tmp {
94  paramA1: string = ''
95}
96
97@Builder function overBuilder(params: Tmp) {
98  Row() {
99    Text(`UseStateVarByReference: ${params.paramA1} `)
100  }
101}
102@Entry
103@Component
104struct Parent {
105  @State label: string = 'Hello';
106  build() {
107    Column() {
108      // 在Parent组件中调用overBuilder的时候，将this.label引用传递给overBuilder
109      overBuilder({ paramA1: this.label })
110      Button('Click me').onClick(() => {
111        // 点击“Click me”后，UI从“Hello”刷新为“ArkUI”
112        this.label = 'ArkUI';
113      })
114    }
115  }
116}
117```
118
119
120按引用传递参数时，如果在\@Builder方法内调用自定义组件，ArkUI提供$$作为按引用传递参数的范式。
121
122```ts
123class Tmp {
124  paramA1: string = ''
125  paramB1: string = ''
126}
127
128@Builder function overBuilder($$ : Tmp) {...}
129```
130
131
132
133```ts
134class Tmp {
135  paramA1: string = ''
136}
137
138@Builder function overBuilder($$: Tmp) {
139  Row() {
140    Column() {
141      Text(`overBuilder===${$$.paramA1}`)
142      HelloComponent({message: $$.paramA1})
143    }
144  }
145}
146
147@Component
148struct HelloComponent {
149  @Link message: string;
150
151  build() {
152    Row() {
153      Text(`HelloComponent===${this.message}`)
154    }
155  }
156}
157
158@Entry
159@Component
160struct Parent {
161  @State label: string = 'Hello';
162  build() {
163    Column() {
164      // Pass the this.label reference to the overBuilder component when the overBuilder component is called in the Parent component.
165      overBuilder({paramA1: this.label})
166      Button('Click me').onClick(() => {
167        // After Click me is clicked, the UI text changes from Hello to ArkUI.
168        this.label = 'ArkUI';
169      })
170    }
171  }
172}
173```
174
175
176### 按值传递参数
177
178调用\@Builder装饰的函数默认按值传递。当传递的参数为状态变量时，状态变量的改变不会引起\@Builder方法内的UI刷新。所以当使用状态变量的时候，推荐使用[按引用传递](#按引用传递参数)。
179
180
181```ts
182@Builder function overBuilder(paramA1: string) {
183  Row() {
184    Text(`UseStateVarByValue: ${paramA1} `)
185  }
186}
187@Entry
188@Component
189struct Parent {
190  @State label: string = 'Hello';
191  build() {
192    Column() {
193      overBuilder(this.label)
194    }
195  }
196}
197```
198