前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >OpenHarmony组件内状态变量使用:@State装饰器

OpenHarmony组件内状态变量使用:@State装饰器

原创
作者头像
小帅聊鸿蒙
发布于 2025-05-13 08:05:55
发布于 2025-05-13 08:05:55
430
举报
文章被收录于专栏:鸿蒙开发笔记鸿蒙开发笔记

@State装饰的变量,或称为状态变量,一旦变量拥有了状态属性,就和自定义组件的渲染绑定起来。当状态改变时,UI会发生对应的渲染改变。

在状态变量相关装饰器中,@State是最基础的,使变量拥有状态属性的装饰器,它也是大部分状态变量的数据源。

说明:API version 9开始,该装饰器支持在ArkTS卡片中使用。

概述

@State装饰的变量,与声明式范式中的其他被装饰变量一样,是私有的,只能从组件内部访问,在声明时必须指定其类型和本地初始化。初始化也可选择使用命名参数机制从父组件完成初始化。

@State装饰的变量拥有以下特点:

● @State装饰的变量与子组件中的@Prop、@Link或@ObjectLink装饰变量之间建立单向或双向数据同步

● @State装饰的变量生命周期与其所属自定义组件的生命周期相同。

装饰器使用规则说明

@State变量装饰器

说明

装饰器参数

同步类型

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

允许装饰的变量类型

Object、class、string、number、boolean、enum类型,以及这些类型的数组。支持Date类型。支持类型的场景请参考 观察变化 。类型必须被指定。不支持any,不支持简单类型和复杂类型的联合类型,不允许使用undefined和null。说明:不支持Length、ResourceStr、ResourceColor类型,Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。

被装饰变量的初始值

必须本地初始化。

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

传递/访问

说明

从父组件初始化

可选,从父组件初始化或者本地初始化。如果从父组件初始化将会覆盖本地初始化。支持父组件中常规变量(常规变量对@Prop赋值,只是数值的初始化,常规变量的变化不会触发UI刷新,只有状态变量才能触发UI刷新)、@State、@Link、@Prop、@Provide、@Consume、@ObjectLink、@StorageLink、@StorageProp、@LocalStorageLink和@LocalStorageProp装饰的变量,初始化子组件的@State。

用于初始化子组件

@State装饰的变量支持初始化子组件的常规变量、@State、@Link、@Prop、@Provide。

是否支持组件外访问

不支持,只能在组件内访问。

图1 初始化规则图示

观察变化和行为表现

并不是状态变量的所有更改都会引起UI的刷新,只有可以被框架观察到的修改才会引起UI刷新。该小节去介绍什么样的修改才能被观察到,以及观察到变化后,框架的是怎么引起UI刷新的,即框架的行为表现是什么。

观察变化

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

代码语言:ts
AI代码解释
复制
// for simple type
@State count: number = 0;
// value changing can be observed
this.count = 1;

● 当装饰的数据类型为class或者Object时,可以观察到自身的赋值的变化,和其属性赋值的变化,即Object.keys(observedObject)返回的所有属性。例子如下。 声明ClassA和Model类。

代码语言:ts
AI代码解释
复制
  class ClassA {
    public value: string;

    constructor(value: string) {
      this.value = value;
    }
  }

  class Model {
    public value: string;
    public name: ClassA;
    constructor(value: string, a: ClassA) {
      this.value = value;
      this.name = a;
    }
  }

@State装饰的类型是Model

代码语言:ts
AI代码解释
复制
// class类型
 @State title: Model = new Model('Hello', new ClassA('World'));

对@State装饰变量的赋值。

代码语言:ts
AI代码解释
复制
// class类型赋值
this.title = new Model('Hi', new ClassA('ArkUI'));

对@State装饰变量的属性赋值。

代码语言:ts
AI代码解释
复制
// class属性的赋值
this.title.value = 'Hi'

嵌套属性的赋值观察不到。

代码语言:ts
AI代码解释
复制
// 嵌套的属性赋值观察不到
this.title.name.value = 'ArkUI'

● 当装饰的对象是array时,可以观察到数组本身的赋值和添加、删除、更新数组的变化。例子如下。 声明ClassA和Model类。

代码语言:ts
AI代码解释
复制
class Model {
  public value: number;
  constructor(value: number) {
    this.value = value;
  }
}

