鸿蒙_ArkUI自定义组件常用的三组状态装饰器

状态装饰器的作用是UI组件与变量绑定,当改变被状态装饰器装饰的变量的值,会同时引起UI更新。本文旨在系统比较鸿蒙ArkUI自定义组件开发中核心状态装饰器的用法,包括**@State与@Prop** 、@State与@Link 、**@Provide与@Consume,**帮助开发者学习组件的状态管理。

一、@State与@Prop

主要用于组件间单向数据传递,但作用域与可修改性存在根本差异。

@State:定义组件内部私有状态,仅当前组件可修改并触发刷新。必须初始化(如@State count: number = 0),适用于计数器、开关状态等内部管理。

@Prop:接收父组件传递的数据,支持父→子单向同步。子组件只读不可修改,父组件更新时自动刷新子组件。传递时直接赋值(如Child({propValue: this.parentState})),适用于静态数据展示。

TypeScript 复制代码
// 父组件:定义@State变量并传递
@Entry
@Component
struct ParentComponent {
  @State userName: string = "Tom" // 私有状态,可修改

  build() {
    Column() {
      Text("父组件: " + this.userName)
      Button("修改名称").onClick(() => {
        this.userName = "Jerry" // 触发自身刷新
      })
      // 向子组件传递@Prop (注意:需要传值,否则不会变)
      ChildComponent({ nameProp: this.userName })
    }
  }
}

// 子组件:接收@Prop,只读
@Component
struct ChildComponent {
  @Prop nameProp: string // 单向接收,不可修改,可以有初始值,也可以没有

  build() {
    Column() {
      Text("子组件展示: " + this.nameProp)
    }
  }
}

父组件按钮点击修改userName,子组件自动更新;子组件修改nameProp不会改变父组件。

二、@State与@Link

支持双向数据同步,但绑定机制与作用范围不同。

@State:同上,组件私有状态管理。

@Link:与父组件@State变量建立双向绑定,支持父子同步修改。子组件可读写并回传父组件。适用于表单输入等交互场景。

@State独立刷新,@Link依赖父组件引用;@Link禁止赋默认值。

TypeScript 复制代码
// 父组件:定义@State
@Entry
@Component
struct ParentComponent {
  @State count: number = 0 // 私有状态

  build() {
    Column() {
      Text("父组件计数: " + this.count)
      // 必须传值,不传会报错
      ChildComponent({ countLink: this.count })
    }
  }
}

// 子组件:接收@Link,可修改父状态
@Component
struct ChildComponent {
  @Link countLink: number // 双向绑定

  build() {
    Column() {
      Text("子组件计数: " + this.countLink)
      Button("子组件增加").onClick(() => {
        this.countLink += 1 // 修改同步至父组件
      })
    }
  }
}

子组件按钮点击增加countLink,父组件count同步更新并刷新UI;若父组件修改count,子组件亦同步刷新,双向同步。

三、@Provide与@Consume

用于跨层级组件状态共享,与@State/@Link相比,突破父子限制。

@Provide:在祖先组件提供状态,支持后代组件访问。需初始化(如@Provide() data: string = "Default"),通过别名或属性名绑定。

@Consume:在后代组件消费@Provide状态,支持双向同步。API 20+支持默认值(未匹配@Provide时生效)。

与@State/@Link相比:@Provide/@Consume可跨多层组件(如祖孙),无需逐层传递;@State/@Link仅限父子。@Consume修改自动触发祖先刷新。

TypeScript 复制代码
// 祖先组件:提供数据
@Entry
@Component
struct GrandParent {
  @Provide("sharedData") message: string = "Hello" // 提供状态,别名sharedData

  build() {
    Column() {
      Text("祖先: " + this.message)
      ParentComponent()
    }
  }
}

// 中间组件(无需传递参数)
@Component
struct ParentComponent {
  build() {
    Column() {
      ChildComponent()
    }
  }
}

// 后代组件:消费数据
@Component
struct ChildComponent {
  @Consume("sharedData") childMessage: string // 通过别名匹配

  build() {
    Column() {
      Text("后代: " + this.childMessage)
      Button("修改数据").onClick(() => {
        this.childMessage = "Updated" // 修改同步至祖先
      })
    }
  }
}

后代组件按钮点击修改childMessage,祖先组件message自动更新;祖先修改message,后代同步刷新,适用于全局配置或多级表单。如果变量名不一致可以取相同别名,变量名一致可以不取别名。

四、总结

  1. @State、@Prop:父子单向传递,需要传参,不传不报错只是不起作用
  2. @State、@Link:父子双向同步,必须传参否则报错
  3. @Provide、@Consume:数据提供者和消费者的关系,可以跨多层组件使用,双向同步,直接使用不用传参
相关推荐
~远在太平洋~几秒前
06-鸿蒙系统 uitest UI 自动化指南
ui·自动化·harmonyos
OH_TPC6 分钟前
OpenHarmony平台RN三方库适配情况
华为·harmonyos·鸿蒙
坚果的博客23 分钟前
从 0 到 1:用 CJMP 开发「每日早报」鸿蒙应用完整实战
华为·harmonyos
Magic-ZYJ40 分钟前
HarmonyOS 权限申请完整流程:声明、检查、请求、拒绝后二次授权
华为·harmonyos·移动应用开发·arcts·arcui
张星河zen1 小时前
端侧AI芯片暗战,苹果华为小米新一代手机芯片技术路线详解
华为·小米·苹果·端侧·韬定律·玄戒
大雷神1 小时前
HarmonyOS ArkGraphics 2D场景化可变帧率实操——做一个智能帧率专注计时器
pytorch·华为·harmonyos
坚果的博客1 小时前
CPF-KMP-CMP:在鸿蒙上用 Kotlin 写跨平台应用
华为·kotlin·harmonyos
Hstar_chen11 小时前
开源一款 HarmonyOS 服务器监控客户端:星辰云巡 1.0.3
服务器·华为·harmonyos
2501_9197490318 小时前
华为鸿蒙免费视频播放器APP—小羊免费播放器
华为·harmonyos·鸿蒙
2501_9197490319 小时前
华为鸿蒙免费背书背课文背稿子APP—小羊背诵
华为·harmonyos·鸿蒙