@State 装饰的变量，或称为状态变量，一旦变量拥有了状态属性，就和自定义组件的渲染绑定起来。当状态改变时，UI 会发生对应的渲染改变。
在状态变量相关装饰器中，@State 是最基础的，使变量拥有状态属性的装饰器，它也是大部分状态变量的数据源。
说明：
从 API version 9 开始，该装饰器支持在 ArkTS 卡片中使用。
概述
@State 装饰的变量，与声明式范式中的其他被装饰变量一样，是私有的，只能从组件内部访问，在声明时必须指定其类型和本地初始化。初始化也可选择使用命名参数机制从父组件完成初始化。
@State 装饰的变量拥有以下特点：
● @State 装饰的变量与子组件中的 @Prop、@Link 或 @ObjectLink 装饰变量之间建立单向或双向数据同步。
● @State 装饰的变量生命周期与其所属自定义组件的生命周期相同。
装饰器使用规则说明
变量的传递/访问规则说明
图 1 初始化规则图示
观察变化和行为表现
并不是状态变量的所有更改都会引起 UI 的刷新，只有可以被框架观察到的修改才会引起 UI 刷新。该小节去介绍什么样的修改才能被观察到，以及观察到变化后，框架的是怎么引起 UI 刷新的，即框架的行为表现是什么。
观察变化
● 当装饰的数据类型为 boolean、string、number 类型时，可以观察到数值的变化。
// for simple type@State count: number = 0;// value changing can be observedthis.count = 1;
复制代码
●当装饰的数据类型为 class 或者 Object 时，可以观察到自身的赋值的变化，和其属性赋值的变化，即 Object.keys(observedObject)返回的所有属性。例子如下。 声明 ClassA 和 Model 类。 class ClassA {public value: string;
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
// class类型 @State title: Model = new Model('Hello', new ClassA('World'));
复制代码
对 @State 装饰变量的赋值。
// class类型赋值this.title = new Model('Hi', new ClassA('ArkUI'));
复制代码
对 @State 装饰变量的属性赋值。
// class属性的赋值this.title.value = 'Hi'
复制代码
嵌套属性的赋值观察不到。
// 嵌套的属性赋值观察不到this.title.name.value = 'ArkUI'
复制代码
● 当装饰的对象是 array 时，可以观察到数组本身的赋值和添加、删除、更新数组的变化。例子如下。 声明 ClassA 和 Model 类。
class Model { public value: number; constructor(value: number) { this.value = value; }}
复制代码
@State 装饰的对象为 Model 类型数组时。
@State title: Model[] = [new Model(11), new Model(1)]
复制代码
数组自身的赋值可以观察到。
this.title = [new Model(2)]
复制代码
数组项的赋值可以观察到。
this.title[0] = new Model(2)
复制代码
删除数组项可以观察到。
新增数组项可以观察到。
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 的属性。
@Entry@Componentstruct 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 组件的更新方法，实现按需刷新。
class Model { public value: string;
constructor(value: string) { this.value = value; }}
@Entry@Componentstruct EntryComponent { build() { Column() { // 此处指定的参数都将在初始渲染时覆盖本地定义的默认值，并不是所有的参数都需要从父组件初始化 MyComponent({ count: 1, increaseBy: 2 }) MyComponent({ title: new Model('Hello, World 2'), count: 7 }) } }}
@Componentstruct 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. 使用默认的本地初始化：
@State title: Model = new Model('Hello World');@State count: number = 0;
复制代码
2. 对于 @State 来说，命名参数机制传递的值并不是必选的，如果没有命名参数传值，则使用本地初始化的默认值：
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)
复制代码
评论