HarmonyOS鸿蒙学习基础篇 - 自定义组件（一）

news2024/11/29 4:50:38

前言

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

自定义组特点：

  1. 可组合：允许开发者组合使用系统组件、及其属性和方法。
  2. 可重用：自定义组件可以被其他组件重用，并作为不同的实例在不同的父组件或容器中使用。
  3. 数据驱动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!';
        })
    }
  }
}

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

@Entry
@Component
struct ParentComponent {
  build() {
    Column() {
      Text('ArkUI message')
      HelloComponent({ message: 'Hello, World!' });
      Divider()
      HelloComponent({ message: '你好!' });
    }
  }
}

以上代码写入一个arkts文件中，并设置对应的字体样式，如下：

@Component
struct HelloComponent {
  @State message: string = 'Hello, World!';

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

@Entry
@Component
struct ParentComponent {
  build() {
    Column() {
      Text('ArkUI message')
        .height(100)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
      HelloComponent({ message: 'Hello, World!' });
      Divider()
      HelloComponent({ message: '你好!' });
    }
  }
}

预览如下，点击“Hello,World!”或者“你好”都会改变为“Hello, ArkUI!”做到了自定义组件复用。

 

基本结构

1.struct

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

注意：自定义组件名、类名、函数名不能和系统组件名相同。

2.@Component

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

@Component

struct MyComponent {

}

注意：从API version 9开始，该装饰器支持在ArkTS卡片中使用。

3.build()函数

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

@Component

struct MyComponent {

  build() {

  }

}

4.@Entry

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

@Entry

@Component

struct MyComponent {

}

注意：从API version 9开始，该装饰器支持在ArkTS卡片中使用。

函数变量

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

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

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

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

参数规定

从上文的示例中，我们已经了解到，可以在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描述需要遵循以下规则：

  1. @Entry装饰的自定义组件，其build()函数下的根节点唯一且必要，且必须为容器组件，其中ForEach禁止作为根节点。@Component装饰的自定义组件，其build()函数下的根节点唯一且必要，可以为非容器组件，其中ForEach禁止作为根节点。
@Entry
@Component
struct MyComponent {
  build() {
    // 根节点唯一且必要，必须为容器组件
    Row() {
      ChildComponent()
    }
  }
}


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

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

build() {

  // 反例：不允许声明本地变量

  let a: number = 1;

}

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

build() {

  // 反例：不允许console.info

  console.info('print debug log');

}

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

build() {

  // 反例：不允许本地作用域

  {

    ...

  }

}

  1. 不允许调用没有用@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())
    }
  }
}

  1. 不允许switch语法，如果需要使用条件判断，请使用if。反例如下。
build() {
  Column() {
    // 反例：不允许使用switch语法
    switch (expression) {
      case 1:
        Text('...')
        break;
      case 2:
        Image('...')
        break;
      default:
        Text('...')
        break;
    }
  }
}

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

build() {

  Column() {

    // 反例：不允许使用表达式

    (this.aVar > 10) ? Text('...') : Image('...')

  }

}

通用样式

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

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

生命周期

  自定义组件和页面的关系：

  1. 自定义组件：@Component装饰的UI单元，可以组合多个系统组件实现UI的复用。
  2. 页面：即应用的UI页面。可以由一个或者多个自定义组件组成，@Entry装饰的自定义组件为页面的入口组件，即页面的根节点，一个页面有且仅能有一个@Entry。只有被@Entry装饰的组件才可以调用页面的生命周期。

页面生命周期，即被@Entry装饰的组件生命周期，提供以下生命周期接口：

  1. onPageShow：页面每次显示时触发。
  2. onPageHide：页面每次隐藏时触发一次。
  3. onBackPress：当用户点击返回按钮时触发。

组件生命周期，即一般用@Component装饰的自定义组件的生命周期，提供以下生命周期接口：

  1. aboutToAppear：组件即将出现时回调该接口，具体时机为在创建自定义组件的新实例后，在执行其build()函数之前执行。
  2. aboutToDisappear：在自定义组件即将析构销毁时执行。

