HarmonyOS 鸿蒙Next ArkTS语言教程入门学习第14天,@State装饰器:组件内状态。

发布于 1周前 作者 ionicwang 来自 鸿蒙OS

HarmonyOS 鸿蒙Next ArkTS语言教程入门学习第14天,@State装饰器:组件内状态。 1、@State装饰器:组件内状态

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

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

说明

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

2、概述

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

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

  • @State装饰的变量与子组件中的@Prop装饰变量之间建立单向数据同步,与@Link@ObjectLink装饰变量之间建立双向数据同步。
  • @State装饰的变量生命周期与其所属自定义组件的生命周期相同。

3、装饰器使用规则说明

@State变量装饰器 说明
装饰器参数
同步类型 不与父组件中任何类型的变量同步。
允许装饰的变量类型 Object、class、string、number、boolean、enum类型,以及这些类型的数组。嵌套类型的场景请参考观察变化。 类型必须被指定。 不支持any,不支持简单类型和复杂类型的联合类型,不允许使用undefined和null。 建议不要装饰Date类型,应用可能会产生异常行为。 不支持Length、ResourceStr、ResourceColor类型,Length、ResourceStr、ResourceColor为简单类型和复杂类型的联合类型。
被装饰变量的初始值 必须本地初始化。

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

传递/访问 说明
从父组件初始化 可选,从父组件初始化或者本地初始化。如果从父组件初始化将会覆盖本地初始化。 支持父组件中常规变量、@State@Link@Prop@Provide@Consume@ObjectLink@StorageLink@StorageProp@LocalStorageLink@LocalStorageProp装饰的变量,初始化子组件的@State
用于初始化子组件 @State装饰的变量支持初始化子组件的常规变量、@State@Link@Prop@Provide
是否支持组件外访问 不支持,只能在组件内访问。

5、观察变化和行为表现

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

观察变化

  • 当装饰的数据类型为boolean、string、number类型时,可以观察到数值的变化。
// for simple type
[@State](/user/State) count: number = 0;
// value changing can be observed
this.count = 1;

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

声明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](/user/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时,可以观察到数组本身的赋值和添加、删除、更新数组的变化。例子如下。

声明Model类。

class Model {
  public value: number;
  constructor(value: number) {
    this.value = value;
  }
}

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

[@State](/user/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;

6、框架行为

  • 当状态变量被改变时,查询依赖该状态变量的组件;
  • 执行依赖该状态变量的组件的更新方法,组件更新渲染;
  • 和该状态变量不相关的组件或者UI描述不会发生重新渲染,从而实现页面渲染的按需更新。

7、使用场景

装饰简单类型的变量

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

  • 当状态变量count改变时,查询到只有Button组件关联了它;
  • 执行Button组件的更新方法,实现按需刷新。
[@Entry](/user/Entry)
[@Component](/user/Component)
struct MyComponent {
  [@State](/user/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。
class Model {
  public value: string;

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

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

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

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

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

更多关于HarmonyOS 鸿蒙Next ArkTS语言教程入门学习第14天,@State装饰器:组件内状态。的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html

2 回复

在HarmonyOS鸿蒙Next中,[@State](/user/State)装饰器用于管理组件内部的状态。通过[@State](/user/State)装饰的变量,当其值发生变化时,会触发UI的自动更新。[@State](/user/State)装饰器适用于组件内部的私有状态管理,通常用于简单的UI交互场景。

基本用法

  1. 声明状态变量:使用[@State](/user/State)装饰器修饰组件类中的变量,该变量即为组件的状态变量。

    [@State](/user/State) count: number = 0;
  2. 状态更新:当状态变量的值发生变化时,UI会自动重新渲染。

    this.count += 1;
  3. UI绑定:将状态变量绑定到UI组件上,实现数据与视图的同步。

    Text(`${this.count}`)

示例代码

@Entry
@Component
struct MyComponent {
  [@State](/user/State) count: number = 0;

  build() {
    Column() {
      Text(`Count: ${this.count}`)
        .fontSize(30)
      Button('Increment')
        .onClick(() => {
          this.count += 1;
        })
    }
  }
}

在上面的示例中,count是一个状态变量,初始值为0。当用户点击按钮时,count的值会增加,并且UI会自动更新以显示最新的计数值。

注意事项

  • [@State](/user/State)装饰器只能用于组件类中的变量。
  • 状态变量的变化会触发组件的重新渲染,因此应避免频繁更新状态变量以优化性能。
  • [@State](/user/State)装饰器适用于简单的状态管理,对于复杂的状态管理,可以考虑使用@Link@Provide等其他装饰器。

通过[@State](/user/State)装饰器,开发者可以轻松实现组件内部的状态管理,提升开发效率。

更多关于HarmonyOS 鸿蒙Next ArkTS语言教程入门学习第14天,@State装饰器:组件内状态。的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html


在HarmonyOS的ArkTS语言中,@State装饰器用于管理组件内部的状态。通过@State,你可以定义一个响应式变量,当该变量的值发生变化时,UI会自动更新以反映最新的状态。例如:

@State count: number = 0;

build() {
  Column() {
    Text(`Count: ${this.count}`)
    Button('Increment').onClick(() => {
      this.count++;
    })
  }
}

在这个例子中,count是一个状态变量,点击按钮时count会增加,并且UI会自动更新显示新的count值。@State适用于组件内部的状态管理,确保UI与状态保持同步。

回到顶部
AI 助手
你好,我是IT营的 AI 助手
您可以尝试点击下方的快捷入口开启体验!