@State装饰的对象为Model类型数组时。

代码语言:ts
AI代码解释
复制
@State title: Model[] = [new Model(11), new Model(1)]

数组自身的赋值可以观察到。

代码语言:ts
AI代码解释
复制
this.title = [new Model(2)]

数组项的赋值可以观察到。

代码语言:ts
AI代码解释
复制
this.title[0] = new Model(2)

删除数组项可以观察到。

代码语言:ts
AI代码解释
复制
this.title.pop()

新增数组项可以观察到。

代码语言:ts
AI代码解释
复制
this.title.push(new Model(12))

● 当装饰的对象是Date时,可以观察到Date整体的赋值,同时可通过调用Date的接口setFullYear, setMonth, setDate, setHours, setMinutes, setSeconds, setMilliseconds, setTime, setUTCFullYear, setUTCMonth, setUTCDate, setUTCHours, setUTCMinutes, setUTCSeconds, setUTCMilliseconds 更新Date的属性。

代码语言:ts
AI代码解释
复制
@Entry
@Component
struct DatePickerExample {
  @State selectedDate: Date = new Date('2021-08-08')

  build() {
    Column() {
      Button('set selectedDate to 2023-07-08')
        .margin(10)
        .onClick(() => {
          this.selectedDate = new Date('2023-07-08')
        })
      Button('increase the year by 1')
        .margin(10)
        .onClick(() => {
          this.selectedDate.setFullYear(this.selectedDate.getFullYear() + 1)
        })
      Button('increase the month by 1')
        .margin(10)
        .onClick(() => {
          this.selectedDate.setMonth(this.selectedDate.getMonth() + 1)
        })
      Button('increase the day by 1')
        .margin(10)
        .onClick(() => {
          this.selectedDate.setDate(this.selectedDate.getDate() + 1)
        })
      DatePicker({
        start: new Date('1970-1-1'),
        end: new Date('2100-1-1'),
        selected: this.selectedDate
      })
    }.width('100%')
  }
}

框架行为

● 当状态变量被改变时,查询依赖该状态变量的组件;

● 执行依赖该状态变量的组件的更新方法,组件更新渲染;

● 和该状态变量不相关的组件或者UI描述不会发生重新渲染,从而实现页面渲染的按需更新。

使用场景

装饰简单类型的变量

以下示例为@State装饰的简单类型,count被@State装饰成为状态变量,count的改变引起Button组件的刷新:

● 当状态变量count改变时,查询到只有Button组件关联了它;

● 执行Button组件的更新方法,实现按需刷新。

代码语言:ts
AI代码解释
复制
@Entry
@Component
struct MyComponent {
  @State count: number = 0;

  build() {
    Button(`click times: ${this.count}`)
      .onClick(() => {
        this.count += 1;
      })
  }
}

装饰class对象类型的变量

● 自定义组件MyComponent定义了被@State装饰的状态变量count和title,其中title的类型为自定义类Model。如果count或title的值发生变化,则查询MyComponent中使用该状态变量的UI组件,并进行重新渲染。

● EntryComponent中有多个MyComponent组件实例,第一个MyComponent内部状态的更改不会影响第二个MyComponent。

代码语言:ts
AI代码解释
复制
class Model {
  public value: string;

  constructor(value: string) {
    this.value = value;
  }
}

@Entry
@Component
struct EntryComponent {
  build() {
    Column() {
      // 此处指定的参数都将在初始渲染时覆盖本地定义的默认值,并不是所有的参数都需要从父组件初始化
      MyComponent({ count: 1, increaseBy: 2 })
      MyComponent({ title: new Model('Hello, World 2'), count: 7 })
    }
  }
}

@Component
struct MyComponent {
  @State title: Model = new Model('Hello World');
  @State count: number = 0;
  private increaseBy: number = 1;

  build() {
    Column() {
      Text(`${this.title.value}`)
      Button(`Click to change title`).onClick(() => {
        // @State变量的更新将触发上面的Text组件内容更新
        this.title.value = this.title.value === 'Hello ArkUI' ? 'Hello World' : 'Hello ArkUI';
      })

      Button(`Click to increase count=${this.count}`).onClick(() => {
        // @State变量的更新将触发该Button组件的内容更新
        this.count += this.increaseBy;
      })
    }
  }
}

