鸿蒙Harmony--状态管理器--@Provide装饰器和@Consume装饰器详解

今天是1月11日号星期四，农历腊月初一，辞旧的岁月里，愿你守得云开、终见月明，迎新的时光中，愿你心御寒冬、顺遂无忧，岁末冬深，希望接下来的日子里足够幸运，攒足勇气、信心和运气，去迎接新的一年，去遇见更好的自己！
目录

一，定义

二，特性

三，装饰器说明

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

五，使用

1，简单使用

2，装饰对象

3，装饰Array

一，定义

@Provide和@Consume，应用于与后代组件的双向数据同步，应用于状态数据在多个层级之间传递的场景。不同于其他父子组件之间通过命名参数机制传递，@Provide和@Consume摆脱参数传递机制的束缚，实现跨层级传递。

其中@Provide装饰的变量是在祖先组件中，可以理解为被"提供"给后代的状态变量。@Consume装饰的变量是在后代组件中，去"消费（绑定）"祖先组件提供的变量。

二，特性

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

①@Provide装饰的状态变量自动对其所有后代组件可用，即该变量被"provide"给他的后代组件。由此可见，@Provide的方便之处在于，开发者不需要多次在组件之间传递变量。

②后代通过使用@Consume去获取@Provide提供的变量，建立在@Provide和@Consume之间的双向数据同步，与@State/@Link不同的是，前者可以在多层级的父子组件之间传递。

③@Provide和@Consume可以通过相同的变量名或者相同的变量别名绑定，建议类型相同，否则会发生类型隐式转换，从而导致应用行为异常。

@Provide和@Consume通过相同的变量名或者相同的变量别名绑定时，@Provide修饰的变量和@Consume修饰的变量是一对多的关系。不允许在同一个自定义组件内，包括其子组件中声明多个同名或者同别名的@Provide装饰的变量，@Provide的属性名或别名需要唯一且确定，如果声明多个同名或者同别名的@Provide装饰的变量，会发生运行时报错。

三，装饰器说明

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

@Provide变量装饰器	说明
装饰器参数	别名：常量字符串，可选。如果指定了别名，则通过别名来绑定变量；如果未指定别名，则通过变量名绑定变量。
同步类型	双向同步。从@Provide变量到所有@Consume变量以及相反的方向的数据同步。双向同步的操作与@State和@Link的组合相同。
允许装饰的变量类型	Object、class、string、number、boolean、enum类型，以及这些类型的数组。支持Date类型。不支持any，不支持简单类型和复杂类型的联合类型，不允许使用undefined和null。必须指定类型。@Provide变量的@Consume变量的类型必须相同。说明：不支持Length、ResourceStr、ResourceColor类型，Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。
被装饰变量的初始值	必须指定。

@Consume变量装饰器	说明
装饰器参数	别名：常量字符串，可选。如果提供了别名，则必须有@Provide的变量和其有相同的别名才可以匹配成功；否则，则需要变量名相同才能匹配成功。
同步类型	双向：从@Provide变量（具体请参见@Provide）到所有@Consume变量，以及相反的方向。双向同步操作与@State和@Link的组合相同。
允许装饰的变量类型	Object、class、string、number、boolean、enum类型，以及这些类型的数组。支持Date类型。不支持any，不允许使用undefined和null。必须指定类型。@Provide变量和@Consume变量的类型必须相同。说明： @Consume装饰的变量，在其父节点或者祖先节点上，必须有对应的属性和别名的@Provide装饰的变量。
被装饰变量的初始值	无，禁止本地初始化。

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

@Provide传递/访问	说明
从父组件初始化和更新	可选，允许父组件中常规变量（常规变量对@Prop赋值，只是数值的初始化，常规变量的变化不会触发UI刷新，只有状态变量才能触发UI刷新）、@State、@Link、@Prop、@Provide、@Consume、@ObjectLink、@StorageLink、@StorageProp、@LocalStorageLink和@LocalStorageProp装饰的变量装饰变量初始化子组件@Provide。
用于初始化子组件	允许，可用于初始化@State、@Link、@Prop、@Provide。
和父组件同步	否。
和后代组件同步	和@Consume双向同步。
是否支持组件外访问	私有，仅可以在所属组件内访问。

@Consume传递/访问	说明
从父组件初始化和更新	禁止。通过相同的变量名和alias（别名）从@Provide初始化。
用于初始化子组件	允许，可用于初始化@State、@Link、@Prop、@Provide。
和祖先组件同步	和@Provide双向同步。
是否支持组件外访问	私有，仅可以在所属组件内访问

五，使用

1，简单使用

子组件：

TypeScript 复制代码

@Component
export default struct ProvideTest {
  @Consume name:string

  build() {
    Row() {
      Column() {
        Text("子name:"+ this.name)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            this.name="袁震2"
          })
      }.width('100%')
    }.height('100%')
  }
}

