codecamp

@Watch装饰器:状态变量更改通知

@Watch应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变,可以使用@Watch为状态变量设置回调函数。

说明

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

概述

@Watch用于监听状态变量的变化,当状态变量变化时,@Watch的回调方法将被调用。@Watch在ArkUI框架内部判断数值有无更新使用的是严格相等(===),遵循严格相等规范。当在严格相等为false的情况下,就会触发@Watch的回调。

装饰器说明

@Watch补充变量装饰器

说明

装饰器参数

必填。常量字符串,字符串需要有引号。是(string) => void自定义成员函数的方法的引用。

可装饰的自定义组件变量

可监听所有装饰器装饰的状态变量。不允许监听常规变量。

装饰器的顺序

建议@State、@Prop、@Link等装饰器在@Watch装饰器之前。

语法说明

类型

说明

(changedPropertyName? : string) => void

该函数是自定义组件的成员函数,changedPropertyName是被watch的属性名。

在多个状态变量绑定同一个@Watch的回调方法的时候,可以通过changedPropertyName进行不同的逻辑处理

将属性名作为字符串输入参数,不返回任何内容。

观察变化和行为表现

  1. 当观察到状态变量的变化(包括双向绑定的AppStorage和LocalStorage中对应的key发生的变化)的时候,对应的@Watch的回调方法将被触发;
  2. @Watch方法在自定义组件的属性变更之后同步执行;
  3. 如果在@Watch的方法里改变了其他的状态变量,也会引起状态变更和@Watch的执行;
  4. 在第一次初始化的时候,@Watch装饰的方法不会被调用,即认为初始化不是状态变量的改变。只有在后续状态改变时,才会调用@Watch回调方法。

限制条件

  • 建议开发者避免无限循环。循环可能是因为在@Watch的回调方法里直接或者间接地修改了同一个状态变量引起的。为了避免循环的产生,建议不要在@Watch的回调方法里修改当前装饰的状态变量;
  • 开发者应关注性能,属性值更新函数会延迟组件的重新渲染(具体请见上面的行为表现),因此,回调函数应仅执行快速运算;
  • 不建议在@Watch函数中调用async await,因为@Watch设计的用途是为了快速的计算,异步行为可能会导致重新渲染速度的性能问题。

使用场景

@Watch和自定义组件更新

以下示例展示组件更新和@Watch的处理步骤。count在CountModifier中由@State装饰,在TotalView中由@Prop装饰。

  1. @Component
  2. struct TotalView {
  3. @Prop @Watch('onCountUpdated') count: number;
  4. @State total: number = 0;
  5. // @Watch 回调
  6. onCountUpdated(propName: string): void {
  7. this.total += this.count;
  8. }
  9. build() {
  10. Text(`Total: ${this.total}`)
  11. }
  12. }
  13. @Entry
  14. @Component
  15. struct CountModifier {
  16. @State count: number = 0;
  17. build() {
  18. Column() {
  19. Button('add to basket')
  20. .onClick(() => {
  21. this.count++
  22. })
  23. TotalView({ count: this.count })
  24. }
  25. }
  26. }

处理步骤:

  1. CountModifier自定义组件的Button.onClick点击事件自增count。
  2. 由于@State count变量更改,子组件TotalView中的@Prop被更新,其@Watch('onCountUpdated')方法被调用,更新了子组件TotalView 中的total变量。
  3. 子组件TotalView中的Text重新渲染。

@Watch与@Link组合使用

以下示例说明了如何在子组件中观察@Link变量。

  1. class PurchaseItem {
  2. static NextId: number = 0;
  3. public id: number;
  4. public price: number;
  5. constructor(price: number) {
  6. this.id = PurchaseItem.NextId++;
  7. this.price = price;
  8. }
  9. }
  10. @Component
  11. struct BasketViewer {
  12. @Link @Watch('onBasketUpdated') shopBasket: PurchaseItem[];
  13. @State totalPurchase: number = 0;
  14. updateTotal(): number {
  15. let total = this.shopBasket.reduce((sum, i) => sum + i.price, 0);
  16. // 超过100欧元可享受折扣
  17. if (total >= 100) {
  18. total = 0.9 * total;
  19. }
  20. return total;
  21. }
  22. // @Watch 回调
  23. onBasketUpdated(propName: string): void {
  24. this.totalPurchase = this.updateTotal();
  25. }
  26. build() {
  27. Column() {
  28. ForEach(this.shopBasket,
  29. (item) => {
  30. Text(`Price: ${item.price.toFixed(2)} €`)
  31. },
  32. item => item.id.toString()
  33. )
  34. Text(`Total: ${this.totalPurchase.toFixed(2)} €`)
  35. }
  36. }
  37. }
  38. @Entry
  39. @Component
  40. struct BasketModifier {
  41. @State shopBasket: PurchaseItem[] = [];
  42. build() {
  43. Column() {
  44. Button('Add to basket')
  45. .onClick(() => {
  46. this.shopBasket.push(new PurchaseItem(Math.round(100 * Math.random())))
  47. })
  48. BasketViewer({ shopBasket: $shopBasket })
  49. }
  50. }
  51. }

处理步骤如下:

  1. BasketModifier组件的Button.onClick向BasketModifier shopBasket中添加条目;
  2. @Link装饰的BasketViewer shopBasket值发生变化;
  3. 状态管理框架调用@Watch函数BasketViewer onBasketUpdated 更新BasketViewer TotalPurchase的值;
  4. @Link shopBasket的改变,新增了数组项,ForEach组件会执行item Builder,渲染构建新的Item项;@State totalPurchase改变,对应的Text组件也重新渲染;重新渲染是异步发生的。
Environment:设备环境查询
$$语法:内置组件双向同步
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录
HAR

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }