1. 概述
@State装饰的变量，与声明式范式中的其他被装饰变量一样，是私有的，只能从组件内部访问，在声明时必须指定其类型和本地初始化。
2. 装饰器使用规则说明
| @State变量装饰器 | 说明 |
|---|---|
| 装饰器参数 | 无 |
| 同步类型 | 不与父组件中任何类型的变量同步。 |
| 允许装饰的变量类型 | Object、class、string、number、boolean、enum类型，以及这些类型的数组。嵌套类型的场景请参考观察变化。 类型必须被指定。 不支持any，不支持简单类型和复杂类型的联合类型，不允许使用undefined和null。 说明 建议不要装饰Date类型，应用可能会产生异常行为。 不支持Length、ResourceStr、ResourceColor类型，Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。 |
| 被装饰变量的初始值 | 必须本地初始化。 |
不允许使用 any、undefined、null 类型
不能装饰 Date 类型
不支持Length、ResourceStr、ResourceColor类型，Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。
3. 观察变化
3.1 boolean、string、number
当装饰的数据类型为boolean、string、number类型时，可以观察到数值的变化。
// for simple type
@State count: number = 0;
// value changing can be observed
this.count = 1;3.2 class、Object
当装饰的数据类型为class或者Object时，可以观察到自身的赋值的变化。
声明ClassA和Model类。
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';3.3 array
当装饰的对象是array时，可以观察到数组本身的赋值和添加、删除、更新数组的变化。例子如下。
声明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.pop();新增数组项可以观察到。
this.title.push(new Model(12));数组项中属性的赋值观察不到。
this.title[0].value = 6;4. 框架行为
- 当状态变量被改变时，查询依赖该状态变量的组件；
- 执行依赖该状态变量的组件的更新方法，组件更新渲染；
- 和该状态变量不相关的组件或者UI描述不会发生重新渲染，从而实现页面渲染的按需更新。
5. 装饰简单类型的变量
以下示例为@State装饰的简单类型，count被@State装饰成为状态变量，count的改变引起Button组件的刷新：
- 当状态变量count改变时，查询到只有Button组件关联了它；
- 执行Button组件的更新方法，实现按需刷新。
@Entry
@Component
struct APage {
@State count: number = 0;
build() {
Column() {
Button(`click times: ${this.count}`)
.onClick(() => {
this.count += 1;
})
}
.width('100%')
.height('100%')
}
}
6. 装饰class对象类型的变量
-
自定义组件MyComponent定义了被@State装饰的状态变量title，其中title的类型为自定义类Model。如果title的值发生变化，则查询MyComponent中使用该状态变量的UI组件，并进行重新渲染。
@Entry
@Component
struct APage {
build() {
Column() {
MyComponent({ title: new Model('Hello World 2') })
}
.width('100%')
.height('100%')
}
}
class Model {
public value: string;
constructor(value: string) {
this.value = value;
}
}
@Component
struct MyComponent {
@State title: Model = new Model('Hello World');
build() {
Column() {
Text(`${this.title.value}`)
.margin(10)
Button(`Click to change title`)
.onClick(() => {
// @State变量的更新将触发上面的Text组件内容更新
this.title.value = this.title.value === 'Hello ArkUI' ? 'Hello World' : 'Hello ArkUI';
})
.width(300)
.margin(10)
}
}
}
