【鸿蒙开发】组件状态管理@Prop,@Link,@Provide,@Consume,@Observed,@ObjectLink

本文主要是介绍【鸿蒙开发】组件状态管理@Prop,@Link,@Provide,@Consume,@Observed,@ObjectLink,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. @Prop 父子单向同步

概述

@Prop装饰的变量和父组件建立单向的同步关系:

  • @Prop变量允许在本地修改,但修改后的变化不会同步回父组件。
  • 当父组件中的数据源更改时,与之相关的@Prop装饰的变量都会自动更新。如果子组件已经在本地修改了@Prop装饰的相关变量值,而在父组件中对应的@State装饰的变量被修改后,子组件本地修改的@Prop装饰的相关变量值将被覆盖。

装饰器使用规则说明

@Prop变量装饰器

说明

装饰器参数

同步类型

单向同步:对父组件状态变量值的修改,将同步给子组件@Prop装饰的变量,子组件@Prop变量的修改不会同步到父组件的状态变量上

允许装饰的变量类型

string、number、boolean、enum类型。

不支持any,不允许使用undefined和null。

必须指定类型。

在父组件中,传递给@Prop装饰的值不能为undefined或者null,反例如下所示。

CompA ({ aProp: undefined })

CompA ({ aProp: null })

@Prop和数据源类型需要相同,有以下三种情况(数据源以@State为例):

  • @Prop装饰的变量和父组件状态变量类型相同,即@Prop : S和@State : S,示例请参考父组件@State到子组件@Prop简单数据类型同步。
  • 当父组件的状态变量为数组时,@Prop装饰的变量和父组件状态变量的数组项类型相同,即@Prop : S和@State : Array<S>,示例请参考父组件@State数组中的项到子组件@Prop简单数据类型同步;
  • 当父组件状态变量为Object或者class时,@Prop装饰的变量和父组件状态变量的属性类型相同,即@Prop : S和@State : { propA: S },示例请参考从父组件中的@State类对象属性到@Prop简单类型的同步。

被装饰变量的初始值

允许本地初始化。

示例

@Entry
@Component
struct Index {@State num: number = 10build() {Column() {Text(`Parent -- ${this.num}`)Button("增加Num的值").onClick(() => {this.num++})Child({ num: this.num })}.width('100%').height('100%')}
}@Component
struct Child {@Prop num: numberbuild() {Column() {Text(`Child -- ${this.num}`)Button("子元素 增加Num的值").onClick(() => {this.num++})}.width('100%').height(100).backgroundColor(Color.Pink)}
}

2. @Link 父子双向同步

概述

@Link装饰的变量与其父组件中的数据源共享相同的值。

装饰器使用规则说明

@Link变量装饰器

说明

装饰器参数

同步类型

双向同步。

父组件中@State, @StorageLink和@Link 和子组件@Link可以建立双向数据同步,反之亦然。

允许装饰的变量类型

Object、class、string、number、boolean、enum类型,以及这些类型的数组。嵌套类型的场景请参考观察变化。

类型必须被指定,且和双向绑定状态变量的类型相同。

不支持any,不支持简单类型和复杂类型的联合类型,不允许使用undefined和null。

说明

不支持Length、ResourceStr、ResourceColor类型,Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。

被装饰变量的初始值

无,禁止本地初始化。

示例

在父组件中传递值时,需要使用 $ 来引用子组件中被 @Link 修饰的数据。

简单类型 string、number、boolean、enum

@Entry
@Component
struct Index {@State num: number = 10build() {Column() {Text(`${this.num}`)Button("增加Num的值").onClick(() => {this.num++})Child({ num: $num })}.width('100%').height('100%')}
}@Component
struct Child {@Link num: numberbuild() {Column() {Text(`${this.num}`)Button("子元素 增加Num的值").onClick(() => {this.num++})}.width('100%').height(100).backgroundColor(Color.Pink)}
}

复杂类型 Object、class

class Person {name: string = ""age: number = 0constructor(name: string, age: number) {this.name = name;this.age = age;}
}@Entry
@Component
struct Index {@State p: Person = { name: "lili", age: 18 }build() {Column() {Text(`${this.p.name}--${this.p.age}`)Button("增加age的值").onClick(() => {this.p.age++})Child({ p: $p })}.width('100%').height('100%')}
}@Component
struct Child {@Link p: Personbuild() {Column() {Text(`${this.p.name}--${this.p.age}`)Button("子元素 增加age的值").onClick(() => {this.p.age++})}.width('100%').height(100).backgroundColor(Color.Pink)}
}

3. @Provide / @Consume 后代组件双向同步

概述

