1# \@Watch：状态变量更改通知 2 3 4\@Watch应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变，可以使用\@Watch为状态变量设置回调函数。 5 6 7> **说明：** 8> 9> 从API version 9开始，该装饰器支持在ArkTS卡片中使用。 10 11 12## 概述 13 14\@Watch用于监听状态变量的变化，当状态变量变化时，\@Watch的回调方法将被调用。\@Watch在ArkUI框架内部判断数值有无更新使用的是严格相等（===），遵循严格相等规范。当在严格相等为false的情况下，就会触发\@Watch的回调。 15 16 17## 装饰器说明 18 19| \@Watch补充变量装饰器 | 说明 | 20| -------------- | ---------------------------------------- | 21| 装饰器参数 | 必填。常量字符串，字符串需要有引号。是(string) => void自定义成员函数的方法的引用。 | 22| 可装饰的自定义组件变量 | 可监听所有装饰器装饰的状态变量。不允许监听常规变量。 | 23| 装饰器的顺序 | 建议\@State、\@Prop、\@Link等装饰器在\@Watch装饰器之前。 | 24 25 26## 语法说明 27 28| 类型 | 说明 | 29| ---------------------------------------- | ---------------------------------------- | 30| (changedPropertyName? : string) => void | 该函数是自定义组件的成员函数，changedPropertyName是被watch的属性名。<br/>在多个状态变量绑定同一个\@Watch的回调方法的时候，可以通过changedPropertyName进行不同的逻辑处理<br/>将属性名作为字符串输入参数，不返回任何内容。 | 31 32 33## 观察变化和行为表现 34 351. 当观察到状态变量的变化（包括双向绑定的AppStorage和LocalStorage中对应的key发生的变化）的时候，对应的\@Watch的回调方法将被触发； 36 372. \@Watch方法在自定义组件的属性变更之后同步执行； 38 393. 如果在\@Watch的方法里改变了其他的状态变量，也会引起的状态变更和\@Watch的执行； 40 414. 在第一次初始化的时候，\@Watch装饰的方法不会被调用，即认为初始化不是状态变量的改变。只有在后续状态改变时，才会调用\@Watch回调方法。 42 43 44## 限制条件 45 46- 建议开发者避免无限循环。循环可能是因为在\@Watch的回调方法里直接或者间接地修改了同一个状态变量引起的。为了避免循环的产生，建议不要在\@Watch的回调方法里修改当前装饰的状态变量； 47 48- 开发者应关注性能，属性值更新函数会延迟组件的重新渲染（具体请见上面的行为表现），因此，回调函数应仅执行快速运算； 49 50- 不建议在\@Watch函数中调用async await，因为\@Watch设计的用途是为了快速的计算，异步行为可能会导致重新渲染速度的性能问题。 51 52 53## 使用场景 54 55 56### \@Watch与\@Link组合使用 57 58以下示例说明了如何在子组件中观察\@Link变量。 59 60 61```ts 62class PurchaseItem { 63 static NextId: number = 0; 64 public id: number; 65 public price: number; 66 67 constructor(price: number) { 68 this.id = PurchaseItem.NextId++; 69 this.price = price; 70 } 71} 72 73@Component 74struct BasketViewer { 75 @Link @Watch('onBasketUpdated') shopBasket: PurchaseItem[]; 76 @State totalPurchase: number = 0; 77 78 updateTotal(): number { 79 let total = this.shopBasket.reduce((sum, i) => sum + i.price, 0); 80 // 超过100欧元可享受折扣 81 if (total >= 100) { 82 total = 0.9 * total; 83 } 84 return total; 85 } 86 // @Watch 回调 87 onBasketUpdated(propName: string): void { 88 this.totalPurchase = this.updateTotal(); 89 } 90 91 build() { 92 Column() { 93 ForEach(this.shopBasket, 94 (item) => { 95 Text(`Price: ${item.price.toFixed(2)} €`) 96 }, 97 item => item.id.toString() 98 ) 99 Text(`Total: ${this.totalPurchase.toFixed(2)} €`) 100 } 101 } 102} 103 104@Entry 105@Component 106struct BasketModifier { 107 @State shopBasket: PurchaseItem[] = []; 108 109 build() { 110 Column() { 111 Button('Add to basket') 112 .onClick(() => { 113 this.shopBasket.push(new PurchaseItem(Math.round(100 * Math.random()))) 114 }) 115 BasketViewer({ shopBasket: $shopBasket }) 116 } 117 } 118} 119``` 120 121处理步骤如下： 122 1231. BasketModifier组件的Button.onClick向BasketModifier shopBasket中添加条目； 124 1252. \@Link装饰的BasketViewer shopBasket值发生变化； 126 1273. 状态管理框架调用\@Watch函数BasketViewer onBasketUpdated 更新BaketViewer TotalPurchase的值； 128 1294. \@Link shopBasket的改变，新增了数组项，ForEach组件会执行item Builder，渲染构建新的Item项；\@State totalPurchase改变，对应的Text组件也重新渲染；重新渲染是异步发生的。 130 131 132### \@Watch和自定义组件更新 133 134以下示例展示组件更新和\@Watch的处理步骤。count在两个组件中均由\@State装饰。 135 136 137```ts 138@Component 139struct TotalView { 140 @Prop @Watch('onCountUpdated') count: number; 141 @State total: number = 0; 142 // @Watch cb 143 onCountUpdated(propName: string): void { 144 this.total += this.count; 145 } 146 147 build() { 148 Text(`Total: ${this.total}`) 149 } 150} 151 152@Entry 153@Component 154struct CountModifier { 155 @State count: number = 0; 156 157 build() { 158 Column() { 159 Button('add to basket') 160 .onClick(() => { 161 this.count++ 162 }) 163 TotalView({ count: this.count }) 164 } 165 } 166} 167``` 168 169处理步骤： 170 1711. CountModifier自定义组件的Button.onClick点击事件自增count。 172 1732. 由于\@State count变量更改，子组件TotalView中的\@Prop被更新，其\@Watch('onCountUpdated')方法被调用，更新了子组件TotalView 中的total变量。 174 1753. 子组件TotalView中的Text重新渲染。 176