父组件：

TypeScript 复制代码

import ProvideTest from './ProvideTest';

@Entry
@Component
struct Index {

  @Provide name:string ="袁震"

  build() {
    Column(){
      Text("父name:"+this.name)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .onClick(() => {
          this.name ="袁震1"
        })
      ProvideTest()
    }
  }
}

运行结果：

点击父name点击子name

所以，当装饰的数据类型为boolean、string、number类型时，可以观察到数值的变化。

2，装饰对象

数据类：

TypeScript 复制代码

export default class YuanZhen {

  public name: string = 'YuanZhen';

  public age: number = 18;

  constructor(name: string, age: number) {
    this.name = name
    this.age = age
  }
}

TypeScript 复制代码

import YuanZhen from './YuanZhen';

export default class Yuan {

  public number: number = 1;
  public yuanZhen: YuanZhen = new YuanZhen('yuanzhen', 18);

  constructor(number: number, yuanZhen: YuanZhen) {
    this.number = number
    this.yuanZhen = yuanZhen
  }
}

子组件：

TypeScript 复制代码

import Yuan from './bean/Yuan'

@Component
export default struct ProvideTest {
  @Consume yuan:Yuan

  build() {
    Row() {
      Column() {
        Text("子name:" + this.yuan.yuanZhen.name+"\nage:"+this.yuan.yuanZhen.age+"\nnumber:"+this.yuan.number)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            this.yuan.number=26
            this.yuan.yuanZhen.age=30
            this.yuan.yuanZhen.name="袁世震"
          })
      }.width('100%')
    }.height('100%')
  }
}

父组件：

TypeScript 复制代码

import Yuan from './bean/Yuan';
import YuanZhen from './bean/YuanZhen';
import ProvideTest from './ProvideTest';

@Entry
@Component
struct Index {
  @Provide yuan:Yuan=new Yuan(2,new YuanZhen("袁震",18))

  build() {
    Column(){
      Text("父name:" + this.yuan.yuanZhen.name+"\nage:"+this.yuan.yuanZhen.age+"\nnumber:"+this.yuan.number)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .onClick(() => {
          this.yuan.number=1
          this.yuan.yuanZhen.age=32
          this.yuan.yuanZhen.name="袁震1"
        })
      ProvideTest()
    }
  }
}

运行效果：

点击父name点击子name

所以，当装饰的数据类型为class或者Object的时候，可以观察到赋值和属性赋值的变化（属性为Object.keys(observedObject)返回的所有属性）。

3，装饰Array

子组件：

TypeScript 复制代码

import Yuan from './bean/Yuan'

@Component
export default struct ProvideTest {
  @Consume yuan:Array<Yuan>

  build() {
    Row() {
      Column() {
        Text("子size:" + this.yuan.length+"\nage:"+this.yuan[0].yuanZhen.age+"\nnumber:"+this.yuan[0].number)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(() => {
            this.yuan[0].number =20
            this.yuan[0].yuanZhen.age=35
            this.yuan.pop()
          })
      }.width('100%')
    }.height('100%')
  }
}

父组件：

TypeScript 复制代码

import Yuan from './bean/Yuan';
import YuanZhen from './bean/YuanZhen';
import ProvideTest from './ProvideTest';

@Entry
@Component
struct Index {
  @Provide yuan:Array<Yuan>=new Array

  aboutToAppear(){
    let yuan1:Yuan =new Yuan(1,new YuanZhen("袁震1",18))
    let yuan2:Yuan =new Yuan(2,new YuanZhen("袁震2",19))
    let yuan3:Yuan =new Yuan(3,new YuanZhen("袁震3",20))
    this.yuan.push(yuan1)
    this.yuan.push(yuan2)
    this.yuan.push(yuan3)
  }

  build() {
    Column(){
      Text("父size:" + this.yuan.length+"\nage:"+this.yuan[0].yuanZhen.age+"\nnumber:"+this.yuan[0].number)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .onClick(() => {
          this.yuan[0].number =10
          this.yuan[0].yuanZhen.age=30
          this.yuan.pop()
        })
      ProvideTest()
    }
  }
}

运行：

点击父点击子

由此可见，当装饰的对象是array的时候，可以观察到数组的添加、删除、更新数组单元

！注意：更新原理

初始渲染：

@Provide装饰的变量会以map的形式，传递给当前@Provide所属组件的所有子组件；

子组件中如果使用@Consume变量，则会在map中查找是否有该变量名/alias（别名）对应的@Provide的变量，如果查找不到，框架会抛出JS ERROR；

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

当@Provide装饰的数据变化时：

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

通知@Consume更新后，子组件所有依赖@Consume的系统组件（elementId）都会被通知更新。以此实现@Provide对@Consume状态数据同步。

当@Consume装饰的数据变化时：

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