@Provide/@Consume装饰的状态变量有以下特性:

  • @Provide装饰的状态变量自动对其所有后代组件可用,即该变量被“provide”给他的后代组件。由此可见,@Provide的方便之处在于,开发者不需要多次在组件之间传递变量。
  • 后代通过使用@Consume去获取@Provide提供的变量,建立在@Provide和@Consume之间的双向数据同步,与@State/@Link不同的是,前者可以在多层级的父子组件之间传递。
  • @Provide和@Consume可以通过相同的变量名或者相同的变量别名绑定,变量类型必须相同。
// 通过相同的变量名绑定
@Provide a: number = 0;
@Consume a: number;// 通过相同的变量别名绑定
@Provide('a') b: number = 0;
@Consume('a') c: number;

@Provide和@Consume通过相同的变量名或者相同的变量别名绑定时,@Provide修饰的变量和@Consume修饰的变量是一对多的关系。不允许在同一个自定义组件内,包括其子组件中声明多个同名或者同别名的@Provide装饰的变量。

装饰器使用规则说明

@State的规则同样适用于@Provide,差异为@Provide还作为多层后代的同步源。

@Provide变量装饰器

说明

装饰器参数

别名:常量字符串,可选。

如果指定了别名,则通过别名来绑定变量;如果未指定别名,则通过变量名绑定变量。

同步类型

双向同步。

从@Provide变量到所有@Consume变量以及相反的方向的数据同步。双向同步的操作与@State和@Link的组合相同。

允许装饰的变量类型

Object、class、string、number、boolean、enum类型,以及这些类型的数组。嵌套类型的场景请参考观察变化。

不支持any,不支持简单类型和复杂类型的联合类型,不允许使用undefined和null。

必须指定类型。@Provide变量的@Consume变量的类型必须相同。

说明

不支持Length、ResourceStr、ResourceColor类型,Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。

被装饰变量的初始值

必须指定。

@Consume变量装饰器

说明

装饰器参数

别名:常量字符串,可选。

如果提供了别名,则必须有@Provide的变量和其有相同的别名才可以匹配成功;否则,则需要变量名相同才能匹配成功。

同步类型

双向:从@Provide变量(具体请参见@Provide)到所有@Consume变量,以及相反的方向。双向同步操作与@State和@Link的组合相同。

允许装饰的变量类型

Object、class、string、number、boolean、enum类型,以及这些类型的数组。嵌套类型的场景请参考观察变化。

不支持any,不允许使用undefined和null。

必须指定类型。@Provide变量的@Consume变量的类型必须相同。

说明

  • @Consume装饰的变量,在其父节点或者祖先节点上,必须有对应的属性和别名的@Provide装饰的变量。

被装饰变量的初始值

无,禁止本地初始化。

示例

class Person {name: string = ""age: number = 0constructor(name: string, age: number) {this.name = name;this.age = age;}
}@Entry
@Component
struct Index {@Provide p: Person = { name: "lili", age: 18 }build() {Column() {Text(`祖先`)Text(`${this.p.name}--${this.p.age}`)Button("增加age的值").onClick(() => {this.p.age++})Parent()}.width('100%').height('100%')}
}@Component
struct Parent {build() {Column() {Text(`父级`)Child()}.width('100%').height(300).backgroundColor(Color.Pink)}
}@Component
struct Child {@Consume p: Personbuild() {Column() {Text(`后代`)Text(`${this.p.name}--${this.p.age}`)Button("子元素 增加age的值").onClick(() => {this.p.age++})}.width('100%').height(200).backgroundColor(Color.Orange)}
}

4. @Observed / @ObjectLink 嵌套类对象属性变化

概述

@ObjectLink和@Observed类装饰器用于在涉及嵌套对象或数组的场景中进行双向数据同步:

  • 被@Observed装饰的类,可以被观察到属性的变化;
  • 子组件中@ObjectLink装饰器装饰的状态变量用于接收@Observed装饰的类的实例,和父组件中对应的状态变量建立双向数据绑定。这个实例可以是数组中的被@Observed装饰的项,或者是class object中的属性,这个属性同样也需要被@Observed装饰。
  • 单独使用@Observed是没有任何作用的,需要搭配@ObjectLink或者@Prop使用。

装饰器使用规则说明

@Observed类装饰器

说明

装饰器参数

类装饰器

装饰class。需要放在class的定义前,使用new创建类对象。

@ObjectLink变量装饰器

说明

装饰器参数

同步类型

不与父组件中的任何类型同步变量。

允许装饰的变量类型

必须为被@Observed装饰的class实例,必须指定类型。

不支持简单类型,可以使用@Prop。

@ObjectLink的属性是可以改变的,但是变量的分配是不允许的,也就是说这个装饰器装饰变量是只读的,不能被改变。

被装饰变量的初始值

不允许。

示例