生命周期流程如下图所示，下图展示的是被@Entry装饰的组件（首页）生命周期。

 

   需要注意的是，部分生命周期回调函数仅对@Entry修饰的自定义组件生效，它们分别是：onPageShow、onPageHide、onBackPress。根据上面的流程图，我们从自定义组件的初始创建、重新渲染和删除来详细解释。 

 自定义组件的创建和渲染流程

  1. 自定义组件的创建：自定义组件的实例由ArkUI框架创建。
  2. 初始化自定义组件的成员变量：通过本地默认值或者构造方法传递参数来初始化自定义组件的成员变量，初始化顺序为成员变量的定义顺序。
  3. 如果开发者定义了aboutToAppear，则执行aboutToAppear方法。
  4. 在首次渲染的时候，执行build方法渲染系统组件，如果子组件为自定义组件，则创建自定义组件的实例。在执行build()函数的过程中，框架会观察每个状态变量的读取状态，将保存两个map：
  1. 状态变量 -> UI组件（包括ForEach和if）。
  2. UI组件 -> 此组件的更新函数，即一个lambda方法，作为build()函数的子集，创建对应的UI组件并执行其属性方法，示意如下。
build() {
  ...
  this.observeComponentCreation(() => {
    Button.create();
  })

  this.observeComponentCreation(() => {
    Text.create();
  })
  ...
}

当应用在后台启动时，此时应用进程并没有销毁，所以仅需要执行onPageShow。

自定义组件重新渲染 

    当事件句柄被触发（比如设置了点击事件，即触发点击事件）改变了状态变量时，或者LocalStorage / AppStorage中的属性更改，并导致绑定的状态变量更改其值时：

  1. 框架观察到了变化，将启动重新渲染。
  2. 根据框架持有的两个map（自定义组件的创建和渲染流程中第4步），框架可以知道该状态变量管理了哪些UI组件，以及这些UI组件对应的更新函数。执行这些UI组件的更新函数，实现最小化更新。

自定义组件的删除

   如果if组件的分支改变，或者ForEach循环渲染中数组的个数改变，组件将被删除：

  1. 在删除组件之前，将调用其aboutToDisappear生命周期函数，标记着该节点将要被销毁。ArkUI的节点删除机制是：后端节点直接从组件树上摘下，后端节点被销毁，对前端节点解引用，当前端节点已经没有引用时，将被JS虚拟机垃圾回收。
  2. 自定义组件和它的变量将被删除，如果其有同步的变量，比如@Link、@Prop、@StorageLink，将从同步源上取消注册。

     不建议在生命周期aboutToDisappear内使用async await，如果在生命周期的aboutToDisappear使用异步操作（Promise或者回调方法），自定义组件将被保留在Promise的闭包中，直到回调方法被执行完，这个行为阻止了自定义组件的垃圾回收。

 以下示例展示了生命周期的调用时机：

import router from '@ohos.router';
@Entry
@Component
struct MyComponent {
  @State showChild: boolean = true;


  // 只有被@Entry装饰的组件才可以调用页面的生命周期

  onPageShow() {
    console.info('Index onPageShow');
  }

  // 只有被@Entry装饰的组件才可以调用页面的生命周期
  onPageHide() {
    console.info('Index onPageHide');
  }



  // 只有被@Entry装饰的组件才可以调用页面的生命周期
  onBackPress() {
    console.info('Index onBackPress');
  }



  // 组件生命周期
  aboutToAppear() {
    console.info('MyComponent aboutToAppear');
  }



  // 组件生命周期
  aboutToDisappear() {
    console.info('MyComponent aboutToDisappear');
  }



