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