@Observed
class BookItem {id: number = 0name: string = ""size: number = 0constructor(id: number, name: string, size: number) {this.id = idthis.name = namethis.size = size}
}@Entry
@Component
struct Index {@State bookArr: BookItem[] = [new BookItem(1, "Java", 10),new BookItem(2, "ArkTS", 20)]build() {Column({ space: 10 }) {Text(`${JSON.stringify(this.bookArr)}`)Text(`${JSON.stringify(this.bookArr[0].size)}`)//注意:子组件页面数据是更新的,父组件页面数据未更新//原因:数据本身是更新的,父组件页面不在重新渲染,子组件页面重新渲染Button("修改Size").onClick(() => {this.bookArr[0].size += 1//修改数据的方法1 重新赋值 解构赋值和展开运算 (Next不能用了)//this.bookArr[0] = { ...this.bookArr[0], size:30 }//修改数据的方法2 重新赋值// const book = this.bookArr[0]// this.bookArr[0] = new BookItem(book.id, book.name, 30)})ForEach(this.bookArr,(item) => {Child({ item })},(item) => JSON.stringify(item))}.width('100%').height('100%')}
}@Component
struct Child {@ObjectLink item: BookItembuild() {Column() {Text(`${JSON.stringify(this.item)}`)Text(`${JSON.stringify(this.item.size)}`)Button("子元素---修改Size").onClick(() => {this.item.size += 1})}.width('100%').height('100').backgroundColor(Color.Pink)}
}

这篇关于【鸿蒙开发】组件状态管理@Prop,@Link,@Provide,@Consume,@Observed,@ObjectLink的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/891562

相关文章

Go语言开发实现查询IP信息的MCP服务器

《Go语言开发实现查询IP信息的MCP服务器》随着MCP的快速普及和广泛应用,MCP服务器也层出不穷,本文将详细介绍如何在Go语言中使用go-mcp库来开发一个查询IP信息的MCP... 目录前言mcp-ip-geo 服务器目录结构说明查询 IP 信息功能实现工具实现工具管理查询单个 IP 信息工具的实现服

HTML5中的Microdata与历史记录管理详解

《HTML5中的Microdata与历史记录管理详解》Microdata作为HTML5新增的一个特性,它允许开发者在HTML文档中添加更多的语义信息,以便于搜索引擎和浏览器更好地理解页面内容,本文将探... 目录html5中的Mijscrodata与历史记录管理背景简介html5中的Microdata使用M

Spring 基于XML配置 bean管理 Bean-IOC的方法

《Spring基于XML配置bean管理Bean-IOC的方法》:本文主要介绍Spring基于XML配置bean管理Bean-IOC的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一... 目录一. spring学习的核心内容二. 基于 XML 配置 bean1. 通过类型来获取 bean2. 通过

Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案

《Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案》:本文主要介绍Vue3组件中getCurrentInstance()获取App实例,但是返回nu... 目录vue3组件中getCurrentInstajavascriptnce()获取App实例,但是返回n

python uv包管理小结

《pythonuv包管理小结》uv是一个高性能的Python包管理工具,它不仅能够高效地处理包管理和依赖解析,还提供了对Python版本管理的支持,本文主要介绍了pythonuv包管理小结,具有一... 目录安装 uv使用 uv 管理 python 版本安装指定版本的 Python查看已安装的 Python

使用Python开发一个带EPUB转换功能的Markdown编辑器

《使用Python开发一个带EPUB转换功能的Markdown编辑器》Markdown因其简单易用和强大的格式支持,成为了写作者、开发者及内容创作者的首选格式,本文将通过Python开发一个Markd... 目录应用概览代码结构与核心组件1. 初始化与布局 (__init__)2. 工具栏 (setup_t

Spring Shell 命令行实现交互式Shell应用开发

《SpringShell命令行实现交互式Shell应用开发》本文主要介绍了SpringShell命令行实现交互式Shell应用开发,能够帮助开发者快速构建功能丰富的命令行应用程序,具有一定的参考价... 目录引言一、Spring Shell概述二、创建命令类三、命令参数处理四、命令分组与帮助系统五、自定义S

SpringQuartz定时任务核心组件JobDetail与Trigger配置

《SpringQuartz定时任务核心组件JobDetail与Trigger配置》Spring框架与Quartz调度器的集成提供了强大而灵活的定时任务解决方案,本文主要介绍了SpringQuartz定... 目录引言一、Spring Quartz基础架构1.1 核心组件概述1.2 Spring集成优势二、J

SpringSecurity JWT基于令牌的无状态认证实现

《SpringSecurityJWT基于令牌的无状态认证实现》SpringSecurity中实现基于JWT的无状态认证是一种常见的做法,本文就来介绍一下SpringSecurityJWT基于令牌的无... 目录引言一、JWT基本原理与结构二、Spring Security JWT依赖配置三、JWT令牌生成与

鸿蒙中Axios数据请求的封装和配置方法

《鸿蒙中Axios数据请求的封装和配置方法》:本文主要介绍鸿蒙中Axios数据请求的封装和配置方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1.配置权限 应用级权限和系统级权限2.配置网络请求的代码3.下载在Entry中 下载AxIOS4.封装Htt