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 22```ts 23@Component 24struct HelloComponent { 25 @State message: string = 'Hello, World!'; 26 27 build() { 28 // HelloComponent自定义组件组合系统组件Row和Text 29 Row() { 30 Text(this.message) 31 .onClick(() => { 32 // 状态变量message的改变驱动UI刷新，UI从'Hello, World!'刷新为'Hello, ArkUI!' 33 this.message = 'Hello, ArkUI!'; 34 }) 35 } 36 } 37} 38``` 39> **注意：** 40> 41> 如果在另外的文件中引用该自定义组件，需要使用export关键字导出，并在使用的页面import该自定义组件。 42 43HelloComponent可以在其他自定义组件中的build()函数中多次创建，实现自定义组件的重用。 44 45 46 47```ts 48@Entry 49@Component 50struct ParentComponent { 51 build() { 52 Column() { 53 Text('ArkUI message') 54 HelloComponent({ message: 'Hello World!' }); 55 Divider() 56 HelloComponent({ message: '你好，世界!' }); 57 } 58 } 59} 60``` 61 62 63要完全理解上面的示例，需要了解自定义组件的以下概念定义，本文将在后面的小节中介绍： 64 65 66- [自定义组件的基本结构](#自定义组件的基本结构) 67 68- [成员函数/变量](#成员函数变量) 69 70- [自定义组件的参数规定](#自定义组件的参数规定) 71 72- [build()函数](#build函数) 73 74- [自定义组件通用样式](#自定义组件通用样式) 75 76 77## 自定义组件的基本结构 78 79- struct：自定义组件基于struct实现，struct + 自定义组件名 + {...}的组合构成自定义组件，不能有继承关系。对于struct的实例化，可以省略new。 80 > **说明：** 81 > 82 > 自定义组件名、类名、函数名不能和系统组件名相同。 83 84- \@Component：\@Component装饰器仅能装饰struct关键字声明的数据结构。struct被\@Component装饰后具备组件化的能力，需要实现build方法描述UI，一个struct只能被一个\@Component装饰。\@Component可以接受一个可选的bool类型参数。 85 > **说明：** 86 > 87 > 从API version 9开始，该装饰器支持在ArkTS卡片中使用。 88 > 89 > 从API version 11开始，\@Component可以接受一个可选的bool类型参数。 90 91 ```ts 92 @Component 93 struct MyComponent { 94 } 95 ``` 96 97 ### freezeWhenInactive<sup>11+</sup> 98 [组件冻结](arkts-custom-components-freeze.md)选项。 99 100 | 名称 | 类型 | 必填 | 说明 | 101 | ------ | ------ | ---- | ------------------------------------------------------------ | 102 | freezeWhenInactive | bool | 否 | 是否开启组件冻结。 | 103 104 ```ts 105 @Component({ freezeWhenInactive: true }) 106 struct MyComponent { 107 } 108 ``` 109 110- build()函数：build()函数用于定义自定义组件的声明式UI描述，自定义组件必须定义build()函数。 111 112 ```ts 113 @Component 114 struct MyComponent { 115 build() { 116 } 117 } 118 ``` 119 120- \@Entry：\@Entry装饰的自定义组件将作为UI页面的入口。在单个UI页面中，最多可以使用\@Entry装饰一个自定义组件。\@Entry可以接受一个可选的[LocalStorage](arkts-localstorage.md)的参数。 121 122 > **说明：** 123 > 124 > 从API version 9开始，该装饰器支持在ArkTS卡片中使用。 125 > 126 > 从API version 10开始，\@Entry可以接受一个可选的[LocalStorage](arkts-localstorage.md)的参数或者一个可选的[EntryOptions](#entryOptions)参数。 127 > 128 > 从API version 11开始，该装饰器支持在原子化服务中使用。 129 130 ```ts 131 @Entry 132 @Component 133 struct MyComponent { 134 } 135 ``` 136 137 ### EntryOptions<sup>10+</sup> 138 139 命名路由跳转选项。 140 141 | 名称 | 类型 | 必填 | 说明 | 142 | ------ | ------ | ---- | ------------------------------------------------------------ | 143 | routeName | string | 否 | 表示作为命名路由页面的名字。 | 144 | storage | [LocalStorage](arkts-localstorage.md) | 否 | 页面级的UI状态存储。 | 145 | useSharedStorage<sup>12+</sup> | boolean | 否 | 是否使用LocalStorage.getShared()接口返回的[LocalStorage](arkts-localstorage.md)实例对象，默认值false。 | 146 147 > **说明：** 148 > 149 > 当useSharedStorage设置为true，并且storage又被赋值时，useSharedStorage的值优先级更高。 150 151 ```ts 152 @Entry({ routeName : 'myPage' }) 153 @Component 154 struct MyComponent { 155 } 156 ``` 157 158 159- \@Reusable：\@Reusable装饰的自定义组件具备可复用能力 160 161 > **说明：** 162 > 163 > 从API version 10开始，该装饰器支持在ArkTS卡片中使用。 164 165 ```ts 166 @Reusable 167 @Component 168 struct MyComponent { 169 } 170 ``` 171 172 173## 成员函数/变量 174 175自定义组件除了必须要实现build()函数外，还可以实现其他成员函数，成员函数具有以下约束： 176 177 178- 自定义组件的成员函数为私有的，且不建议声明成静态函数。 179 180 181自定义组件可以包含成员变量，成员变量具有以下约束： 182 183 184- 自定义组件的成员变量为私有的，且不建议声明成静态变量。 185 186- 自定义组件的成员变量本地初始化有些是可选的，有些是必选的。具体是否需要本地初始化，是否需要从父组件通过参数传递初始化子组件的成员变量，请参考[状态管理](arkts-state-management-overview.md)。 187 188 189## 自定义组件的参数规定 190 191从上文的示例中，我们已经了解到，可以在build方法里创建自定义组件，在创建自定义组件的过程中，根据装饰器的规则来初始化自定义组件的参数。 192 193 194```ts 195@Component 196struct MyComponent { 197 private countDownFrom: number = 0; 198 private color: Color = Color.Blue; 199 200 build() { 201 } 202} 203 204@Entry 205@Component 206struct ParentComponent { 207 private someColor: Color = Color.Pink; 208 209 build() { 210 Column() { 211 // 创建MyComponent实例，并将创建MyComponent成员变量countDownFrom初始化为10，将成员变量color初始化为this.someColor 212 MyComponent({ countDownFrom: 10, color: this.someColor }) 213 } 214 } 215} 216``` 217 218下面的示例代码将父组件中的函数传递给子组件，并在子组件中调用。 219 220```ts 221@Entry 222@Component 223struct Parent { 224 @State cnt: number = 0 225 submit: () => void = () => { 226 this.cnt++; 227 } 228 229 build() { 230 Column() { 231 Text(`${this.cnt}`) 232 Son({ submitArrow: this.submit }) 233 } 234 } 235} 236 237@Component 238struct Son { 239 submitArrow?: () => void 240 241 build() { 242 Row() { 243 Button('add') 244 .width(80) 245 .onClick(() => { 246 if (this.submitArrow) { 247 this.submitArrow() 248 } 249 }) 250 } 251 .height(56) 252 } 253} 254``` 255 256## build()函数 257 258所有声明在build()函数的语句，我们统称为UI描述，UI描述需要遵循以下规则： 259 260- \@Entry装饰的自定义组件，其build()函数下的根节点唯一且必要，且必须为容器组件，其中ForEach禁止作为根节点。 261 \@Component装饰的自定义组件，其build()函数下的根节点唯一且必要，可以为非容器组件，其中ForEach禁止作为根节点。 262 263 ```ts 264 @Entry 265 @Component 266 struct MyComponent { 267 build() { 268 // 根节点唯一且必要，必须为容器组件 269 Row() { 270 ChildComponent() 271 } 272 } 273 } 274 275 @Component 276 struct ChildComponent { 277 build() { 278 // 根节点唯一且必要，可为非容器组件 279 Image('test.jpg') 280 } 281 } 282 ``` 283 284- 不允许声明本地变量，反例如下。 285 286 ```ts 287 build() { 288 // 反例：不允许声明本地变量 289 let a: number = 1; 290 } 291 ``` 292 293- 不允许在UI描述里直接使用console.info，但允许在方法或者函数里使用，反例如下。 294 295 ```ts 296 build() { 297 // 反例：不允许console.info 298 console.info('print debug log'); 299 } 300 ``` 301 302- 不允许创建本地的作用域，反例如下。 303 304 ```ts 305 build() { 306 // 反例：不允许本地作用域 307 { 308 ... 309 } 310 } 311 ``` 312 313- 不允许调用没有用\@Builder装饰的方法，允许系统组件的参数是TS方法的返回值。 314 315 ```ts 316 @Component 317 struct ParentComponent { 318 doSomeCalculations() { 319 } 320 321 calcTextValue(): string { 322 return 'Hello World'; 323 } 324 325 @Builder doSomeRender() { 326 Text(`Hello World`) 327 } 328 329 build() { 330 Column() { 331 // 反例：不能调用没有用@Builder装饰的方法 332 this.doSomeCalculations(); 333 // 正例：可以调用 334 this.doSomeRender(); 335 // 正例：参数可以为调用TS方法的返回值 336 Text(this.calcTextValue()) 337 } 338 } 339 } 340 ``` 341 342- 不允许使用switch语法，如果需要使用条件判断，请使用[if](./arkts-rendering-control-ifelse.md)。示例如下。 343 344 ```ts 345 build() { 346 Column() { 347 // 反例：不允许使用switch语法 348 switch (expression) { 349 case 1: 350 Text('...') 351 break; 352 case 2: 353 Image('...') 354 break; 355 default: 356 Text('...') 357 break; 358 } 359 // 正例：使用if 360 if(expression == 1) { 361 Text('...') 362 } else if(expression == 2) { 363 Image('...') 364 } else { 365 Text('...') 366 } 367 } 368 } 369 ``` 370 371- 不允许使用表达式，请使用if组件，示例如下。 372 373 ```ts 374 build() { 375 Column() { 376 // 反例：不允许使用表达式 377 (this.aVar > 10) ? Text('...') : Image('...') 378 379 // 正例：使用if判断 380 if(this.aVar > 10) { 381 Text('...') 382 } else { 383 Image('...') 384 } 385 } 386 } 387 ``` 388 389- 不允许直接改变状态变量，反例如下。详细分析见[\@State常见问题：不允许在build里改状态变量](./arkts-state.md#不允许在build里改状态变量) 390 391 ```ts 392 @Component 393 struct CompA { 394 @State col1: Color = Color.Yellow; 395 @State col2: Color = Color.Green; 396 @State count: number = 1; 397 build() { 398 Column() { 399 // 应避免直接在Text组件内改变count的值 400 Text(`${this.count++}`) 401 .width(50) 402 .height(50) 403 .fontColor(this.col1) 404 .onClick(() => { 405 this.col2 = Color.Red; 406 }) 407 Button("change col1").onClick(() =>{ 408 this.col1 = Color.Pink; 409 }) 410 } 411 .backgroundColor(this.col2) 412 } 413 } 414 ``` 415 416 在ArkUI状态管理中，状态驱动UI更新。 417 418  419 420 所以，不能在自定义组件的build()或\@Builder方法里直接改变状态变量，这可能会造成循环渲染的风险。Text('${this.count++}')在全量更新或最小化更新会产生不同的影响： 421 422 - 全量更新（API8及以前版本）： ArkUI可能会陷入一个无限的重渲染的循环里，因为Text组件的每一次渲染都会改变应用的状态，就会再引起下一轮渲染的开启。 当 this.col2 更改时，都会执行整个build构建函数，因此，Text(`${this.count++}`)绑定的文本也会更改，每次重新渲染Text(`${this.count++}`)，又会使this.count状态变量更新，导致新一轮的build执行，从而陷入无限循环。 423 - 最小化更新（API9-至今版本）： 当 this.col2 更改时，只有Column组件会更新，Text组件不会更改。 只当 this.col1 更改时，会去更新整个Text组件，其所有属性函数都会执行，所以会看到Text(`${this.count++}`)自增。因为目前UI以组件为单位进行更新，如果组件上某一个属性发生改变，会更新整体的组件。所以整体的更新链路是：this.col1 = Color.Pink -> Text组件整体更新->this.count++ ->Text组件整体更新。值得注意的是，这种写法在初次渲染时会导致Text组件渲染两次，从而对性能产生影响。 424 425 build函数中更改应用状态的行为可能会比上面的示例更加隐蔽，比如： 426 427 - 在\@Builder，\@Extend或\@Styles方法内改变状态变量 。 428 429 - 在计算参数时调用函数中改变应用状态变量，例如 Text('${this.calcLabel()}')。 430 431 - 对当前数组做出修改，sort()改变了数组this.arr，随后的filter方法会返回一个新的数组。 432 433 ```ts 434 // 反例 435 @State arr : Array<...> = [ ... ]; 436 ForEach(this.arr.sort().filter(...), 437 item => { 438 ... 439 }) 440 // 正确的执行方式为：filter返回一个新数组，后面的sort方法才不会改变原数组this.arr 441 ForEach(this.arr.filter(...).sort(), 442 item => { 443 ... 444 }) 445 ``` 446 447## 自定义组件通用样式 448 449自定义组件通过“.”链式调用的形式设置通用样式。 450 451 452```ts 453@Component 454struct MyComponent2 { 455 build() { 456 Button(`Hello World`) 457 } 458} 459 460@Entry 461@Component 462struct MyComponent { 463 build() { 464 Row() { 465 MyComponent2() 466 .width(200) 467 .height(300) 468 .backgroundColor(Color.Red) 469 } 470 } 471} 472``` 473 474> **说明：** 475> 476> ArkUI给自定义组件设置样式时，相当于给MyComponent2套了一个不可见的容器组件，而这些样式是设置在容器组件上的，而非直接设置给MyComponent2的Button组件。通过渲染结果我们可以很清楚的看到，背景颜色红色并没有直接生效在Button上，而是生效在Button所处的开发者不可见的容器组件上。 477 478<!--no_check--> 479
