HarmonyOS(四)—— 如何创建自定义组件

前言

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

自定义组件特点:

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

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

以下简单自定义一个名叫MyComponent组件,来展示了自定义组件的基本用法。

typescript 复制代码
@Component
struct MyComponent {
  @State message: string = 'Hello, World!';

  build() {
    // MyComponent自定义组件组合系统组件Row和Text
    Row() {
      Text(this.message)
        .onClick(() => {
          // 状态变量message的改变驱动UI刷新,UI从'Hello, World!'刷新为'Hello, ArkUI!'
          this.message = 'Hello, ArkUI!';
        })
    }
  }
}

而MyComponent可以在其他自定义组件中的build()函数中多次创建,实现自定义组件的重用。如下所示:

typescript 复制代码
@Entry
@Component
struct ParentComponent {
  build() {
    Column() {
      Text('ArkUI message')
      MyComponent({ message: 'Hello, World!' });
      Divider()
      MyComponent({ message: '你好!' });
    }
  }
}

要完全理解上面的示例,需要了解自定义组件的以下概念定义,接下来会重点介绍以下几个概念:

  • 自定义组件的基本结构
  • 成员函数/变量
  • 自定义组件的参数规定
  • build()函数
  • 自定义组件通用样式

接下来,一一介绍上面五个概念。

认识自定义组件的基本结构

我们先看上面MyComponent组件的代码,层层解析自定义组件的结构组成

typescript 复制代码
@Component
struct MyComponent {
  @State message: string = 'Hello, World!';

  build() {
    // MyComponent自定义组件组合系统组件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装饰。如下所示
typescript 复制代码
@Component
struct MyComponent {
 .....
}

⚠️注意:从API version 9开始,该装饰器支持在ArkTS卡片中使用。

  • build()函数:build()函数用于定义自定义组件的声明式UI描述,自定义组件必须定义build()函数。
typescript 复制代码
@Component
struct MyComponent {
  build() {
  }
}
  • @Entry:@Entry装饰的自定义组件将作为UI页面的入口。在单个UI页面中,最多可以使用@Entry装饰一个自定义组件。@Entry可以接受一个可选的LocalStorage的参数。
typescript 复制代码
@Entry
@Component
struct MyComponent {
}

注意⚠️:从API version 9开始,该装饰器支持在ArkTS卡片中使用。

成员函数/变量

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

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

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

  • 不支持静态成员变量。
  • 所有成员变量都是私有的,变量的访问规则与成员函数的访问规则相同。
  • 自定义组件的成员变量本地初始化有些是可选的,有些是必选的。具体是否需要本地初始化,是否需要从父组件通过参数传递初始化子组件的成员变量,将在后续状态管理一文中详细描述。

自定义组件的参数规定

我们已经了解到,可以在build方法或者@Builder装饰的函数里创建自定义组件,在创建的过程中,参数可以被提供给组件。

typescript 复制代码
@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禁止作为根节点。
typescript 复制代码
@Entry
@Component
struct MyComponent {
  build() {
    // 根节点唯一且必要,必须为容器组件
    Row() {
      ChildComponent() 
    }
  }
}

@Component
struct ChildComponent {
  build() {
    // 根节点唯一且必要,可为非容器组件
    Image('test.jpg')
  }
}
  • 不允许声明本地变量,反例如下。
typescript 复制代码
build() {
  // 反例:不允许声明本地变量
  let a: number = 1;
}
typescript 复制代码
build() {
  // 反例:不允许console.info
  console.info('print debug log');
}
  • 不允许创建本地的作用域,反例如下。
typescript 复制代码
build() {
  // 反例:不允许本地作用域
  {
    ...
  }
}
  • 不允许调用除了被@Builder装饰以外的方法,允许系统组件的参数是TS方法的返回值。
typescript 复制代码
@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。反例如下。
typescript 复制代码
build() {
  Column() {
    // 反例:不允许使用switch语法
    switch (expression) {
      case 1:
        Text('...')
        break;
      case 2:
        Image('...')
        break;
      default:
        Text('...')
        break;
    }
  }
}
  • 不允许使用表达式,反例如下。
typescript 复制代码
build() {
  Column() {
    // 反例:不允许使用表达式
    (this.aVar > 10) ? Text('...') : Image('...')
  }
}

以上就是在自定义组件使用build()函数时所需注意事项。

自定义组件通用样式

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

typescript 复制代码
@Component
struct TestComponent {
  build() {
    Button(`Hello World`)
  }
}

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

如上所示,通过"."链式调用的形式,设置TestComponent组件的宽200,高300,红色背景色。

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

总结

  • 我们可以使用结合系统组件实现自定义组合组件,从而满足我们日常开发需求
  • 自定义组件具备可组合,可复用的特点,它是通过数据驱动UI更新的。
  • 自定义组件是需要遵循基本结构的,明白基本结构各个装饰关键字的作用
  • build()函数:build()函数用于定义自定义组件的声明式UI描述,自定义组件必须定义build()函数。
  • 自定义组件除了必须要实现build()函数外,还可以实现其他成员函数,成员函数需要符合约束。
相关推荐
Random_index5 小时前
#Uniapp篇:支持纯血鸿蒙&发布&适配&UIUI
uni-app·harmonyos
鸿蒙自习室8 小时前
鸿蒙多线程开发——线程间数据通信对象02
ui·harmonyos·鸿蒙
SuperHeroWu711 小时前
【HarmonyOS】鸿蒙应用接入微博分享
华为·harmonyos·鸿蒙·微博·微博分享·微博sdk集成·sdk集成
期待未来的男孩11 小时前
华为FusionCube 500-8.2.0SPC100 实施部署文档
华为
岳不谢13 小时前
VPN技术-VPN简介学习笔记
网络·笔记·学习·华为
zhangjr057513 小时前
【HarmonyOS Next】鸿蒙实用装饰器一览(一)
前端·harmonyos·arkts
诗歌难吟46420 小时前
初识ArkUI
harmonyos
SameX20 小时前
HarmonyOS Next 设备安全特性深度剖析学习
harmonyos
郭梧悠21 小时前
HarmonyOS(57) UI性能优化
ui·性能优化·harmonyos
郝晨妤1 天前
鸿蒙原生应用开发元服务 元服务是什么?和App的关系?(保姆级步骤)
android·ios·华为od·华为·华为云·harmonyos·鸿蒙