  build() {
    Column() {
      // this.showChild为true，创建Child子组件，执行Child aboutToAppear
      if (this.showChild) {
        Child()
      }

      // this.showChild为false，删除Child子组件，执行Child aboutToDisappear
      Button('create or delete Child').onClick(() => {
        this.showChild = false;
      })

      // push到Page2页面，执行onPageHide
      Button('push to next page')
        .onClick(() => {
          router.pushUrl({ url: 'pages/Page2' });
        })
    }


  }
}



@Component
struct Child {
  @State title: string = 'Hello World';
  // 组件生命周期
  aboutToDisappear() {
    console.info('[lifeCycle] Child aboutToDisappear')
  }
  // 组件生命周期
  aboutToAppear() {
    console.info('[lifeCycle] Child aboutToAppear')
  }


  build() {
    Text(this.title).fontSize(50).onClick(() => {
      this.title = 'Hello ArkUI';
    })
  }
}

   以上示例中，Index页面包含两个自定义组件，一个是被@Entry装饰的MyComponent，也是页面的入口组件，即页面的根节点；一个是Child，是MyComponent的子组件。只有@Entry装饰的节点才可以使页面级别的生命周期方法生效，所以MyComponent中声明了当前Index页面的页面生命周期函数。MyComponent和其子组件Child也同时也声明了组件的生命周期函数。

  1. 应用冷启动的初始化流程为：MyComponent aboutToAppear --> MyComponent build --> Child aboutToAppear --> Child build --> Child build执行完毕 --> MyComponent build执行完毕 --> Index onPageShow。
  2. 点击“delete Child”，if绑定的this.showChild变成false，删除Child组件，会执行Child aboutToDisappear方法。
  3. 点击“push to next page”，调用router.pushUrl接口，跳转到另外一个页面，当前Index页面隐藏，执行页面生命周期Index onPageHide。此处调用的是router.pushUrl接口，Index页面被隐藏，并没有销毁，所以只调用onPageHide。跳转到新页面后，执行初始化新页面的生命周期的流程。
  4. 如果调用的是router.replaceUrl，则当前Index页面被销毁，执行的生命周期流程将变为：Index onPageHide --> MyComponent aboutToDisappear --> Child aboutToDisappear。上文已经提到，组件的销毁是从组件树上直接摘下子树，所以先调用父组件的aboutToDisappear，再调用子组件的aboutToDisappear，然后执行初始化新页面的生命周期流程。
  5. 点击返回按钮，触发页面生命周期Index onBackPress，且触发返回一个页面后会导致当前Index页面被销毁。
  6. 最小化应用或者应用进入后台，触发Index onPageHide。当前Index页面没有被销毁，所以并不会执行组件的aboutToDisappear。应用回到前台，执行Index onPageShow。

退出应用，执行Index onPageHide --> MyComponent aboutToDisappear --> Child aboutToDisappear。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1448049.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

987. 二叉树的垂序遍历 - 力扣（LeetCode）

987. 二叉树的垂序遍历 - 力扣（LeetCode）

题目描述 给你二叉树的根结点 root ，请你设计算法计算二叉树的 垂序遍历 序列。 对位于 (row, col) 的每个结点而言，其左右子结点分别位于 (row 1, col - 1) 和 (row 1, col 1) 。树的根结点位于 (0, 0) 。 二叉树的 垂序遍历 从最左边的列开始直到…
阅读更多...
代码随想录算法训练营第46天|198.打家劫舍、213.打家劫舍II、337.打家劫舍III

代码随想录算法训练营第46天|198.打家劫舍、213.打家劫舍II、337.打家劫舍III

文章目录 198.打家劫舍思路代码 213.打家劫舍II思路代码 337.打家劫舍III思路代码 198.打家劫舍 题目链接：198.打家劫舍 文章讲解：代码随想录|198.打家劫舍 思路 1.dp[i]:从0打劫到i所获得的最高金额 2.是否打劫第i个决定了dp[i]：如果打劫则…
阅读更多...
Unity类银河恶魔城学习记录7-4 P70 Improving sword‘s behaviour源代码

