ArkTs 组件基础

在 ArkUI 中，UI 显示的内容均为组件，由框架直接提供的称为系统组件，由开发者定义的称为自定义组件。在进行 UI 界面开发时，通常不是简单的将系统组件进行组合使用，而是需要考虑代码可复用性、业务逻辑与 UI 分离，后续版本演进等因素。因此，将 UI 和部分业务逻辑封装成自定义组件是不可或缺的能力。

自定义组件

自定义组件具有以下特点：

可组合：允许开发者组合使用系统组件、及其属性和方法。

可重用：自定义组件可以被其他组件重用，并作为不同的实例在不同的父组件或容器中使用。

数据驱动 UI 更新：通过状态变量的改变，来驱动 UI 的刷新。

自定义组件的基本用法

Copy
@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!';
})
}
}
}

::: warning 注意

如果在另外的文件中引用该自定义组件，需要使用 export 关键字导出，并在使用的页面 import 该自定义组件。
:::

HelloComponent 可以在其他自定义组件中的 build () 函数中多次创建，实现自定义组件的重用。

Copy
class HelloComponentParam {
message: string = ""
}

@Entry
@Component
struct ParentComponent {
param: HelloComponentParam = {
message: 'Hello, World!'
}

build() {
Column() {
Text('ArkUI message')
HelloComponent(this.param);
Divider()
HelloComponent(this.param);
}
}
}

自定义组件的基本结构

struct：自定义组件基于 struct 实现，struct + 自定义组件名 + {...} 的组合构成自定义组件，不能有继承关系。对于 struct 的实例化，可以省略 new。

::: tip 说明
自定义组件名、类名、函数名不能和系统组件名相同。
:::

@Component：@Component 装饰器仅能装饰 struct 关键字声明的数据结构。struct 被 @Component 装饰后具备组件化的能力，需要实现 build 方法描述 UI，一个 struct 只能被一个 @Component 装饰。@Component 可以接受一个可选的 bool 类型参数。

::: tip 说明
从 API version 9 开始，该装饰器支持在 ArkTS 卡片中使用。

从 API version 11 开始，@Component 可以接受一个可选的 bool 类型参数。
:::

Copy
@Component
struct MyComponent {
}

freezeWhenInactive

组件冻结选项。

Copy
@Component({ freezeWhenInactive: true })
struct MyComponent {
}

build () 函数

build () 函数用于定义自定义组件的声明式 UI 描述，自定义组件必须定义 build () 函数。

Copy
@Component
struct MyComponent {
build() {
}
}

@Entry

@Entry 装饰的自定义组件将作为 UI 页面的入口。在单个 UI 页面中，最多可以使用 @Entry 装饰一个自定义组件。@Entry 可以接受一个可选的 LocalStorage 的参数

::: tip 说明
从 API version 9 开始，该装饰器支持在 ArkTS 卡片中使用。

从 API version 10 开始，@Entry 可以接受一个可选的 LocalStorage 的参数或者一个可选的 EntryOptions 参数。

从 API version 11 开始，该装饰器支持在元服务中使用。
:::

Copy
@Entry
@Component
struct MyComponent {
}```

EntryOptions10

命名路由跳转选项。

Copy
@Entry({ routeName : 'myPage' })
@Component
struct MyComponent {
}

@Reusable：@Reusable 装饰的自定义组件具备可复用能力

成员函数 / 变量

自定义组件除了必须要实现 build () 函数外，还可以实现其他成员函数，成员函数具有以下约束：

自定义组件的成员函数为私有的，且不建议声明成静态函数。

自定义组件可以包含成员变量，成员变量具有以下约束：

自定义组件的成员变量为私有的，且不建议声明成静态变量。

自定义组件的成员变量本地初始化有些是可选的，有些是必选的。具体是否需要本地初始化，是否需要从父组件通过参数传递初始化子组件的成员变量，请参考状态管理。

自定义组件的参数规定

从上文的示例中，我们已经了解到，可以在 build 方法里创建自定义组件，在创建自定义组件的过程中，根据装饰器的规则来初始化自定义组件的参数。

Copy
@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 })
}
}
}

build () 函数

所有声明在 build () 函数的语句，我们统称为 UI 描述，UI 描述需要遵循以下规则：

@Entry 装饰的自定义组件，其 build () 函数下的根节点唯一且必要，且必须为容器组件，其中 ForEach 禁止作为根节点。

@Component 装饰的自定义组件，其 build () 函数下的根节点唯一且必要，可以为非容器组件，其中 ForEach 禁止作为根节点。

Copy
@Entry
@Component
struct MyComponent {
build() {
// 根节点唯一且必要，必须为容器组件
Row() {
ChildComponent()
}
}
}

@Component
struct ChildComponent {
build() {
// 根节点唯一且必要，可为非容器组件
Image('test.jpg')
}
}

不允许声明本地变量，反例如下

Copy
build() {
// 反例：不允许声明本地变量
let a: number = 1;
}

不允许在 UI 描述里直接使用 console.info，但允许在方法或者函数里使用，反例如下。

Copy
build() {
// 反例：不允许console.info
console.info('print debug log');
}

不允许调用没有用 @Builder 装饰的方法，允许系统组件的参数是 TS 方法的返回值。

Copy
@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。示例如下。

Copy
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('...')
}
}
}

不允许直接改变状态变量，反例如下。详细分析见 @State 常见问题：不允许在 build 里改状态变量

Copy
@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 方法会返回一个新的数组。

自定义组件通用样式

自定义组件通过 “.” 链式调用的形式设置通用样式。

Copy
@Component
struct MyComponent2 {
build() {
Button(`Hello World`)
}
}

@Entry
@Component
struct MyComponent {
build() {
Row() {
MyComponent2()
.width(200)
.height(300)
.backgroundColor(Color.Red)
}
}
}

::: tip 说明
ArkUI 给自定义组件设置样式时，相当于给 MyComponent2 套了一个不可见的容器组件，而这些样式是设置在容器组件上的，而非直接设置给 MyComponent2 的 Button 组件。通过渲染结果我们可以很清楚的看到，背景颜色红色并没有直接生效在 Button 上，而是生效在 Button 所处的开发者不可见的容器组件上。
:::

此文由 Mix Space 同步更新至 xLog
原始链接为 http://www.sroxck.top/posts/harmony/arkts-components