• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 创建自定义组件
2
3
4在ArkUI中，UI显示的内容均为组件，由框架直接提供的称为系统组件，由开发者定义的称为自定义组件。在进行 UI 界面开发时，通常不是简单的将系统组件进行组合使用，而是需要考虑代码可复用性、业务逻辑与UI分离，后续版本演进等因素。因此，将UI和部分业务逻辑封装成自定义组件是不可或缺的能力。
5
6
7自定义组件具有以下特点：
8
9
10- 可组合：允许开发者组合使用系统组件、及其属性和方法。
11
12- 可重用：自定义组件可以被其他组件重用，并作为不同的实例在不同的父组件或容器中使用。
13
14- 数据驱动UI更新：通过状态变量的改变，来驱动UI的刷新。
15
16
17以下示例展示了自定义组件的基本用法。
18
19
20
21```ts
22@Component
23struct HelloComponent {
24  @State message: string = 'Hello, World!';
25
26  build() {
27    // HelloComponent自定义组件组合系统组件Row和Text
28    Row() {
29      Text(this.message)
30        .onClick(() => {
31          // 状态变量message的改变驱动UI刷新，UI从'Hello, World!'刷新为'Hello, ArkUI!'
32          this.message = 'Hello, ArkUI!';
33        })
34    }
35  }
36}
37```
38
39
40HelloComponent可以在其他自定义组件中的build()函数中多次创建，实现自定义组件的重用。
41
42
43
44```ts
45@Entry
46@Component
47struct ParentComponent {
48  build() {
49    Column() {
50      Text('ArkUI message')
51      HelloComponent({ message: 'Hello, World!' });
52      Divider()
53      HelloComponent({ message: '你好!' });
54    }
55  }
56}
57```
58
59
60要完全理解上面的示例，需要了解自定义组件的以下概念定义，本文将在后面的小节中介绍：
61
62
63- [自定义组件的基本结构](#自定义组件的基本结构)
64
65- [成员函数/变量](#成员函数变量)
66
67- [自定义组件的参数规定](#自定义组件的参数规定)
68
69- [build()函数](#build函数)
70
71- [自定义组件通用样式](#自定义组件通用样式)
72
73- [自定义属性方法](#自定义属性方法)
74
75
76## 自定义组件的基本结构
77
78- struct：自定义组件基于struct实现，struct + 自定义组件名 + {...}的组合构成自定义组件，不能有继承关系。对于struct的实例化，可以省略new。
79  > **说明：**
80  >
81  > 自定义组件名、类名、函数名不能和系统组件名相同。
82
83- \@Component：\@Component装饰器仅能装饰struct关键字声明的数据结构。struct被\@Component装饰后具备组件化的能力，需要实现build方法描述UI，一个struct只能被一个\@Component装饰。
84  > **说明：**
85  >
86  > 从API version 9开始，该装饰器支持在ArkTS卡片中使用。
87
88  ```ts
89  @Component
90  struct MyComponent {
91  }
92  ```
93
94- build()函数：build()函数用于定义自定义组件的声明式UI描述，自定义组件必须定义build()函数。
95
96  ```ts
97  @Component
98  struct MyComponent {
99    build() {
100    }
101  }
102  ```
103
104- \@Entry：\@Entry装饰的自定义组件将作为UI页面的入口。在单个UI页面中，最多可以使用\@Entry装饰一个自定义组件。\@Entry可以接受一个可选的[LocalStorage](arkts-localstorage.md)的参数。
105
106  > **说明：**
107  >
108  > 从API version 9开始，该装饰器支持在ArkTS卡片中使用。
109
110  ```ts
111  @Entry
112  @Component
113  struct MyComponent {
114  }
115  ```
116
117
118## 成员函数/变量
119
120自定义组件除了必须要实现build()函数外，还可以实现其他成员函数，成员函数具有以下约束：
121
122
123- 不支持静态函数。
124
125- 成员函数的访问始终是私有的。
126
127
128自定义组件可以包含成员变量，成员变量具有以下约束：
129
130
131- 不支持静态成员变量。
132
133- 所有成员变量都是私有的，变量的访问规则与成员函数的访问规则相同。
134
135- 自定义组件的成员变量本地初始化有些是可选的，有些是必选的。具体是否需要本地初始化，是否需要从父组件通过参数传递初始化子组件的成员变量，请参考[状态管理](arkts-state-management-overview.md)。
136
137
138## 自定义组件的参数规定
139
140从上文的示例中，我们已经了解到，可以在build方法或者[@Builder](arkts-builder.md)装饰的函数里创建自定义组件，在创建的过程中，参数可以被提供给组件。
141
142
143```ts
144@Component
145struct MyComponent {
146  private countDownFrom: number = 0;
147  private color: Color = Color.Blue;
148
149  build() {
150  }
151}
152
153@Entry
154@Component
155struct ParentComponent {
156  private someColor: Color = Color.Pink;
157
158  build() {
159    Column() {
160      // 创建MyComponent实例，并将创建MyComponent成员变量countDownFrom初始化为10，将成员变量color初始化为this.someColor
161      MyComponent({ countDownFrom: 10, color: this.someColor })
162    }
163  }
164}
165```
166
167
168## build()函数
169
170所有声明在build()函数的语言，我们统称为UI描述语言，UI描述语言需要遵循以下规则：
171
172- \@Entry装饰的自定义组件，其build()函数下的根节点唯一且必要，且必须为容器组件，其中ForEach禁止作为根节点。
173  \@Component装饰的自定义组件，其build()函数下的根节点唯一且必要，可以为非容器组件，其中ForEach禁止作为根节点。
174
175  ```ts
176  @Entry
177  @Component
178  struct MyComponent {
179    build() {
180      // 根节点唯一且必要，必须为容器组件
181      Row() {
182        ChildComponent()
183      }
184    }
185  }
186
187  @Component
188  struct ChildComponent {
189    build() {
190      // 根节点唯一且必要，可为非容器组件
191      Image('test.jpg')
192    }
193  }
194  ```
195
196- 不允许声明本地变量，反例如下。
197
198  ```ts
199  build() {
200    // 反例：不允许声明本地变量
201    let a: number = 1;
202  }
203  ```
204
205- 不允许在UI描述里直接使用console.info，但允许在方法或者函数里使用，反例如下。
206
207  ```ts
208  build() {
209    // 反例：不允许console.info
210    console.info('print debug log');
211  }
212  ```
213
214- 不允许创建本地的作用域，反例如下。
215
216  ```ts
217  build() {
218    // 反例：不允许本地作用域
219    {
220      ...
221    }
222  }
223  ```
224
225- 不允许调用除了被\@Builder装饰以外的方法，允许系统组件的参数是TS方法的返回值。
226
227  ```ts
228  @Component
229  struct ParentComponent {
230    doSomeCalculations() {
231    }
232
233    calcTextValue(): string {
234      return 'Hello World';
235    }
236
237    @Builder doSomeRender() {
238      Text(`Hello World`)
239    }
240
241    build() {
242      Column() {
243        // 反例：不能调用没有用@Builder装饰的方法
244        this.doSomeCalculations();
245        // 正例：可以调用
246        this.doSomeRender();
247        // 正例：参数可以为调用TS方法的返回值
248        Text(this.calcTextValue())
249      }
250    }
251  }
252  ```
253
254- 不允许switch语法，如果需要使用条件判断，请使用if。反例如下。
255
256  ```ts
257  build() {
258    Column() {
259      // 反例：不允许使用switch语法
260      switch (expression) {
261        case 1:
262          Text('...')
263          break;
264        case 2:
265          Image('...')
266          break;
267        default:
268          Text('...')
269          break;
270      }
271    }
272  }
273  ```
274
275- 不允许使用表达式，反例如下。
276
277  ```ts
278  build() {
279    Column() {
280      // 反例：不允许使用表达式
281      (this.aVar > 10) ? Text('...') : Image('...')
282    }
283  }
284  ```
285
286
287## 自定义组件通用样式
288
289自定义组件通过“.”链式调用的形式设置通用样式。
290
291
292```ts
293@Component
294struct MyComponent2 {
295  build() {
296    Button(`Hello World`)
297  }
298}
299
300@Entry
301@Component
302struct MyComponent {
303  build() {
304    Row() {
305      MyComponent2()
306        .width(200)
307        .height(300)
308        .backgroundColor(Color.Red)
309    }
310  }
311}
312```
313
314> **说明：**
315>
316> ArkUI给自定义组件设置样式时，相当于给MyComponent2套了一个不可见的容器组件，而这些样式是设置在容器组件上的，而非直接设置给MyComponent2的Button组件。通过渲染结果我们可以很清楚的看到，背景颜色红色并没有直接生效在Button上，而是生效在Button所处的开发者不可见的容器组件上。
317
318
319## 自定义属性方法
320
321自定义组件不支持提供自定义属性方法，可以借助类似Controller控制器能力，提供自定义接口。
322
323
324```ts
325// 自定义controller
326export class MyComponentController {
327  item: MyComponent = null;
328
329  setItem(item: MyComponent) {
330    this.item = item;
331  }
332
333  changeText(value: string) {
334    this.item.value = value;
335  }
336}
337
338// 自定义组件
339@Component
340export default struct MyComponent {
341  public controller: MyComponentController = null;
342  @State value: string = 'Hello World';
343
344  build() {
345    Column() {
346      Text(this.value)
347        .fontSize(50)
348    }
349  }
350
351  aboutToAppear() {
352    if (this.controller)
353      this.controller.setItem(this); // 绑定controller
354  }
355}
356
357// 使用处逻辑
358@Entry
359@Component
360struct StyleExample {
361  controller = new MyComponentController();
362
363  build() {
364    Column() {
365      MyComponent({ controller: this.controller })
366    }
367    .onClick(() => {
368      this.controller.changeText('Text');
369    })
370  }
371}
372```
373
374在上面的示例中：
375
3761. 通过子组件MyComponent的aboutToAppear方法，把当前的this指针传递给MyComponentController的item成员变量。
377
3782. 在StyleExample父组件中持有controller实例，调用controller的changeText方法，即相当于通过controller持有的MyComponent子组件的this指针，改变MyComponent的状态变量value的值。
379
380通过controller的封装，MyComponent对外暴露了changeText的接口，所有持有controller的实例都可以通过调用changeText接口，改变MyComponent的状态变量value的值。
381