HarmonyOS之UI范式：创建自定义组件
★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★
➤博客园地址：为敢技术（https://www.cnblogs.com/strengthen/ ）
➤GitHub地址：https://github.com/strengthen
➤原文地址：https://www.cnblogs.com/strengthen/p/18472575
➤如果链接不是为敢技术的博客园地址，则可能是爬取作者的文章。
➤原文已修改更新！强烈建议点击原文地址阅读！支持作者！支持原创！
★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★
在ArkUI中，UI显示的内容均为组件，由框架直接提供的称为系统组件，由开发者定义的称为自定义组件。在进行 UI 界面开发时，通常不是简单的将系统组件进行组合使用，而是需要考虑代码可复用性、业务逻辑与UI分离，后续版本演进等因素。因此，将UI和部分业务逻辑封装成自定义组件是不可或缺的能力。
自定义组件具有以下特点：
-
可组合：允许开发者组合使用系统组件、及其属性和方法。
-
可重用：自定义组件可以被其他组件重用，并作为不同的实例在不同的父组件或容器中使用。
-
数据驱动UI更新：通过状态变量的改变，来驱动UI的刷新。
自定义组件的基本用法
以下示例展示了自定义组件的基本用法。
@Component struct HelloComponent { @State message: string = 'Hello, World!'; build() { // HelloComponent自定义组件组合系统组件Row和Text Row() { Text(this.message) .onClick(() => { // 状态变量message的改变驱动UI刷新，UI从'Hello, World!'刷新为'Hello, ArkUI!' this.message = 'Hello, ArkUI!'; }) } } }
如果在另外的文件中引用该自定义组件，需要使用export关键字导出，并在使用的页面import该自定义组件。
HelloComponent可以在其他自定义组件中的build()函数中多次创建，实现自定义组件的重用。
@Entry @Component struct ParentComponent { build() { Column() { Text('ArkUI message') HelloComponent({ message: 'Hello World!' }); Divider() HelloComponent({ message: '你好，世界!' }); } } }
要完全理解上面的示例，需要了解自定义组件的以下概念定义，本文将在后面的小节中介绍：
自定义组件的基本结构
-
struct：自定义组件基于struct实现，struct + 自定义组件名 + {...}的组合构成自定义组件，不能有继承关系。对于struct的实例化，可以省略new。
说明自定义组件名、类名、函数名不能和系统组件名相同。
-
@Component：@Component装饰器仅能装饰struct关键字声明的数据结构。struct被@Component装饰后具备组件化的能力，需要实现build方法描述UI，一个struct只能被一个@Component装饰。@Component可以接受一个可选的bool类型参数。
说明从API version 9开始，该装饰器支持在ArkTS卡片中使用。
从API version 11开始，@Component可以接受一个可选的bool类型参数。
freezeWhenInactive11+@Component struct MyComponent { }
组件冻结选项。
自定义组件冻结功能专为优化复杂UI页面的性能而设计，尤其适用于包含多个页面栈、长列表或宫格布局的场景。在这些情况下，当状态变量绑定了多个UI组件，其变化可能触发大量UI组件的刷新，进而导致界面卡顿和响应延迟。为了提升这类负载UI界面的刷新性能，开发者可以选择尝试使用自定义组件冻结功能。
组件冻结的工作原理是：
- 开发者通过设置freezeWhenInactive属性，即可激活组件冻结机制。
- 启用后，系统将仅对处于激活状态的自定义组件进行更新，这使得UI框架可以尽量缩小更新范围，仅限于用户可见范围内（激活状态）的自定义组件，从而提高复杂UI场景下的刷新效率。
- 当之前处于inactive状态的自定义组件重新变为active状态时，状态管理框架会对其执行必要的刷新操作，确保UI的正确展示。
简而言之，组件冻结旨在优化复杂界面下的UI刷新性能。在存在多个不可见自定义组件的情况下，如多页面栈、长列表或宫格，通过组件冻结可以实现按需刷新，即仅刷新当前可见的自定义组件，而将不可见自定义组件的刷新延迟至它们变为可见时。
需要注意，组件active/inactive并不等同于其可见性。组件冻结目前仅适用于以下场景：
- 页面路由：当前栈顶页面为active，非栈顶不可见页面为inactive。
- TabContent：只有当前显示的TabContent中的自定义组件处于active状态，其余则为inactive。
- LazyForEach：仅当前显示的LazyForEach中的自定义组件为active，而缓存节点的组件则为inactive。
-
Navigation：当前显示的NavDestination中的自定义组件为active，而其他未显示的NavDestination组件则为inactive。
其他场景，如堆叠布局（Stack）下的被遮罩的组件，这些组件尽管不可见，但并不被视为inactive状态，因此不在组件冻结的适用范围内。
名称 类型 必填 说明 freezeWhenInactive bool 否 是否开启组件冻结。 @Component({ freezeWhenInactive: true }) struct MyComponent { } -
build()函数：build()函数用于定义自定义组件的声明式UI描述，自定义组件必须定义build()函数。
@Component struct MyComponent { build() { } }
-
@Entry：@Entry装饰的自定义组件将作为UI页面的入口。在单个UI页面中，最多可以使用@Entry装饰一个自定义组件。@Entry可以接受一个可选的LocalStorage的参数。
说明从API version 9开始，该装饰器支持在ArkTS卡片中使用。
从API version 10开始，@Entry可以接受一个可选的LocalStorage的参数或者一个可选的EntryOptions参数。
从API version 11开始，该装饰器支持在元服务中使用。
EntryOptions10+@Entry @Component struct MyComponent { }
命名路由跳转选项。
名称 类型 必填 说明 routeName string 否 表示作为命名路由页面的名字。 storage LocalStorage 否 页面级的UI状态存储。 useSharedStorage12+ boolean 否 是否使用LocalStorage.getShared()接口返回的LocalStorage实例对象，默认值false。 说明当useSharedStorage设置为true，并且storage又被赋值时，useSharedStorage的值优先级更高。
@Entry({ routeName : 'myPage' }) @Component struct MyComponent { } -
@Reusable：@Reusable装饰的自定义组件具备可复用能力
说明从API version 10开始，该装饰器支持在ArkTS卡片中使用。
@Reusable @Component struct MyComponent { }
成员函数/变量
自定义组件除了必须要实现build()函数外，还可以实现其他成员函数，成员函数具有以下约束：
- 自定义组件的成员函数为私有的，且不建议声明成静态函数。
自定义组件可以包含成员变量，成员变量具有以下约束：
-
自定义组件的成员变量为私有的，且不建议声明成静态变量。
-
自定义组件的成员变量本地初始化有些是可选的，有些是必选的。具体是否需要本地初始化，是否需要从父组件通过参数传递初始化子组件的成员变量，请参考状态管理。
自定义组件的参数规定
从上文的示例中，我们已经了解到，可以在build方法里创建自定义组件，在创建自定义组件的过程中，根据装饰器的规则来初始化自定义组件的参数。
@Component struct MyComponent { private countDownFrom: number = 0; private color: Color = Color.Blue; build() { } } @Entry @Component struct ParentComponent { private someColor: Color = Color.Pink; build() { Column() { // 创建MyComponent实例，并将创建MyComponent成员变量countDownFrom初始化为10，将成员变量color初始化为this.someColor MyComponent({ countDownFrom: 10, color: this.someColor }) } } }
下面的示例代码将父组件中的函数传递给子组件，并在子组件中调用。
@Entry @Component struct Parent { @State cnt: number = 0 submit: () => void = () => { this.cnt++; } build() { Column() { Text(`${this.cnt}`) Son({ submitArrow: this.submit }) } } } @Component struct Son { submitArrow?: () => void build() { Row() { Button('add') .width(80) .onClick(() => { if (this.submitArrow) { this.submitArrow() } }) } .justifyContent(FlexAlign.SpaceBetween) .height(56) } }
build()函数
所有声明在build()函数的语句，我们统称为UI描述，UI描述需要遵循以下规则：
-
@Entry装饰的自定义组件，其build()函数下的根节点唯一且必要，且必须为容器组件，其中ForEach禁止作为根节点。
@Component装饰的自定义组件，其build()函数下的根节点唯一且必要，可以为非容器组件，其中ForEach禁止作为根节点。
@Entry @Component struct MyComponent { build() { // 根节点唯一且必要，必须为容器组件 Row() { ChildComponent() } } } @Component struct ChildComponent { build() { // 根节点唯一且必要，可为非容器组件 Image('test.jpg') } }
-
不允许声明本地变量，反例如下。
build() { // 反例：不允许声明本地变量 let a: number = 1; }
-
不允许在UI描述里直接使用console.info，但允许在方法或者函数里使用，反例如下。
build() { // 反例：不允许console.info console.info('print debug log'); }
-
不允许创建本地的作用域，反例如下。
build() { // 反例：不允许本地作用域 { ... } }
-
不允许调用没有用@Builder装饰的方法，允许系统组件的参数是TS方法的返回值。
@Component struct ParentComponent { doSomeCalculations() { } calcTextValue(): string { return 'Hello World'; } @Builder doSomeRender() { Text(`Hello World`) } build() { Column() { // 反例：不能调用没有用@Builder装饰的方法 this.doSomeCalculations(); // 正例：可以调用 this.doSomeRender(); // 正例：参数可以为调用TS方法的返回值 Text(this.calcTextValue()) } } }
-
不允许使用switch语法，如果需要使用条件判断，请使用if。示例如下。
build() { Column() { // 反例：不允许使用switch语法 switch (expression) { case 1: Text('...') break; case 2: Image('...') break; default: Text('...') break; } // 正例：使用if if(expression == 1) { Text('...') } else if(expression == 2) { Image('...') } else { Text('...') } } }
-
不允许使用表达式，反例如下。
build() { Column() { // 反例：不允许使用表达式 (this.aVar > 10) ? Text('...') : Image('...') } }
-
不允许直接改变状态变量，反例如下。详细分析见@State常见问题：不允许在build里改状态变量
@Component struct CompA { @State col1: Color = Color.Yellow; @State col2: Color = Color.Green; @State count: number = 1; build() { Column() { // 应避免直接在Text组件内改变count的值 Text(`${this.count++}`) .width(50) .height(50) .fontColor(this.col1) .onClick(() => { this.col2 = Color.Red; }) Button("change col1").onClick(() =>{ this.col1 = Color.Pink; }) } .backgroundColor(this.col2) } }
在ArkUI状态管理中，状态驱动UI更新。
所以，不能在自定义组件的build()或@Builder方法里直接改变状态变量，这可能会造成循环渲染的风险。Text('${this.count++}')在全量更新或最小化更新会产生不同的影响：
- 全量更新（API8及以前版本）： ArkUI可能会陷入一个无限的重渲染的循环里，因为Text组件的每一次渲染都会改变应用的状态，就会再引起下一轮渲染的开启。 当 this.col2 更改时，都会执行整个build构建函数，因此，Text(${this.count++})绑定的文本也会更改，每次重新渲染Text(${this.count++})，又会使this.count状态变量更新，导致新一轮的build执行，从而陷入无限循环。
- 最小化更新（API9-至今版本）： 当 this.col2 更改时，只有Column组件会更新，Text组件不会更改。 只当 this.col1 更改时，会去更新整个Text组件，其所有属性函数都会执行，所以会看到Text(${this.count++})自增。因为目前UI以组件为单位进行更新，如果组件上某一个属性发生改变，会更新整体的组件。所以整体的更新链路是：this.col1 = Color.Pink -> Text组件整体更新->this.count++ ->Text组件整体更新。值得注意的是，这种写法在初次渲染时会导致Text组件渲染两次，从而对性能产生影响。
build函数中更改应用状态的行为可能会比上面的示例更加隐蔽，比如：
-
在@Builder，@Extend或@Styles方法内改变状态变量 。
-
在计算参数时调用函数中改变应用状态变量，例如 Text('${this.calcLabel()}')。
-
对当前数组做出修改，sort()改变了数组this.arr，随后的filter方法会返回一个新的数组。
// 反例 @State arr : Array<...> = [ ... ]; ForEach(this.arr.sort().filter(...), item => { ... }) // 正确的执行方式为：filter返回一个新数组，后面的sort方法才不会改变原数组this.arr ForEach(this.arr.filter(...).sort(), item => { ... })
自定义组件通用样式
自定义组件通过“.”链式调用的形式设置通用样式。
@Component struct MyComponent2 { build() { Button(`Hello World`) } } @Entry @Component struct MyComponent { build() { Row() { MyComponent2() .width(200) .height(300) .backgroundColor(Color.Red) } } }
ArkUI给自定义组件设置样式时，相当于给MyComponent2套了一个不可见的容器组件，而这些样式是设置在容器组件上的，而非直接设置给MyComponent2的Button组件。通过渲染结果我们可以很清楚的看到，背景颜色红色并没有直接生效在Button上，而是生效在Button所处的开发者不可见的容器组件上。