从该示例中,我们可以了解到@State变量首次渲染的初始化流程:

1. 使用默认的本地初始化:

代码语言:ts
AI代码解释
复制
@State title: Model = new Model('Hello World');
@State count: number = 0;

2. 对于@State来说,命名参数机制传递的值并不是必选的,如果没有命名参数传值,则使用本地初始化的默认值:

代码语言:ts
AI代码解释
复制
class C1 {
   public count:number;
   public increaseBy:number;
   constructor(count: number, increaseBy:number) {
   this.count = count;
   this.increaseBy = increaseBy;
  }
}
let obj = new C1(1, 2)
MyComponent(obj)

写在最后

如果你觉得这篇内容对你还蛮有帮助,我想邀请你帮我三个小忙:

  • 点赞,转发,有你们的 『点赞和评论』,才是我创造的动力;
  • 关注小编,同时可以期待后续文章ing🚀,不定期分享原创知识;
  • 想要获取更多完整鸿蒙最新学习知识点,可关注B站:码牛课堂;

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
【愚公系列】2023年11月 HarmonyOS教学课程 003-ArkTS语言(状态管理)
状态管理是指在应用程序中维护和更新应用程序状态的过程。在一个程序中,可能有很多不同的组件和模块,它们需要共享和相互作用的状态。如果没有一个明确的方式来管理这些状态,就会导致代码混乱、不易维护和难以扩展。
愚公搬代码
2025/06/02
640
【愚公系列】2023年11月 HarmonyOS教学课程 003-ArkTS语言(状态管理)
OpenHarmony 状态变量更改通知:@Watch 装饰器
@Watch 应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变,可以使用 @Watch 为状态变量设置回调函数。
小帅聊鸿蒙
2025/05/16
400
HarmonyOS学习路之方舟开发框架—学习ArkTS语言(状态管理 一)
在前文的描述中,我们构建的页面多为静态界面。如果希望构建一个动态的、有交互的界面,就需要引入“状态”的概念。
爱吃土豆丝的打工人
2023/10/15
5840
HarmonyOS学习路之方舟开发框架—学习ArkTS语言(状态管理 一)
OpenHarmony父子组件单项同步使用:@Prop装饰器
@Prop装饰的变量可以和父组件建立单向的同步关系。@Prop装饰的变量是可变的,但是变化不会同步回其父组件。
小帅聊鸿蒙
2025/05/14
710
OpenHarmony父子组件单项同步使用:@Prop装饰器
ArkTS-@State组件内状态
@State装饰的变量,或称为状态变量,一旦拥有了状态属性,就和自定义组件的渲染绑定起来。当状态改变时,UI会发生对应的渲染改变。
酒楼
2023/06/27
1K0
OpenHarmony嵌套类对象属性变化:@Observed装饰器和@ObjectLink装饰器
上文所述的装饰器仅能观察到第一层的变化,但是在实际应用开发中,应用会根据开发需要,封装自己的数据模型。对于多层嵌套的情况,比如二维数组,或者数组项class,或者class的属性是class,他们的第二层的属性变化是无法观察到的。这就引出了@Observed/@ObjectLink装饰器。
小帅聊鸿蒙
2025/05/15
550
OpenHarmony嵌套类对象属性变化:@Observed装饰器和@ObjectLink装饰器
HarmonyOS NEXT - @State状态变量
ArkUI作为一种声明式UI,具有状态驱动UI更新的特点。当用户进行界面交互或有外部事件引起状态改变时,状态的变化会触发组件自动更新。所以在ArkUI中,我们只需要通过一个变量来记录状态。当改变状态的时候,ArkUI就会自动更新界面中受影响的部分。
用户9936235
2025/03/31
1160
OpenHarmony后代组件双向同步,跨层级传递:@Provide装饰器和@Consume装饰器
@Provide和@Consume,应用于与后代组件的双向数据同步,应用于状态数据在多个层级之间传递的场景。不同于上文提到的父子组件之间通过命名参数机制传递,@Provide和@Consume摆脱参数传递机制的束缚,实现跨层级传递。
小帅聊鸿蒙
2025/05/14
560
OpenHarmony后代组件双向同步,跨层级传递:@Provide装饰器和@Consume装饰器
【HarmonyOS之旅】ArkTS语法(一)
ArkTS通过装饰器@Component和@Entry装饰struct关键字声明的数据结构,构成一个自定义组件。
枫叶丹
2024/12/26
2990
【HarmonyOS之旅】ArkTS语法(一)
HarmonyOS NEXT 实战系列04-组件状态
自定义组件拥有变量,变量必须被装饰器装饰才可以成为状态变量,状态变量的改变会引起UI的渲染刷新。如果不使用状态变量,UI只能在初始化时渲染,后续将不会再刷新。 下图展示了State和View(UI)之间的关系。
用户8181473
2025/03/17
700
OpenHarmony父子组件双项同步使用:@Link装饰器
● 当装饰的数据类型为boolean、string、number类型时,可以同步观察到数值的变化,示例请参考 简单类型和类对象类型的@Link 。
小帅聊鸿蒙
2025/05/12
570
OpenHarmony父子组件双项同步使用:@Link装饰器
ArkTS-@Observed装饰器和@ObjectLink装饰器
上文所属的装饰器仅能观察到第一层的变化,但是在实际应用开发中,应用会根据开发需要,封装自己的 数据模型。对于多层嵌套的情况,比如二维数组,或者数组项class,或者class的属性是class,他们的第二层的属性变化是无法观察到的。这就引出了@Observed/@ObjectLink装饰器
酒楼
2023/07/05
8500
ArkTS-@Link装饰器父子双向同步
为了了解@Link变量初始化和更新机制,有必要先了解父组件和拥有@Link变量的子组件的关系,初始渲染和双向更新的流程(以父组件为@State为例)。
酒楼
2023/06/27
6550
HarmonyOS学习路之方舟开发框架—学习ArkTS语言(状态管理 二)
@Prop装饰的变量可以和父组件建立单向的同步关系。@Prop装饰的变量是可变的,但是变化不会同步回其父组件。
爱吃土豆丝的打工人
2023/10/15
4240
HarmonyOS学习路之方舟开发框架—学习ArkTS语言(状态管理 二)
ArkTS-@Prop父子单向同步
@Prop装饰的变量可以和父组件建立单向的同步关系。@Prop装饰的变量是可变的,但是变化不会同步回其父组件。
酒楼
2023/06/27
3910
ArkTS-@Watch装饰器
@Watch应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变,可以使用@Watch为状态变量设置回调函数。
酒楼
2023/07/05
6840
OpenHarmony应用全局的UI状态存储:AppStorage
AppStorage是应用全局的UI状态存储,是和应用的进程绑定的,由UI框架在应用程序启动时创建,为应用程序UI状态属性提供中央存储。
小帅聊鸿蒙
2025/05/15
1270
OpenHarmony应用全局的UI状态存储:AppStorage
鸿蒙(HarmonyOS)性能优化实战-状态管理
为了帮助应用程序开发人员提高其应用程序质量,特别是在高效的状态管理方面。本章节面向开发者提供了多个在开发ArkUI应用中常见的低效开发的场景,并给出了对应的解决方案。此外,还提供了同一场景下,推荐用法和不推荐用法的对比和解释说明,更直观地展示两者区别,从而帮助开发者学习如何正确地在应用开发中使用状态变量,进行高性能开发。
小帅聊鸿蒙
2024/10/19
1750
鸿蒙(HarmonyOS)性能优化实战-状态管理
鸿蒙next开发中父子组件如何进行数据通信(状态管理v1版)?
配合@State使用,子组件用@Link接收, 可以实现页面双向传递 数据从父组件传入子组件,在子组件中修改则父组件ui更新 (传递值时使用$)
言程序
2024/12/27
2110
鸿蒙next开发中父子组件如何进行数据通信(状态管理v1版)?
【HarmonyOS 5】鸿蒙中@State的原理详解
@State 是 HarmonyOS ArkTS 框架中用于管理组件状态的核心装饰器,其核心作用是实现数据驱动 UI 的响应式编程模式。通过将变量标记为 @State,开发者可以确保当状态值发生变化时,依赖该状态的 UI 组件会自动重新渲染,从而保持数据与界面的实时同步。
GeorgeGcs
2025/04/10
2280
【HarmonyOS 5】鸿蒙中@State的原理详解
推荐阅读
相关推荐
【愚公系列】2023年11月 HarmonyOS教学课程 003-ArkTS语言(状态管理)
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档