ArkTS-@Provide装饰器和@Consume装饰器

2023-06-27 14:41:53 浏览数 (1)

@Privide装饰器和@Consume装饰器与后代组件双向同步

@Provide和@Consume,应用于与后代组件的双向数据同步,应用于状态数据在多个层级之间传递的场景。不同于上文提到的父子组件之间通过明明参数机制传递,@Provide和@Consume拜托参数传递机制的舒服,实现跨层级传递。其中@Provide装饰的变量是在祖先结点中,可以理解为被”提供“给后代的状态变量。@Consume装饰的变量是在后代组件中,去“消费(绑定)”祖先节点提供的变量。

概述

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

  • @Privide装饰的状态变量自动对齐所有后代组件可用,即该变量被“provide“给他的后代组件。由此可见,@Provide的方便之处在于,开发者不需要多次在组件之间传递变量。
  • 后代通过使用@Consume去获取@Provide提供的变量,建立在@Provide和@Consume之间的双向数据同步,与@State/@Link不同的是,前者可以在多层级的父子组件之间传递。
  • @Provide和@Consume可用通过相同的变量名或者相同的变量别名绑定,变量类型必须相同。
代码语言:javascript复制
//通过相同的变量名绑定
@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,不支持简单类型和复杂类型的联合类型,不允许使用undefinded和null。必须指定类型。@Provide变量的@Consume变量的类型必须相同

被装饰变量的初始值

必须指定

@Consume变量装饰器

说明

装饰器参数

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

同步类型

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

允许装饰的变量类型

Object,class,string,number,boolean ,enum类型,以及这些类型的数组。嵌套类型的场景请参考观察变化。不支持any,不允许使用undefined和null。必须指定类型。@Provide变量的@Consume变量的类型必须相同。

被装饰变量的初始值

无,禁止本地初始化

变量的传递/访问规则说明

@Provide传递/访问

说明

从父组件初始化和更新

可选,允许父组件中常规变量,@State,@Link,@Prop,@Provide,@Consume,@ObjectLink,@StorageLink,@StorageProp,@LocalStorageLink和@LocalStorageProp装饰的变量装饰变量初始化子组件@Provide

用于初始化子组件

允许,可用于初始化@State,@Link,@Prop,@Provide

和父组件同步

和后代组件同步

和@Consume双向同步

是否支持组件外访问

私有,仅可以在所述组件内访问

@Consume传递/访问

说明

从父组件初始化和更新

禁止,通过相同的变量名和alias从@Provide初始化

用于初始化子组件

允许,可用于初始化@State,@Link,@Prop,@Provide

和祖先组件同步

和@Provide双向同步

是否支持组件外访问

私有,尽可以在所属组件内访问

观察变化和行为表现

观察变化
  • 当装饰的数据类型为Boolean,string,number类型时,可以观察到数值的变化
  • 当装饰的数据类型为class或者Object的时候,可以观察到赋值和属性赋值的变化(属性为Object.keys(observedObject)返回的所有属性)
  • 当装饰的对象是array的时候,可以观察到数组的添加,删除,更新数组单元。
框架行为

1.初始渲染:

​ a.@Provide装饰的变量会以map的形式,传递给当前@Provide所属组件的所有子组件;

​ b.子组件中如果使用@Consume变量,则会在map中查找是否有该变量名/alias(别名)对应的@Provide的变量,如果查找不到,框架会抛出JS ERROR;

​ c.在初始化@Consume变量时,和@State/@Link的流程类似,@Consume变量会保存在map中查找到的@Provide变量,并把自己注册给@Provide

2.当@Provide装饰的数据变化时:

​ a.通过初始渲染的步骤可知,子组件@Consume已把自己注册给父组件。父组件@Provide变量变更后,会遍历更新所有依赖它的系统组件(elementid)和状态变量(@Consume);

​ b.通知@Consume更新后,子组件所有依赖@Consume的系统组件(elementId)都会被通知更新。以此实现@Provide对@Consume状态数据同步。

3.当@Consume装饰的数据变化时:

​ a.通过初始渲染的步骤可知,子组件@Consume持有@Provide的实例。在@Consume更新后调用@Provide的更新方法,将更新的数值同步回@Provide,以此实现@Consume向@Provide的同步更新。

使用场景

在下面的示例是与后代组件双向同步状态@Provide和@Consume场景。当分别点击CompA和CompD组件内Button时,reviewVotes的更改会双向同步在CompA和CompD中。

代码语言:javascript复制
@Component
strct CompD{
    //@Consume装饰的变量通过相同的属性名绑定其祖先组件CompA内的@Provide装饰的变量
    @Consume reviewVotes: number;
    
    build(){
        Column(){
            Text(`reviewVotes(${this.reviewVotes}`)
            Button(`reviewVOtes(${this.reviewVotes},give 1`)
            	.onClick(()=>this.reviewVotes  =1)
        }
        .width('50$')
    }
}

@Component
struct CompC{
    build(){
        Row({space:5}){
            CompD()
            CompD()
        }
    }
}
@Component
struct CompB{
    build(){
        CompC()
    }
}
@Entry
@Component
struct CompA{
    //@Provide装饰的变量reviewVites由入口组件CompA提供其后代组件
    @Provide reviewVotes: number = 0;
    build(){
        Column(){
            Button(`reviewVotes(${this.reviewVotes}),give 1`)
            	.onClick(()=> this.reviewVotes  =1)
            CompB()
        }
    }
}

0 人点赞