OpenHarmony 自定义组件

作者：坚果

2023-06-22
北京
本文字数：3211 字
阅读完需：约 11 分钟

自定义组件

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

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

可组合：允许开发者组合使用系统组件、及其属性和方法。
可重用：自定义组件可以被其他组件重用，并作为不同的实例在不同的父组件或容器中使用。
数据驱动 UI 更新：通过状态变量的改变，来驱动 UI 的刷新。

以下示例展示了自定义组件的基本用法。

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

复制代码

自定义组件的基本结构

struct：自定义组件基于 struct 实现，struct + 自定义组件名 + {...}的组合构成自定义组件，不能有继承关系。对于 struct 的实例化，可以省略 new。
@Component：@Component 装饰器仅能装饰 struct 关键字声明的数据结构。struct 被 @Component 装饰后具备组件化的能力，需要实现 build 方法描述 UI，一个 struct 只能被一个 @Component 装饰。

  @Component  struct MyComponent {  }

复制代码

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

  @Component  struct MyComponent {    build() {    }  }

复制代码

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

  @Entry  @Component  struct MyComponent {  }

复制代码

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

  @Recycle  @Component  struct MyComponent {  }

复制代码

成员函数/变量

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

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

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

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

自定义组件的参数规定

可以在 build 方法或者@Builder装饰的函数里创建自定义组件，在创建的过程中，参数可以被提供给组件。

@Componentstruct MyComponent {  private countDownFrom: number = 0;  private color: Color = Color.Blue;
  build() {  }}
@Entry@Componentstruct 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 禁止作为根节点。

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

复制代码

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

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

复制代码

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

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

复制代码

不允许创建本地的作用域，反例如下。

build() {  // 反例：不允许本地作用域  {    ...  }}

复制代码

不允许调用除了被 @Builder 装饰以外的方法，允许系统组件的参数是 TS 方法的返回值。

@Componentstruct 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;    }  }}

复制代码

不允许使用表达式，反例如下。

build() {  Column() {    // 反例：不允许使用表达式    (this.aVar > 10) ? Text('...') : Image('...')  }}

复制代码

自定义组件通用样式

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

@Componentstruct MyComponent2 {  build() {    Button(`Hello World`)  }}
@Entry@Componentstruct MyComponent {  build() {    Row() {      MyComponent2()        .width(200)        .height(300)        .backgroundColor(Color.Red)    }  }}

复制代码

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

自定义属性方法

自定义组件不支持提供自定义属性方法，可以借助类似 Controller 控制器能力，提供自定义接口。

// 自定义controllerexport class MyComponentController {  item: MyComponent = null;
  setItem(item: MyComponent) {    this.item = item;  }
  changeText(value: string) {    this.item.value = value;  }}
// 自定义组件@Componentexport default struct MyComponent {  public controller: MyComponentController = null;  @State value: string = 'Hello World';
  build() {    Column() {      Text(this.value)        .fontSize(50)    }  }
  aboutToAppear() {    if (this.controller)      this.controller.setItem(this); // 绑定controller  }}
// 使用处逻辑@Entry@Componentstruct StyleExample {  controller = new MyComponentController();
  build() {    Column() {      MyComponent({ controller: this.controller })    }    .onClick(() => {      this.controller.changeText('Text');    })  }}

复制代码

在上面的示例中：

通过子组件 MyComponent 的 aboutToAppear 方法，把当前的 this 指针传递给 MyComponentController 的 item 成员变量。
在 StyleExample 父组件中持有 controller 实例，调用 controller 的 changeText 方法，即相当于通过 controller 持有的 MyComponent 子组件的 this 指针，改变 MyComponent 的状态变量 value 的值。

通过 controller 的封装，MyComponent 对外暴露了 changeText 的接口，所有持有 controller 的实例都可以通过调用 changeText 接口，改变 MyComponent 的状态变量 value 的值。

发布于: 刚刚阅读数: 2

原文链接:【http://xie.infoq.cn/article/d73635d67dc3111d83ea86a61】。文章转载请联系作者。