ArkTs的@Watch状态监听

简介: @Watch是ArkUI框架中用于监听状态变量变化的核心工具,类似Vue的Watch机制。状态更新时,方法触发,通过`changedPropertyName`区分多个绑定变量。需与@State、@Prop、@Link等装饰器配合使用,顺序上须置于这些装饰器之后。实际开发中,@Watch常与@Link(跨组件双向同步)或@Provide(跨代组件同步)结合使用。例如,通过@Link接收父组件变量并监听变化,动态调整子组件状态;或利用@Provide定义全局变量,监听后更新整体进度状态。这种机制提升了组件间状态管理的灵活性与解耦性,助力开发者高效构建复杂应用,实现“一次开发,多端部署”的目标。

@Watch装饰器:监听并捕捉变量变化


@Watch用于监听状态变量的变化,当状态变量变化时,@Watch的回调方法将被调用。@Watch在ArkUI框架内部判断数值有无更新使用的是严格相等(===),监听并捕捉变量变化。
前端同学以Vue中的Watch监听为嵌入点更好理解。

装饰器说明

  • 装饰器参数: 自定义回调引用,用引号字符串的方法名称,这里类似Vue中的Watch对象中自定义方法;
  • 可装饰的自定义组件变量:可监听所有装饰器装饰的状态变量。不允许监听常规变量。
  • 装饰器的顺序: 把@State、@Prop、@Link等装饰器在@Watch装饰器之前。

    语法说明

@Watch (changedPropertyName? : string) => void
  • changedPropertyName: 自定义函数成员,是watch的属性名;
  • 在多个状态变量绑定同一个@Watch的回调方法的时候,可以通过changedPropertyName进行不同的逻辑处理

变化和行为、限制条件

变化和行为 限制条件
当观察到状态变量的变化的时候,对应的@Watch的回调方法将被触发; 建议不要在@Watch的回调方法里修改当前装饰的状态变量和循环
@Watch方法在自定义组件的属性变更之后同步执行 应关注性能,属性值更新函数会延迟组件的重新渲染,因此,回调函数应仅执行快速运算
在第一次初始化的时候,@Watch装饰的方法不会被调用,只有在后续状态改变时才会调用 不建议在@Watch函数中调用async await 等异步,影响性能

@Watch 深度探索:与@Link、 @Povide配合使用


@Watch在项目开发中使用频率非常高,只要是想对一个变量变化监听,然后紧接着要处理其他业务就需要用到它。下面以示例codeLabs到'工作目标'案例为例:

@Link 和 @Watch配合使用

请添加图片描述

// TargetList.ets
@Component
export default struct TargetList {
   
  ...
  @State clickIndex: number = -1;
  ...
  onAddClick?: () => void;

  build() {
   
    Column() {
   
      ...
      List({
    space: CommonConstants.LIST_SPACE }) {
   
        ForEach(this.targetData, (item: TaskItemBean, index: number | undefined) => {
   
          ListItem() {
   
            TargetListItem({
   
              taskItem: item,
              index: index,
              selectArr: $selectArray,
              isEditMode: this.isEditMode,
              clickIndex: $clickIndex
            })
          }
        }, (item: TaskItemBean) => JSON.stringify(item))
      }
      ...
    }
    ...
  }
}

// TargetListItem.ets
@Component
export default struct TargetListItem {
   
  ...
  @Link @Watch('onClickIndexChanged') clickIndex: number;
  @State isExpanded: boolean = false;
  @Consume overAllProgressChanged: boolean;
  @State sliderMode: number = CommonConstants.DEFAULT_SLIDER_MODE;
  public index: number = 0;

  ...
  /**
   * Listening click index.
   */
  onClickIndexChanged() {
   
    if (this.clickIndex !== this.index) {
   
      this.isExpanded = false;
    }
  }