Unity类银河恶魔城学习记录7-4 P70 Improving sword‘s behaviour源代码

Alex教程每一P的教程原代码加上我自己的理解初步理解写的注释，可供学习Alex教程的人参考 此代码仅为较上一P有所改变的代码 【Unity教程】从0编程制作类银河恶魔城游戏_哔哩哔哩_bilibili Sword_Skill_Controller.cs using System.Collections; using System.Colle…
阅读更多...
浅谈Linux环境

浅谈Linux环境

冯诺依曼体系结构： 绝大多数的计算机都遵守冯诺依曼体系结构 在冯诺依曼体系结构下各个硬件相互配合处理数据并反馈结果给用户 其中控制器和运算器统称为中央处理器（CPU），是计算机硬件中最核心的部分，像人类的大脑操控…
阅读更多...
【记录】记一次关于前端单元测试的全英文问卷调查（ Survey: Automatically Generated Test Suites for JavaScript）

【记录】记一次关于前端单元测试的全英文问卷调查（ Survey: Automatically Generated Test Suites for JavaScript）

文章目录 OPENING STATEMENTBackgroundTask background: Fix the failing test casesBefore the task: Task: Fix the failing test casesTask: Executable DocumentationBefore the task: Bonus Opportunity: One more taskTask: Test Cases ClusteringRewardThank You! 原地址…
阅读更多...
RocketMQ与Kafka架构深度对比

RocketMQ与Kafka架构深度对比

在分布式系统中，消息中间件扮演着至关重要的角色，它们负责在系统组件之间传递消息，实现解耦、异步通信和流量削峰等功能。RocketMQ与Kafka作为两款流行的消息中间件，各自拥有独特的架构设计和功能特性。本文将深入对比分析RocketM…
阅读更多...
【机器学习300问】22、什么是超参数优化？常见超参数优化方法有哪些？

【机器学习300问】22、什么是超参数优化？常见超参数优化方法有哪些？

在之前的文章中，我主要介绍了学习率 η和正则化强度 λ 这两个超参数。这篇文章中我就主要拿这两个超参数来进行举例说明。如果想在开始阅读本文之前了解这两个超参数的有关内容可以参考我之前的文章，文章链接为你放在了这里： 【机器学习300…
阅读更多...
算法沉淀——哈希算法（leetcode真题剖析）

算法沉淀——哈希算法（leetcode真题剖析）

算法沉淀——哈希算法 01.两数之和02.判定是否互为字符重排03.存在重复元素04.存在重复元素 II05.字母异位词分组 哈希算法（Hash Algorithm）是一种将任意长度的输入（也称为消息）映射为固定长度的输出的算法。这个输出通常称为哈希…
阅读更多...
2024.2.8

2024.2.8

1. 现有文件test.c\test1.c\main.c,编写Makkefile Makefile： CCgcc EXEa.out OBJS$(patsubst %.c,%.o,$(wildcard *.c)) CFLAGS-c -oall:$(EXE)$(EXE):$(OBJS)$(CC) $^ -o $%.o:%.c$(CC) $(CFLAGS) $ $^.PHONY:cleanclean:rm $(OBJS) $(EXE) 2. C编程实现&#x…
阅读更多...
HarmonyOS鸿蒙学习基础篇 - Column/Row 组件

HarmonyOS鸿蒙学习基础篇 - Column/Row 组件

前言 Row和Column组件是线性布局容器，用于按照垂直或水平方向排列子组件。Row表示沿水平方向布局的容器，而Column表示沿垂直方向布局的容器。这些容器具有许多属性和方法，可以方便地管理子组件的位置、大小、间距和对齐方式。例如&#xff0c…
阅读更多...
netstat命令

netstat命令

netstat 是一个计算机网络命令行工具，用于显示网络连接、路由表和网络接口等网络相关信息。netstat 命令可以在各种操作系统上使用，包括 Windows、Linux 和 macOS 等。 在使用 netstat 命令时，可以提供不同的选项来显示不同类型的网络信息。…
阅读更多...
【北邮鲁鹏老师计算机视觉课程笔记】08 texture 纹理表示

