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