[引]ArkTS 自定义组件

在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装饰。

说明

从API version 9开始，该装饰器支持在ArkTS卡片中使用。
1. @Component
2. struct MyComponent {
3. }
build()函数：build()函数用于定义自定义组件的声明式UI描述，自定义组件必须定义build()函数。
1. @Component
2. struct MyComponent {
3. build() {
4. }
5. }
@Entry：@Entry装饰的自定义组件将作为UI页面的入口。在单个UI页面中，最多可以使用@Entry装饰一个自定义组件。@Entry可以接受一个可选的LocalStorage的参数。

说明

从API version 9开始，该装饰器支持在ArkTS卡片中使用。
1. @Entry
2. @Component
3. struct MyComponent {
4. }

成员函数/变量

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

不支持静态函数。
成员函数的访问是私有的。

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

不支持静态成员变量。
所有成员变量都是私有的，变量的访问规则与成员函数的访问规则相同。
自定义组件的成员变量本地初始化有些是可选的，有些是必选的。具体是否需要本地初始化，是否需要从父组件通过参数传递初始化子组件的成员变量，请参考状态管理。

自定义组件的参数规定

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

@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禁止作为根节点。
1. @Entry
2. @Component
3. struct MyComponent {
4. build() {
5. // 根节点唯一且必要，必须为容器组件
6. Row() {
7. ChildComponent()
8. }
9. }
10. }
12. @Component
13. struct ChildComponent {
14. build() {
15. // 根节点唯一且必要，可为非容器组件
16. Image('test.jpg')
17. }
18. }
不允许声明本地变量，反例如下。
1. build() {
2. // 反例：不允许声明本地变量
3. let a: number = 1;
4. }
不允许在UI描述里直接使用console.info，但允许在方法或者函数里使用，反例如下。
1. build() {
2. // 反例：不允许console.info
3. console.info('print debug log');
4. }
不允许创建本地的作用域，反例如下。
1. build() {
2. // 反例：不允许本地作用域
3. {
4. ...
5. }
6. }
不允许调用没有用@Builder装饰的方法，允许系统组件的参数是TS方法的返回值。
1. @Component
2. struct ParentComponent {
3. doSomeCalculations() {
4. }
6. calcTextValue(): string {
7. return 'Hello World';
8. }
10. @Builder doSomeRender() {
11. Text(`Hello World`)
12. }
14. build() {
15. Column() {
16. // 反例：不能调用没有用@Builder装饰的方法
17. this.doSomeCalculations();
18. // 正例：可以调用
19. this.doSomeRender();
20. // 正例：参数可以为调用TS方法的返回值
21. Text(this.calcTextValue())
22. }
23. }
24. }
不允许switch语法，如果需要使用条件判断，请使用if。反例如下。
1. build() {
2. Column() {
3. // 反例：不允许使用switch语法
4. switch (expression) {
5. case 1:
6. Text('...')
7. break;
8. case 2:
9. Image('...')
10. break;
11. default:
12. Text('...')
13. break;
14. }
15. }
16. }
不允许使用表达式，反例如下。
1. build() {
2. Column() {
3. // 反例：不允许使用表达式
4. (this.aVar > 10) ? Text('...') : Image('...')
5. }
6. }

自定义组件通用样式

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

@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所处的开发者不可见的容器组件上。

Love in coding...

创建自定义组件-自定义组件-基本语法-学习ArkTS语言-入门-HarmonyOS应用开发

创建自定义组件