【北邮鲁鹏老师计算机视觉课程笔记】08 texture 纹理表示

【北邮鲁鹏老师计算机视觉课程笔记】08 texture 纹理表示 1 纹理 规则和不规则的 2 纹理的用处 从纹理中恢复形状 3 分割与合成 4 分析纹理进行分类 通过识别纹理分析物理性质 如何区分纹理 5 寻找有效的纹理分类方法 发现模式、描述区域内模式 A对应图2 B对应图…
阅读更多...
Linux命令行全景指南：从入门到实践，掌握命令行的力量

Linux命令行全景指南：从入门到实践，掌握命令行的力量

目录 知识梳理思维导图： linux命令入门 为什么要学Linux命令 什么是终端 什么是命令 关于Linux命令的语法 tab键补全 关于命令提示符 特殊目录 常见重要目录 /opt /home /root /etc /var/log/ man命令 shutdown命令 history命令 which命令 bash…
阅读更多...
单链表的介绍

单链表的介绍

一.单链表的概念及结构 概念：链表是⼀种物理存储结构上⾮连续、⾮顺序的存储结构，数据元素的逻辑顺序是通过链表 中的指针链接次序实现的 。 结构：根据个人理解，链表的结构就像火车厢一样，一节一节连在一起的&#x…
阅读更多...
ClickHouse--07--SQL DDL 操作

ClickHouse--07--SQL DDL 操作

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录 SQL DDL 操作1 创建库2 查看数据库3 删除库4 创建表5 查看表6 查看表的定义7 查看表的字段8 删除表9 修改表9.1 添加列9.2 删除列9.3 清空列9.4 给列修改注释9.5 修…
阅读更多...
深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之倒排索引（三）

深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之倒排索引（三）

当我们谈论Elasticsearch（简称ES）时，我们经常会提到它的高效搜索能力。而这背后的核心技术之一就是倒排索引。那么，什么是倒排索引，以及它是如何在Elasticsearch中工作的呢？ 深入解析Elasticsearch的内部数…
阅读更多...
机器学习系列——（二十一）神经网络

机器学习系列——（二十一）神经网络

引言 在当今数字化时代，机器学习技术正日益成为各行各业的核心。而在机器学习领域中，神经网络是一种备受瞩目的模型，因其出色的性能和广泛的应用而备受关注。本文将深入介绍神经网络，探讨其原理、结构以及应用。 一、简介 神经网…
阅读更多...
PHP脉聊交友系统网站源码，可通过广告变现社交在线聊天交友即时通讯APP源码，附带视频搭建教程

PHP脉聊交友系统网站源码，可通过广告变现社交在线聊天交友即时通讯APP源码，附带视频搭建教程

探索全新社交体验：一站式PHP交友网站解决方案 🌐 全球化交友，无界沟通 在数字化的浪潮下，社交已不再受地域限制。我们的PHP交友网站不仅支持多国语言，还配备了即时翻译功能，让您轻松跨越语言障碍&#xff…
阅读更多...
分享87个CSS3特效，总有一款适合您

分享87个CSS3特效，总有一款适合您

分享87个CSS3特效，总有一款适合您 87个CSS3特效下载链接：https://pan.baidu.com/s/1CAxe8nPBzXvH7Nr6B_U72Q?pwd8888 提取码：8888 Python采集代码下载链接：采集代码.zip - 蓝奏云 学习知识费力气，收集整理更不…
阅读更多...
MySQL基本操作之数据库的操作

MySQL基本操作之数据库的操作

一.创建数据库 1.基本语法 create database 数据库名； 注意别忘记加分号。 2.if not exists 数据库名字是唯一的，所以不可以创建已存在的数据库，如下： 重复创建就会报错 所以有了if not exists这个语法，加上之后&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023