  build() {
   
    Stack({
    alignContent: Alignment.Start }) {
   
      Column() {
   
        this.TargetItem()
        ...
        }
      }
      ...
      .onClick(() => {
   
        ...
        if (!this.isEditMode) {
   
          ...
          this.clickIndex = this.index;
        }
      })
      ...
    }
    .width(CommonConstants.FULL_WIDTH)
  }

  ...
}
  • 本codelab中,使用@Link装饰器从父组件TargetList.ets中接收到(@Link是跨代组件同行,可以去HarmonyOS基础(四)- HarmonyOS ArkTs 组件状态查看详细说明)的双向同步的变量clickIndex,并使用@Watch监听当前变量。
  • onClickIndexChanged是我们自定义函数。当监听当点击子目标时,就改变isExpanded的状态,这样起到展开/收起目标子组件动态变化
  • 然后子组件就根据当前clickIndex和列表下标比对,如何是与当前下标相同,不做处理,如果不是就咱开。

@Provide和@Watch 配合使用

[video(video-j1ych5oc-1707379671885)(type-csdn)(url-https://live.csdn.net/v/embed/363377)(image-https://video-community.csdnimg.cn/vod-84deb4/c081b734c65771eebfc75107e0c90102/snapshots/30ac3b013e614616acee7f99e6fb8966-00001.jpg?auth_key=4860978840-0-0-cd408bf2baf8502e95ab217e3631d573)(title-)]

@Entry
@Component
struct MainPage {
   
  @State targetData: Array<TaskItemBean> = DataModel.getData();
  @State totalTasksNumber: number = 0;
  @State completedTasksNumber: number = 0;
  @State latestUpdateDate: string = CommonConstants.DEFAULT_PROGRESS_VALUE;
  @Provide @Watch('onProgressChanged') overAllProgressChanged: boolean = false;
  dialogController: CustomDialogController = new CustomDialogController({
   
    ...
  });

  /**
   * Listening targetData.
   */
  onProgressChanged() {
   
    this.totalTasksNumber = this.targetData.length;
    this.completedTasksNumber = this.targetData.filter((item: TaskItemBean) => {
   
      return item.progressValue === CommonConstants.SLIDER_MAX_VALUE;
    }).length;
    this.latestUpdateDate = getCurrentTime();
  }

  build() {
   
    Column() {
   
      ...
      TargetInformation({
   
        latestUpdateDate: this.latestUpdateDate,
        totalTasksNumber: this.totalTasksNumber,
        completedTasksNumber: this.completedTasksNumber
      })
      ...
    }
    .width(CommonConstants.FULL_WIDTH)
    .height(CommonConstants.FULL_HEIGHT)
    .backgroundColor($r('app.color.index_background'))
  }
  • 本codelab中,使用@Provide装饰器定义变量(@Provide是跨代组件同步,可以在HarmonyOS基础(四)- HarmonyOS ArkTs 组件状态查看详细说明)overAllProgressChanged,并使用@Watch监听当前变量。
  • onProgressChanged是我们自定义函数,子目标进度完成并确认后。触发当前自定义函数,并赋值给变量。
  • 然后更新我们TargetInformation组件的整体进度状态。

参考:

ArkUI指南
ArkTS-API文档
HarmonyOS基础认证课程
HarmonyOS高级认证课程

​​

总结:

@Watch 装饰器和@State、@Prop、@Link是 ArkTS 框架中最基本也是最关键状态管理修饰符,通过它们的灵活运用,能够更好地处理组件之间状态的变化和同步。实际应用中,建议开发者灵活选择使用针对不同场景,并结合codeLabs和项目,以提高应用的性能和可维护性。 ArkTS 的状态管理机制为开发者提供了丰富的选择,对构建复杂应用变得更加简便与高效。

ArkTs的@Watch等状态修饰符为开发这提供组件变量管理的灵活性和控制性,对初步掌握HarmonyOS开发提供了可以精确监听状态变量的能力。在实际项目组件中极大提升代码的低耦合高内聚的能力和可维护性、高效力能力。实际开发中,也能发挥ArkTS的优势,构建强大的一次开发,多段部署的物联网应用。

相关文章
|
小程序 开发者
微信小程序通过普通二维码扫码进入指定页面带参数
微信小程序通过普通二维码扫码进入指定页面带参数
|
开发者 UED
ArkTS响应式刷新问题高级用法
本文详细介绍了ArkTS中响应式刷新的高级用法,涵盖Refresh组件的使用、状态管理、条件渲染及精准控制组件刷新。通过实例讲解了Refresh组件的触发条件、事件处理、常用属性,以及如何利用@State、@Link和@Watch装饰器优化状态管理和组件刷新,帮助开发者构建高效、可维护的HarmonyOS应用。
984 0
|
10月前
|
编解码 缓存 开发工具
HarmonyOS NEXT实战:字符串工具
本课程讲解如何在HarmonyOS Next中使用ArkTS语言封装字符串工具类,实现字符串空值判断、编码转换、Base64编解码等功能,帮助开发者高效处理字符串操作。
311 1
|
API 开发者 UED
鸿蒙next版开发:ArkTS组件通用属性(焦点控制)
在HarmonyOS 5.0中,ArkTS提供了完善的焦点控制属性,如focusable、defaultFocus、onFocus和onBlur,帮助开发者管理和响应用户界面中的焦点变化。本文详细介绍这些属性,并通过示例代码展示如何使用FocusController类进行焦点管理,提升应用的交互性和无障碍支持。
1150 1
|
数据处理
鸿蒙开发:ArkTs字符串string
字符串类型是开发中非常重要的一个数据类型,除了上述的方法概述之外,还有String对象,正则等其他的用处,我们放到以后得篇章中讲述。
876 19
|
API 开发者
HarmonyOS:ArkTS Path 组件自学指南
在鸿蒙应用开发中,绘制复杂图形常面临传统布局方式难以满足需求的问题。ArkTS 的 Path 组件提供了解决方案,如同一把“神奇画笔”,支持通过灵活的命令和属性绘制直线、曲线、椭圆弧等多样图形。本文详细介绍了 Path 组件从 API Version 7 起的功能特性,包括 `commands`、`fill`、`stroke` 等核心属性,以及各类绘图命令如 `M`(移动)、`L`(直线)、`C`(贝塞尔曲线)等。结合示例代码,展示了如何绘制简单直线到复杂曲线图形,并拓展了颜色、透明度和线条样式的自定义方法。掌握 Path 组件,可为应用带来更丰富生动的视觉体验,助力开发者实现创意绘图需求。
451 21
|
缓存 NoSQL Linux
Linux调试
本文介绍了Linux调试、性能分析和追踪的培训资料,涵盖调试、性能分析和追踪的基础知识及常用工具。
1268 63
Linux调试
|
UED 开发者 容器
鸿蒙next版开发:ArkTS组件通用属性(位置设置)
在HarmonyOS next中,ArkTS提供了align、direction、position、markAnchor、offset和alignRules等通用属性,用于精确控制组件在用户界面中的位置和布局。本文详细解读了这些属性,并提供了示例代码进行说明。通过这些属性,开发者可以实现精确布局、动态界面调整和提升用户体验。
1946 6
|
开发工具 开发者 容器
【HarmonyOS NEXT开发——ArkTS语言】欢迎界面(启动加载页)的实现【合集】
从ArkTS代码架构层面而言,@Entry指明入口、@Component助力复用、@Preview便于预览,只是初窥门径,为开发流程带来些许便利。尤其动画回调与Blank组件,细节粗糙,后续定当潜心钻研,力求精进。”,字体颜色为白色,字体大小等设置与之前类似,不过动画配置有所不同,时长为。,不过这里没有看到额外的动画效果添加到这个特定的图片元素上(与前面带动画的元素对比而言)。这是一个显示文本的视图,文本内容为“奇怪的知识”,设置了字体颜色为灰色(的结构体,它代表了整个界面组件的逻辑和视图结构。
460 1
|
编解码
四、ArkTS 常用组件-图片(Image)
ArkTS 常用组件-图片(Image)简介:Image 组件用于在应用中显示图片,支持本地和网络图片的加载,提供了多种参数类型如 string、Resource 和 media.PixelMap。常用属性包括图片尺寸设置(width()、height())、图片缩放模式(objectFit())及图片插值(interpolation()),确保图片在不同场景下的最佳显示效果。此外,Image 组件还支持图片资源的灵活引用方式,如通过 $r() 函数引用 resources 目录下的图片资源。
1324 2

热门文章

最新文章