@buaa_smat/hometrans 0.1.13 → 0.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +164 -112
- package/agents/build-fixer.md +384 -394
- package/agents/code-reviewer.md +240 -240
- package/agents/logic-coder.md +199 -199
- package/agents/logic-context-builder.md +194 -194
- package/agents/review-fixer.md +405 -405
- package/agents/self-test-fixer.md +296 -296
- package/agents/self-tester.md +393 -392
- package/agents/spec-generator.md +540 -540
- package/dist/cli/config-store.js +84 -8
- package/dist/cli/config.js +3 -3
- package/dist/cli/env-vars.js +129 -0
- package/dist/cli/init.js +272 -272
- package/dist/cli/uninstall.js +152 -17
- package/dist/context/index.js +10 -197
- package/env-requirements.json +3 -3
- package/package.json +1 -1
- package/resource/choose_editor.png +0 -0
- package/resource/common_config.png +0 -0
- package/resource/integration_test_config.png +0 -0
- package/resource/set_env.png +0 -0
- package/resource/ui_align_config.png +0 -0
- package/skills/hmos-batch-ui-align/SKILL.md +108 -98
- package/skills/hmos-batch-ui-align/references/conversion-procedure.md +180 -180
- package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-atomic-component-mapping-reference.md +2533 -2533
- package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-interaction-mapping-reference.md +555 -555
- package/skills/hmos-batch-ui-align/references/mappings/android-to-harmonyOS-ui-layout-mapping-reference.md +117 -117
- package/skills/hmos-batch-ui-align/references/mvvm/@Link/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/217/214/345/220/221/345/220/214/346/255/245.md +648 -648
- package/skills/hmos-batch-ui-align/references/mvvm/@Observed/350/243/205/351/245/260/345/231/250/345/222/214@ObjectLink/350/243/205/351/245/260/345/231/250/357/274/232/345/265/214/345/245/227/347/261/273/345/257/271/350/261/241/345/261/236/346/200/247/345/217/230/345/214/226.md +2088 -2088
- package/skills/hmos-batch-ui-align/references/mvvm/@Prop/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/215/225/345/220/221/345/220/214/346/255/245.md +1033 -1033
- package/skills/hmos-batch-ui-align/references/mvvm/@Provide/350/243/205/351/245/260/345/231/250/345/222/214@Consume/350/243/205/351/245/260/345/231/250/357/274/232/344/270/216/345/220/216/344/273/243/347/273/204/344/273/266/345/217/214/345/220/221/345/220/214/346/255/245.md +1183 -1183
- package/skills/hmos-batch-ui-align/references/mvvm/@State/350/243/205/351/245/260/345/231/250/357/274/232/347/273/204/344/273/266/345/206/205/347/212/266/346/200/201.md +576 -576
- package/skills/hmos-batch-ui-align/references/mvvm/@Track/350/243/205/351/245/260/345/231/250/357/274/232class/345/257/271/350/261/241/345/261/236/346/200/247/347/272/247/346/233/264/346/226/260.md +297 -297
- package/skills/hmos-batch-ui-align/references/mvvm/@Watch/350/243/205/351/245/260/345/231/250/357/274/232/347/212/266/346/200/201/345/217/230/351/207/217/346/233/264/346/224/271/351/200/232/347/237/245.md +395 -395
- package/skills/hmos-batch-ui-align/references/mvvm/AppStorage/357/274/232/345/272/224/347/224/250/345/205/250/345/261/200/347/232/204UI/347/212/266/346/200/201/345/255/230/345/202/250.md +902 -902
- package/skills/hmos-batch-ui-align/references/mvvm/Environment/357/274/232/350/256/276/345/244/207/347/216/257/345/242/203/346/237/245/350/257/242.md +106 -106
- package/skills/hmos-batch-ui-align/references/mvvm/LocalStorage/357/274/232/351/241/265/351/235/242/347/272/247UI/347/212/266/346/200/201/345/255/230/345/202/250.md +1178 -1178
- package/skills/hmos-batch-ui-align/references/mvvm/MVVM/346/250/241/345/274/217/357/274/210V1/357/274/211.md +911 -911
- package/skills/hmos-batch-ui-align/references/mvvm/PersistentStorage/357/274/232/346/214/201/344/271/205/345/214/226/345/255/230/345/202/250UI/347/212/266/346/200/201.md +354 -354
- package/skills/hmos-batch-ui-align/references/mvvm//347/256/241/347/220/206/345/272/224/347/224/250/346/213/245/346/234/211/347/232/204/347/212/266/346/200/201/346/246/202/350/277/260.md +11 -11
- package/skills/hmos-convert-pipeline/SKILL.md +429 -415
- package/skills/hmos-fix-build-errors/SKILL.md +272 -273
- package/skills/hmos-fix-build-errors/references/arkts-strict-patterns.md +219 -219
- package/skills/hmos-fix-build-errors/references/known-patterns.md +157 -157
- package/skills/hmos-fix-build-errors/references/rdb-entity-pattern.md +131 -131
- package/skills/hmos-incremental-ui-align/SKILL.md +219 -200
- package/skills/hmos-incremental-ui-align/diff_analysis.md +52 -52
- package/skills/hmos-incremental-ui-align/page_align.md +62 -62
- package/skills/hmos-incremental-ui-align/readme.md +237 -230
- package/skills/hmos-incremental-ui-align/references/Comparison_Template.md +2 -2
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Link/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/217/214/345/220/221/345/220/214/346/255/245.md +648 -648
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Observed/350/243/205/351/245/260/345/231/250/345/222/214@ObjectLink/350/243/205/351/245/260/345/231/250/357/274/232/345/265/214/345/245/227/347/261/273/345/257/271/350/261/241/345/261/236/346/200/247/345/217/230/345/214/226.md +2088 -2088
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Prop/350/243/205/351/245/260/345/231/250/357/274/232/347/210/266/345/255/220/345/215/225/345/220/221/345/220/214/346/255/245.md +1033 -1033
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Provide/350/243/205/351/245/260/345/231/250/345/222/214@Consume/350/243/205/351/245/260/345/231/250/357/274/232/344/270/216/345/220/216/344/273/243/347/273/204/344/273/266/345/217/214/345/220/221/345/220/214/346/255/245.md +1183 -1183
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@State/350/243/205/351/245/260/345/231/250/357/274/232/347/273/204/344/273/266/345/206/205/347/212/266/346/200/201.md +576 -576
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Track/350/243/205/351/245/260/345/231/250/357/274/232class/345/257/271/350/261/241/345/261/236/346/200/247/347/272/247/346/233/264/346/226/260.md +297 -297
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/@Watch/350/243/205/351/245/260/345/231/250/357/274/232/347/212/266/346/200/201/345/217/230/351/207/217/346/233/264/346/224/271/351/200/232/347/237/245.md +395 -395
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/AppStorage/357/274/232/345/272/224/347/224/250/345/205/250/345/261/200/347/232/204UI/347/212/266/346/200/201/345/255/230/345/202/250.md +902 -902
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/Environment/357/274/232/350/256/276/345/244/207/347/216/257/345/242/203/346/237/245/350/257/242.md +106 -106
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/LocalStorage/357/274/232/351/241/265/351/235/242/347/272/247UI/347/212/266/346/200/201/345/255/230/345/202/250.md +1178 -1178
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/MVVM/346/250/241/345/274/217V1.md +911 -911
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243/PersistentStorage/357/274/232/346/214/201/344/271/205/345/214/226/345/255/230/345/202/250UI/347/212/266/346/200/201.md +354 -354
- package/skills/hmos-incremental-ui-align/references/MVVM/345/274/200/345/217/221/346/226/207/346/241/243//347/256/241/347/220/206/345/272/224/347/224/250/346/213/245/346/234/211/347/232/204/347/212/266/346/200/201/346/246/202/350/277/260.md +11 -11
- package/skills/hmos-incremental-ui-align/references/UI_Analysis_Template.md +3 -3
- package/skills/hmos-incremental-ui-align/references/android-to-harmonyOS-ui-atomic-component-mapping-reference.md +2533 -2533
- package/skills/hmos-incremental-ui-align/references/android-to-harmonyOS-ui-interaction-mapping-reference.md +555 -555
- package/skills/hmos-incremental-ui-align/references/android-to-harmonyOS-ui-layout-mapping-reference.md +117 -117
- package/skills/hmos-incremental-ui-align/scripts/navigation-capure.md +37 -37
- package/skills/hmos-integration-test/SKILL.md +380 -369
- package/skills/hmos-integration-test/readme.md +309 -309
- package/skills/hmos-resources-convert/SKILL.md +623 -623
- package/skills/hmos-resources-convert/references/conversion-rules.md +663 -663
- package/skills/hmos-resources-convert/references/dependency-analysis-rules.md +388 -388
- package/skills/hmos-resources-convert/references/resource-mapping-rules.md +457 -457
- package/skills/hmos-resources-convert/references/xml-drawable-to-svg-rules.md +513 -513
- package/skills/hmos-spec-generate/SKILL.md +331 -331
- package/skills/hmos-spec-generate/references/android-platform-tokens.md +105 -105
- package/skills/hmos-spec-generate/references/spec-sample-1.md +78 -78
- package/skills/hmos-spec-generate/references/spec-sample-2.md +58 -58
- package/skills/hmos-spec-generate/references/spec-sample-3.md +116 -116
- package/skills/hmos-spec-generate/references/step4-report-template.md +33 -33
- package/tools/test-tools/autotest/README.md +33 -17
- package/tools/test-tools/autotest/self_test_runner.py +109 -15
- package/resource/hometrans_config.png +0 -0
- package/skills/hmos-incremental-ui-align/config-example.json +0 -11
- package/tools/test-tools/autotest/config.yaml.example +0 -58
|
@@ -1,395 +1,395 @@
|
|
|
1
|
-
# @Watch装饰器:状态变量更改通知
|
|
2
|
-
|
|
3
|
-
@Watch应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变,可以使用@Watch为状态变量设置回调函数。
|
|
4
|
-
|
|
5
|
-
@Watch提供了状态变量的监听能力,@Watch仅能监听到可以观察到的变化。
|
|
6
|
-
|
|
7
|
-
在阅读本文档前,建议开发者对状态管理基本观察能力有基本的了解。建议提前阅读:[@State](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-state)。
|
|
8
|
-
|
|
9
|
-
> **说明:**
|
|
10
|
-
>
|
|
11
|
-
> 从API version 9开始,该装饰器支持在ArkTS卡片中使用。
|
|
12
|
-
>
|
|
13
|
-
> 从API version 11开始,该装饰器支持在元服务中使用。
|
|
14
|
-
|
|
15
|
-
## 概述
|
|
16
|
-
|
|
17
|
-
@Watch用于监听状态变量的变化,当状态变量变化时,@Watch的回调方法将被调用。@Watch在ArkUI框架内部判断数值有无更新使用的是严格相等(===),遵循严格相等规范。当严格相等判断的结果是false(即不相等)的情况下,就会触发@Watch的回调。
|
|
18
|
-
|
|
19
|
-
## 装饰器说明
|
|
20
|
-
|
|
21
|
-
| @Watch补充变量装饰器 | 说明 |
|
|
22
|
-
| --- | --- |
|
|
23
|
-
| 装饰器参数 | 必填。常量字符串,字符串需要有引号。是(string) => void自定义成员函数的方法的引用。 |
|
|
24
|
-
| 可装饰的自定义组件变量 | 可监听所有装饰器装饰的状态变量。不允许监听常规变量。 |
|
|
25
|
-
| 装饰器的顺序 | 装饰器顺序不影响实际功能,开发者可以根据自己的需要决定装饰器顺序的先后。建议[@State](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-state)、[@Prop](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-prop)、[@Link](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-link)等装饰器在@Watch装饰器之前,以保持整体风格的一致。 |
|
|
26
|
-
| @Watch触发时机 | 使用@Watch来监听状态变量变化时,回调触发时间是变量真正变化、被赋值的时间。详细示例请参考使用场景中的[@Watch的触发时机](#watch的触发时机)。 |
|
|
27
|
-
|
|
28
|
-
## 语法说明
|
|
29
|
-
|
|
30
|
-
| 类型 | 说明 |
|
|
31
|
-
| --- | --- |
|
|
32
|
-
| (changedPropertyName? : string) => void | 该函数是自定义组件的成员函数,changedPropertyName是被watch的属性名。在多个状态变量绑定同一个@Watch的回调方法的时候,可以通过changedPropertyName进行不同的逻辑处理。将属性名作为字符串输入参数,不返回任何内容。 |
|
|
33
|
-
|
|
34
|
-
## 观察变化和行为表现
|
|
35
|
-
|
|
36
|
-
1. 当观察到状态变量的变化(包括双向绑定的[AppStorage](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-appstorage)和[LocalStorage](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-localstorage)中对应的key发生的变化)的时候,对应的@Watch的回调方法将被触发;
|
|
37
|
-
|
|
38
|
-
2. @Watch方法在自定义组件的属性变更之后同步执行;
|
|
39
|
-
|
|
40
|
-
3. 如果在@Watch的方法里改变了其他的状态变量,也会引起状态变更和@Watch的执行;
|
|
41
|
-
|
|
42
|
-
4. 在第一次初始化的时候,@Watch装饰的方法不会被调用,即认为初始化不是状态变量的改变。只有在后续状态改变时,才会调用@Watch回调方法。
|
|
43
|
-
|
|
44
|
-
## 限制条件
|
|
45
|
-
|
|
46
|
-
- 建议开发者避免无限循环。循环可能是因为在@Watch的回调方法里直接或者间接地修改了同一个状态变量引起的。为了避免循环的产生,建议不要在@Watch的回调方法里修改当前装饰的状态变量;
|
|
47
|
-
|
|
48
|
-
- 开发者应关注性能,属性值更新函数会延迟组件的重新渲染(具体请见上面的行为表现),因此,回调函数应仅执行快速运算;
|
|
49
|
-
|
|
50
|
-
- 不建议在@Watch函数中调用async await,因为@Watch设计的用途是为了快速的计算,异步行为可能会导致重新渲染速度的性能问题。
|
|
51
|
-
|
|
52
|
-
- @Watch参数为必选,且参数类型必须是string,否则编译期会报错。不建议开发者传入undefined,传入后编译不会报错,相当于传入"undefined"。
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
// 错误写法,编译报错
|
|
56
|
-
@State @Watch() num: number = 10;
|
|
57
|
-
@State @Watch(change) num: number = 10;
|
|
58
|
-
|
|
59
|
-
// 正确写法
|
|
60
|
-
@State @Watch('change') num: number = 10;
|
|
61
|
-
change() {
|
|
62
|
-
console.info(`xxx`);
|
|
63
|
-
}
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
- @Watch内的参数必须是声明的方法名,否则编译期会报错。
|
|
67
|
-
|
|
68
|
-
```ts
|
|
69
|
-
// 错误写法,没有对应名称的函数,编译报错
|
|
70
|
-
@State @Watch('change') num: number = 10;
|
|
71
|
-
onChange() {
|
|
72
|
-
console.info(`xxx`);
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
// 正确写法
|
|
76
|
-
@State @Watch('change') num: number = 10;
|
|
77
|
-
change() {
|
|
78
|
-
console.info(`xxx`);
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
- 常规变量不能被@Watch装饰,否则编译期会报错。
|
|
83
|
-
|
|
84
|
-
```ts
|
|
85
|
-
// 错误写法
|
|
86
|
-
@Watch('change') num: number = 10;
|
|
87
|
-
change() {
|
|
88
|
-
console.info(`xxx`);
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
// 正确写法
|
|
92
|
-
@State @Watch('change') num: number = 10;
|
|
93
|
-
change() {
|
|
94
|
-
console.info(`xxx`);
|
|
95
|
-
}
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
## 使用场景
|
|
99
|
-
|
|
100
|
-
### @Watch和自定义组件更新
|
|
101
|
-
|
|
102
|
-
以下示例展示组件更新和@Watch的处理步骤。count在CountModifier中由@State装饰,在TotalView中由@Prop装饰。
|
|
103
|
-
|
|
104
|
-
```TypeScript
|
|
105
|
-
@Component
|
|
106
|
-
struct TotalView {
|
|
107
|
-
@Prop @Watch('onCountUpdated') count: number = 0;
|
|
108
|
-
@State total: number = 0;
|
|
109
|
-
|
|
110
|
-
// @Watch 回调
|
|
111
|
-
onCountUpdated(propName: string): void {
|
|
112
|
-
this.total += this.count;
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
build() {
|
|
116
|
-
Text(`Total: ${this.total}`)
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
@Entry
|
|
121
|
-
@Component
|
|
122
|
-
struct CountModifier {
|
|
123
|
-
@State count: number = 0;
|
|
124
|
-
|
|
125
|
-
build() {
|
|
126
|
-
Column() {
|
|
127
|
-
Button('add to basket')
|
|
128
|
-
.onClick(() => {
|
|
129
|
-
this.count++;
|
|
130
|
-
})
|
|
131
|
-
TotalView({ count: this.count })
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
处理步骤:
|
|
138
|
-
|
|
139
|
-
1. CountModifier自定义组件的Button.onClick点击事件自增count。
|
|
140
|
-
|
|
141
|
-
2. 由于@State count变量更改,子组件TotalView中的@Prop被更新,其@Watch('onCountUpdated')方法被调用,更新了子组件TotalView 中的total变量。
|
|
142
|
-
|
|
143
|
-
3. 子组件TotalView中的Text重新渲染。
|
|
144
|
-
|
|
145
|
-
### @Watch与@Link组合使用
|
|
146
|
-
|
|
147
|
-
以下示例说明了如何在子组件中观察@Link变量。
|
|
148
|
-
|
|
149
|
-
```TypeScript
|
|
150
|
-
class PurchaseItem {
|
|
151
|
-
public static nextId: number = 0;
|
|
152
|
-
public id: number;
|
|
153
|
-
public price: number;
|
|
154
|
-
|
|
155
|
-
constructor(price: number) {
|
|
156
|
-
this.id = PurchaseItem.nextId++;
|
|
157
|
-
this.price = price;
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
@Component
|
|
162
|
-
struct BasketViewer {
|
|
163
|
-
@Link @Watch('onBasketUpdated') shopBasket: PurchaseItem[];
|
|
164
|
-
@State totalPurchase: number = 0;
|
|
165
|
-
|
|
166
|
-
updateTotal(): number {
|
|
167
|
-
let total = this.shopBasket.reduce((sum, i) => sum + i.price, 0);
|
|
168
|
-
// 超过100欧元可享受折扣
|
|
169
|
-
if (total >= 100) {
|
|
170
|
-
total = 0.9 * total;
|
|
171
|
-
}
|
|
172
|
-
return total;
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
// @Watch 回调
|
|
176
|
-
onBasketUpdated(propName: string): void {
|
|
177
|
-
this.totalPurchase = this.updateTotal();
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
build() {
|
|
181
|
-
Column() {
|
|
182
|
-
ForEach(this.shopBasket,
|
|
183
|
-
(item: PurchaseItem) => {
|
|
184
|
-
Text(`Price: ${item.price.toFixed(2)} €`)
|
|
185
|
-
},
|
|
186
|
-
(item: PurchaseItem) => item.id.toString()
|
|
187
|
-
)
|
|
188
|
-
Text(`Total: ${this.totalPurchase.toFixed(2)} €`)
|
|
189
|
-
}
|
|
190
|
-
}
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
@Entry
|
|
194
|
-
@Component
|
|
195
|
-
struct BasketModifier {
|
|
196
|
-
@State shopBasket: PurchaseItem[] = [];
|
|
197
|
-
|
|
198
|
-
build() {
|
|
199
|
-
Column() {
|
|
200
|
-
Button('Add to basket')
|
|
201
|
-
.onClick(() => {
|
|
202
|
-
this.shopBasket.push(new PurchaseItem(Math.round(100 * Math.random())));
|
|
203
|
-
})
|
|
204
|
-
BasketViewer({ shopBasket: $shopBasket })
|
|
205
|
-
}
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
处理步骤如下:
|
|
211
|
-
|
|
212
|
-
1. BasketModifier组件的Button.onClick向BasketModifier shopBasket中添加条目;
|
|
213
|
-
|
|
214
|
-
2. @Link装饰的BasketViewer shopBasket值发生变化;
|
|
215
|
-
|
|
216
|
-
3. 状态管理框架调用@Watch函数BasketViewer onBasketUpdated 更新BasketViewer TotalPurchase的值;
|
|
217
|
-
|
|
218
|
-
4. @Link shopBasket的改变,新增了数组项,ForEach组件会执行item Builder,渲染构建新的Item项;@State totalPurchase改变,对应的Text组件也重新渲染;重新渲染是异步发生的。
|
|
219
|
-
|
|
220
|
-
效果图如下:
|
|
221
|
-
|
|
222
|
-

|
|
223
|
-
|
|
224
|
-
### @Watch的触发时机
|
|
225
|
-
|
|
226
|
-
为了展示@Watch回调触发时间是根据状态变量真正变化的时间,本示例在子组件中同时使用@Link和[@ObjectLink](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-observed-and-objectlink)装饰器,分别观察不同的状态对象。通过在父组件中更改状态变量并观察@Watch回调的先后顺序,来表明@Watch触发的时机与赋值、同步的关系。
|
|
227
|
-
|
|
228
|
-
```TypeScript
|
|
229
|
-
import { hilog } from '@kit.PerformanceAnalysisKit';
|
|
230
|
-
import { common } from '@kit.AbilityKit';
|
|
231
|
-
|
|
232
|
-
@Observed
|
|
233
|
-
class Task {
|
|
234
|
-
public isFinished: boolean = false;
|
|
235
|
-
|
|
236
|
-
constructor(isFinished: boolean) {
|
|
237
|
-
this.isFinished = isFinished;
|
|
238
|
-
}
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
const DOMAIN = 0x0000;
|
|
242
|
-
|
|
243
|
-
@Entry
|
|
244
|
-
@Component
|
|
245
|
-
struct ParentComponent {
|
|
246
|
-
@State @Watch('onTaskAChanged') taskA: Task = new Task(false);
|
|
247
|
-
@State @Watch('onTaskBChanged') taskB: Task = new Task(false);
|
|
248
|
-
private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
|
|
249
|
-
// 请将$r('app.string.watch_text5')替换为实际资源文件,在本示例中该资源文件的value值为"父组件任务A状态:"
|
|
250
|
-
@State type1: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text5').id);
|
|
251
|
-
// 请将$r('app.string.watch_text6')替换为实际资源文件,在本示例中该资源文件的value值为"父组件任务B状态:"
|
|
252
|
-
@State type2: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text6').id);
|
|
253
|
-
|
|
254
|
-
onTaskAChanged(changedPropertyName: string): void {
|
|
255
|
-
// 请将$r('app.string.watch_text12')替换为实际资源文件,在本示例中该资源文件的value值为"观测到父组件任务属性变化:"
|
|
256
|
-
hilog.info(DOMAIN, this.getUIContext()
|
|
257
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text12').id), changedPropertyName);
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
onTaskBChanged(changedPropertyName: string): void {
|
|
261
|
-
// 请将$r('app.string.watch_text12')替换为实际资源文件,在本示例中该资源文件的value值为"观测到父组件任务属性变化:"
|
|
262
|
-
hilog.info(DOMAIN, this.getUIContext()
|
|
263
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text12').id), changedPropertyName);
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
build() {
|
|
267
|
-
Column() {
|
|
268
|
-
// 请将$r('app.string.watch_text7')替换为实际资源文件,在本示例中该资源文件的value值为"已完成"
|
|
269
|
-
// 请将$r('app.string.watch_text8')替换为实际资源文件,在本示例中该资源文件的value值为"未完成"
|
|
270
|
-
Text(`${this.type1} ${this.taskA.isFinished ? this.getUIContext()
|
|
271
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
272
|
-
this.getUIContext()
|
|
273
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
274
|
-
Text(`${this.type2} ${this.taskB.isFinished ? this.getUIContext()
|
|
275
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
276
|
-
this.getUIContext()
|
|
277
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
278
|
-
ChildComponent({ taskA: this.taskA, taskB: this.taskB })
|
|
279
|
-
// 请将$r('app.string.watch_text9')替换为实际资源文件,在本示例中该资源文件的value值为"切换任务状态"
|
|
280
|
-
Button(this.getUIContext()
|
|
281
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text9').id))
|
|
282
|
-
.onClick(() => {
|
|
283
|
-
this.taskB = new Task(!this.taskB.isFinished);
|
|
284
|
-
this.taskA = new Task(!this.taskA.isFinished);
|
|
285
|
-
})
|
|
286
|
-
}
|
|
287
|
-
}
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
@Component
|
|
291
|
-
struct ChildComponent {
|
|
292
|
-
@ObjectLink @Watch('onObjectLinkTaskChanged') taskB: Task;
|
|
293
|
-
@Link @Watch('onLinkTaskChanged') taskA: Task;
|
|
294
|
-
private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
|
|
295
|
-
// 请将$r('app.string.watch_text10')替换为实际资源文件,在本示例中该资源文件的value值为"子组件任务A状态:"
|
|
296
|
-
@State type1: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text10').id);
|
|
297
|
-
// 请将$r('app.string.watch_text11')替换为实际资源文件,在本示例中该资源文件的value值为"子组件任务B状态:"
|
|
298
|
-
@State type2: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text11').id);
|
|
299
|
-
|
|
300
|
-
onObjectLinkTaskChanged(changedPropertyName: string): void {
|
|
301
|
-
// 请将$r('app.string.watch_text13')替换为实际资源文件,在本示例中该资源文件的value值为"观测到子组件@ObjectLink关联的任务属性变化:"
|
|
302
|
-
hilog.info(DOMAIN, this.getUIContext()
|
|
303
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text13').id), changedPropertyName);
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
onLinkTaskChanged(changedPropertyName: string): void {
|
|
307
|
-
// 请将$r('app.string.watch_text14')替换为实际资源文件,在本示例中该资源文件的value值为"观测到子组件@Link关联的任务属性变化:"
|
|
308
|
-
hilog.info(DOMAIN, this.getUIContext()
|
|
309
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text14').id), changedPropertyName);
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
build() {
|
|
313
|
-
Column() {
|
|
314
|
-
// 请将$r('app.string.watch_text7')替换为实际资源文件,在本示例中该资源文件的value值为"已完成"
|
|
315
|
-
// 请将$r('app.string.watch_text8')替换为实际资源文件,在本示例中该资源文件的value值为"未完成"
|
|
316
|
-
Text(`${this.type1} ${this.taskA.isFinished ? this.getUIContext()
|
|
317
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
318
|
-
this.getUIContext()
|
|
319
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
320
|
-
Text(`${this.type2} ${this.taskB.isFinished ? this.getUIContext()
|
|
321
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
322
|
-
this.getUIContext()
|
|
323
|
-
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
324
|
-
}
|
|
325
|
-
}
|
|
326
|
-
}
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
处理步骤如下:
|
|
330
|
-
|
|
331
|
-
1. 当点击按钮切换任务状态时,父组件首先更新了被@ObjectLink关联的taskB,然后更新了被@Link关联的taskA。
|
|
332
|
-
|
|
333
|
-
2. 观察到日志依次显示:
|
|
334
|
-
|
|
335
|
-
```text
|
|
336
|
-
观测到父组件任务属性变化: taskB
|
|
337
|
-
观测到父组件任务属性变化: taskA
|
|
338
|
-
观测到子组件@Link关联的任务属性变化: taskA
|
|
339
|
-
观测到子组件@ObjectLink关联的任务属性变化: taskB
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
3. 通过日志可以看到,父组件的回调顺序和修改顺序一致,而子组件中@Link和@ObjectLink的回调触发顺序与父组件中变量更新的顺序不同。这是因为父组件的变量更新是即时的,但子组件中@Link和@ObjectLink获取更新数据的时机不同。@Link的状态更新是同步的,状态变化会立刻触发@Watch回调。而@ObjectLink的更新依赖于父组件的同步,当父组件刷新并将更新后的变量传递给子组件时,@Watch回调才会触发,因此触发顺序略晚于@Link。
|
|
343
|
-
|
|
344
|
-
4. 这是符合预期的行为,展示了@Watch回调的触发时机是根据状态变量真正变化的时间。因为@Link直接同步,而@ObjectLink需要等父组件更新子组件变量。类似地,@Prop也可能表现出与@ObjectLink类似的行为,其回调触发时间也会略晚。
|
|
345
|
-
|
|
346
|
-
### 使用changedPropertyName进行不同的逻辑处理
|
|
347
|
-
|
|
348
|
-
以下示例说明了如何在@Watch函数中使用changedPropertyName进行不同的逻辑处理。
|
|
349
|
-
|
|
350
|
-
```TypeScript
|
|
351
|
-
@Entry
|
|
352
|
-
@Component
|
|
353
|
-
struct UsePropertyName {
|
|
354
|
-
@State @Watch('countUpdated') apple: number = 0;
|
|
355
|
-
@State @Watch('countUpdated') cabbage: number = 0;
|
|
356
|
-
@State fruit: number = 0;
|
|
357
|
-
|
|
358
|
-
// @Watch 回调
|
|
359
|
-
countUpdated(propName: string): void {
|
|
360
|
-
if (propName === 'apple') {
|
|
361
|
-
this.fruit = this.apple;
|
|
362
|
-
}
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
build() {
|
|
366
|
-
Column() {
|
|
367
|
-
Text(`Number of apples: ${this.apple.toString()}`).fontSize(30)
|
|
368
|
-
Text(`Number of cabbages: ${this.cabbage.toString()}`).fontSize(30)
|
|
369
|
-
Text(`Total number of fruits: ${this.fruit.toString()}`).fontSize(30)
|
|
370
|
-
Button('Add apples')
|
|
371
|
-
.onClick(() => {
|
|
372
|
-
this.apple++;
|
|
373
|
-
})
|
|
374
|
-
Button('Add cabbages')
|
|
375
|
-
.onClick(() => {
|
|
376
|
-
this.cabbage++;
|
|
377
|
-
})
|
|
378
|
-
}
|
|
379
|
-
}
|
|
380
|
-
}
|
|
381
|
-
```
|
|
382
|
-
|
|
383
|
-
处理步骤如下:
|
|
384
|
-
|
|
385
|
-
1. 点击Button('Add apples')时,apple的值发生变化。
|
|
386
|
-
|
|
387
|
-
2. 状态管理框架调用@Watch函数countUpdated,发生变化的状态变量名为apple,满足if逻辑条件,fruit的值被改变。
|
|
388
|
-
|
|
389
|
-
3. 绑定了apple,fruit状态变量的Text重新渲染。
|
|
390
|
-
|
|
391
|
-
4. 点击Button('Add cabbages')时,cabbage的值发生变化。
|
|
392
|
-
|
|
393
|
-
5. 状态管理框架调用@Watch函数countUpdated,发生变化的状态变量名为cabbage,不满足if逻辑条件,fruit的值不发生变化。
|
|
394
|
-
|
|
395
|
-
6. 绑定了cabbage状态变量的Text重新渲染。
|
|
1
|
+
# @Watch装饰器:状态变量更改通知
|
|
2
|
+
|
|
3
|
+
@Watch应用于对状态变量的监听。如果开发者需要关注某个状态变量的值是否改变,可以使用@Watch为状态变量设置回调函数。
|
|
4
|
+
|
|
5
|
+
@Watch提供了状态变量的监听能力,@Watch仅能监听到可以观察到的变化。
|
|
6
|
+
|
|
7
|
+
在阅读本文档前,建议开发者对状态管理基本观察能力有基本的了解。建议提前阅读:[@State](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-state)。
|
|
8
|
+
|
|
9
|
+
> **说明:**
|
|
10
|
+
>
|
|
11
|
+
> 从API version 9开始,该装饰器支持在ArkTS卡片中使用。
|
|
12
|
+
>
|
|
13
|
+
> 从API version 11开始,该装饰器支持在元服务中使用。
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
@Watch用于监听状态变量的变化,当状态变量变化时,@Watch的回调方法将被调用。@Watch在ArkUI框架内部判断数值有无更新使用的是严格相等(===),遵循严格相等规范。当严格相等判断的结果是false(即不相等)的情况下,就会触发@Watch的回调。
|
|
18
|
+
|
|
19
|
+
## 装饰器说明
|
|
20
|
+
|
|
21
|
+
| @Watch补充变量装饰器 | 说明 |
|
|
22
|
+
| --- | --- |
|
|
23
|
+
| 装饰器参数 | 必填。常量字符串,字符串需要有引号。是(string) => void自定义成员函数的方法的引用。 |
|
|
24
|
+
| 可装饰的自定义组件变量 | 可监听所有装饰器装饰的状态变量。不允许监听常规变量。 |
|
|
25
|
+
| 装饰器的顺序 | 装饰器顺序不影响实际功能,开发者可以根据自己的需要决定装饰器顺序的先后。建议[@State](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-state)、[@Prop](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-prop)、[@Link](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-link)等装饰器在@Watch装饰器之前,以保持整体风格的一致。 |
|
|
26
|
+
| @Watch触发时机 | 使用@Watch来监听状态变量变化时,回调触发时间是变量真正变化、被赋值的时间。详细示例请参考使用场景中的[@Watch的触发时机](#watch的触发时机)。 |
|
|
27
|
+
|
|
28
|
+
## 语法说明
|
|
29
|
+
|
|
30
|
+
| 类型 | 说明 |
|
|
31
|
+
| --- | --- |
|
|
32
|
+
| (changedPropertyName? : string) => void | 该函数是自定义组件的成员函数,changedPropertyName是被watch的属性名。在多个状态变量绑定同一个@Watch的回调方法的时候,可以通过changedPropertyName进行不同的逻辑处理。将属性名作为字符串输入参数,不返回任何内容。 |
|
|
33
|
+
|
|
34
|
+
## 观察变化和行为表现
|
|
35
|
+
|
|
36
|
+
1. 当观察到状态变量的变化(包括双向绑定的[AppStorage](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-appstorage)和[LocalStorage](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-localstorage)中对应的key发生的变化)的时候,对应的@Watch的回调方法将被触发;
|
|
37
|
+
|
|
38
|
+
2. @Watch方法在自定义组件的属性变更之后同步执行;
|
|
39
|
+
|
|
40
|
+
3. 如果在@Watch的方法里改变了其他的状态变量,也会引起状态变更和@Watch的执行;
|
|
41
|
+
|
|
42
|
+
4. 在第一次初始化的时候,@Watch装饰的方法不会被调用,即认为初始化不是状态变量的改变。只有在后续状态改变时,才会调用@Watch回调方法。
|
|
43
|
+
|
|
44
|
+
## 限制条件
|
|
45
|
+
|
|
46
|
+
- 建议开发者避免无限循环。循环可能是因为在@Watch的回调方法里直接或者间接地修改了同一个状态变量引起的。为了避免循环的产生,建议不要在@Watch的回调方法里修改当前装饰的状态变量;
|
|
47
|
+
|
|
48
|
+
- 开发者应关注性能,属性值更新函数会延迟组件的重新渲染(具体请见上面的行为表现),因此,回调函数应仅执行快速运算;
|
|
49
|
+
|
|
50
|
+
- 不建议在@Watch函数中调用async await,因为@Watch设计的用途是为了快速的计算,异步行为可能会导致重新渲染速度的性能问题。
|
|
51
|
+
|
|
52
|
+
- @Watch参数为必选,且参数类型必须是string,否则编译期会报错。不建议开发者传入undefined,传入后编译不会报错,相当于传入"undefined"。
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
// 错误写法,编译报错
|
|
56
|
+
@State @Watch() num: number = 10;
|
|
57
|
+
@State @Watch(change) num: number = 10;
|
|
58
|
+
|
|
59
|
+
// 正确写法
|
|
60
|
+
@State @Watch('change') num: number = 10;
|
|
61
|
+
change() {
|
|
62
|
+
console.info(`xxx`);
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
- @Watch内的参数必须是声明的方法名,否则编译期会报错。
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
// 错误写法,没有对应名称的函数,编译报错
|
|
70
|
+
@State @Watch('change') num: number = 10;
|
|
71
|
+
onChange() {
|
|
72
|
+
console.info(`xxx`);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
// 正确写法
|
|
76
|
+
@State @Watch('change') num: number = 10;
|
|
77
|
+
change() {
|
|
78
|
+
console.info(`xxx`);
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
- 常规变量不能被@Watch装饰,否则编译期会报错。
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
// 错误写法
|
|
86
|
+
@Watch('change') num: number = 10;
|
|
87
|
+
change() {
|
|
88
|
+
console.info(`xxx`);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// 正确写法
|
|
92
|
+
@State @Watch('change') num: number = 10;
|
|
93
|
+
change() {
|
|
94
|
+
console.info(`xxx`);
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## 使用场景
|
|
99
|
+
|
|
100
|
+
### @Watch和自定义组件更新
|
|
101
|
+
|
|
102
|
+
以下示例展示组件更新和@Watch的处理步骤。count在CountModifier中由@State装饰,在TotalView中由@Prop装饰。
|
|
103
|
+
|
|
104
|
+
```TypeScript
|
|
105
|
+
@Component
|
|
106
|
+
struct TotalView {
|
|
107
|
+
@Prop @Watch('onCountUpdated') count: number = 0;
|
|
108
|
+
@State total: number = 0;
|
|
109
|
+
|
|
110
|
+
// @Watch 回调
|
|
111
|
+
onCountUpdated(propName: string): void {
|
|
112
|
+
this.total += this.count;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
build() {
|
|
116
|
+
Text(`Total: ${this.total}`)
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
@Entry
|
|
121
|
+
@Component
|
|
122
|
+
struct CountModifier {
|
|
123
|
+
@State count: number = 0;
|
|
124
|
+
|
|
125
|
+
build() {
|
|
126
|
+
Column() {
|
|
127
|
+
Button('add to basket')
|
|
128
|
+
.onClick(() => {
|
|
129
|
+
this.count++;
|
|
130
|
+
})
|
|
131
|
+
TotalView({ count: this.count })
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
处理步骤:
|
|
138
|
+
|
|
139
|
+
1. CountModifier自定义组件的Button.onClick点击事件自增count。
|
|
140
|
+
|
|
141
|
+
2. 由于@State count变量更改,子组件TotalView中的@Prop被更新,其@Watch('onCountUpdated')方法被调用,更新了子组件TotalView 中的total变量。
|
|
142
|
+
|
|
143
|
+
3. 子组件TotalView中的Text重新渲染。
|
|
144
|
+
|
|
145
|
+
### @Watch与@Link组合使用
|
|
146
|
+
|
|
147
|
+
以下示例说明了如何在子组件中观察@Link变量。
|
|
148
|
+
|
|
149
|
+
```TypeScript
|
|
150
|
+
class PurchaseItem {
|
|
151
|
+
public static nextId: number = 0;
|
|
152
|
+
public id: number;
|
|
153
|
+
public price: number;
|
|
154
|
+
|
|
155
|
+
constructor(price: number) {
|
|
156
|
+
this.id = PurchaseItem.nextId++;
|
|
157
|
+
this.price = price;
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
@Component
|
|
162
|
+
struct BasketViewer {
|
|
163
|
+
@Link @Watch('onBasketUpdated') shopBasket: PurchaseItem[];
|
|
164
|
+
@State totalPurchase: number = 0;
|
|
165
|
+
|
|
166
|
+
updateTotal(): number {
|
|
167
|
+
let total = this.shopBasket.reduce((sum, i) => sum + i.price, 0);
|
|
168
|
+
// 超过100欧元可享受折扣
|
|
169
|
+
if (total >= 100) {
|
|
170
|
+
total = 0.9 * total;
|
|
171
|
+
}
|
|
172
|
+
return total;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
// @Watch 回调
|
|
176
|
+
onBasketUpdated(propName: string): void {
|
|
177
|
+
this.totalPurchase = this.updateTotal();
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
build() {
|
|
181
|
+
Column() {
|
|
182
|
+
ForEach(this.shopBasket,
|
|
183
|
+
(item: PurchaseItem) => {
|
|
184
|
+
Text(`Price: ${item.price.toFixed(2)} €`)
|
|
185
|
+
},
|
|
186
|
+
(item: PurchaseItem) => item.id.toString()
|
|
187
|
+
)
|
|
188
|
+
Text(`Total: ${this.totalPurchase.toFixed(2)} €`)
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
@Entry
|
|
194
|
+
@Component
|
|
195
|
+
struct BasketModifier {
|
|
196
|
+
@State shopBasket: PurchaseItem[] = [];
|
|
197
|
+
|
|
198
|
+
build() {
|
|
199
|
+
Column() {
|
|
200
|
+
Button('Add to basket')
|
|
201
|
+
.onClick(() => {
|
|
202
|
+
this.shopBasket.push(new PurchaseItem(Math.round(100 * Math.random())));
|
|
203
|
+
})
|
|
204
|
+
BasketViewer({ shopBasket: $shopBasket })
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
处理步骤如下:
|
|
211
|
+
|
|
212
|
+
1. BasketModifier组件的Button.onClick向BasketModifier shopBasket中添加条目;
|
|
213
|
+
|
|
214
|
+
2. @Link装饰的BasketViewer shopBasket值发生变化;
|
|
215
|
+
|
|
216
|
+
3. 状态管理框架调用@Watch函数BasketViewer onBasketUpdated 更新BasketViewer TotalPurchase的值;
|
|
217
|
+
|
|
218
|
+
4. @Link shopBasket的改变,新增了数组项,ForEach组件会执行item Builder,渲染构建新的Item项;@State totalPurchase改变,对应的Text组件也重新渲染;重新渲染是异步发生的。
|
|
219
|
+
|
|
220
|
+
效果图如下:
|
|
221
|
+
|
|
222
|
+

|
|
223
|
+
|
|
224
|
+
### @Watch的触发时机
|
|
225
|
+
|
|
226
|
+
为了展示@Watch回调触发时间是根据状态变量真正变化的时间,本示例在子组件中同时使用@Link和[@ObjectLink](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-observed-and-objectlink)装饰器,分别观察不同的状态对象。通过在父组件中更改状态变量并观察@Watch回调的先后顺序,来表明@Watch触发的时机与赋值、同步的关系。
|
|
227
|
+
|
|
228
|
+
```TypeScript
|
|
229
|
+
import { hilog } from '@kit.PerformanceAnalysisKit';
|
|
230
|
+
import { common } from '@kit.AbilityKit';
|
|
231
|
+
|
|
232
|
+
@Observed
|
|
233
|
+
class Task {
|
|
234
|
+
public isFinished: boolean = false;
|
|
235
|
+
|
|
236
|
+
constructor(isFinished: boolean) {
|
|
237
|
+
this.isFinished = isFinished;
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
const DOMAIN = 0x0000;
|
|
242
|
+
|
|
243
|
+
@Entry
|
|
244
|
+
@Component
|
|
245
|
+
struct ParentComponent {
|
|
246
|
+
@State @Watch('onTaskAChanged') taskA: Task = new Task(false);
|
|
247
|
+
@State @Watch('onTaskBChanged') taskB: Task = new Task(false);
|
|
248
|
+
private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
|
|
249
|
+
// 请将$r('app.string.watch_text5')替换为实际资源文件,在本示例中该资源文件的value值为"父组件任务A状态:"
|
|
250
|
+
@State type1: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text5').id);
|
|
251
|
+
// 请将$r('app.string.watch_text6')替换为实际资源文件,在本示例中该资源文件的value值为"父组件任务B状态:"
|
|
252
|
+
@State type2: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text6').id);
|
|
253
|
+
|
|
254
|
+
onTaskAChanged(changedPropertyName: string): void {
|
|
255
|
+
// 请将$r('app.string.watch_text12')替换为实际资源文件,在本示例中该资源文件的value值为"观测到父组件任务属性变化:"
|
|
256
|
+
hilog.info(DOMAIN, this.getUIContext()
|
|
257
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text12').id), changedPropertyName);
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
onTaskBChanged(changedPropertyName: string): void {
|
|
261
|
+
// 请将$r('app.string.watch_text12')替换为实际资源文件,在本示例中该资源文件的value值为"观测到父组件任务属性变化:"
|
|
262
|
+
hilog.info(DOMAIN, this.getUIContext()
|
|
263
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text12').id), changedPropertyName);
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
build() {
|
|
267
|
+
Column() {
|
|
268
|
+
// 请将$r('app.string.watch_text7')替换为实际资源文件,在本示例中该资源文件的value值为"已完成"
|
|
269
|
+
// 请将$r('app.string.watch_text8')替换为实际资源文件,在本示例中该资源文件的value值为"未完成"
|
|
270
|
+
Text(`${this.type1} ${this.taskA.isFinished ? this.getUIContext()
|
|
271
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
272
|
+
this.getUIContext()
|
|
273
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
274
|
+
Text(`${this.type2} ${this.taskB.isFinished ? this.getUIContext()
|
|
275
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
276
|
+
this.getUIContext()
|
|
277
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
278
|
+
ChildComponent({ taskA: this.taskA, taskB: this.taskB })
|
|
279
|
+
// 请将$r('app.string.watch_text9')替换为实际资源文件,在本示例中该资源文件的value值为"切换任务状态"
|
|
280
|
+
Button(this.getUIContext()
|
|
281
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text9').id))
|
|
282
|
+
.onClick(() => {
|
|
283
|
+
this.taskB = new Task(!this.taskB.isFinished);
|
|
284
|
+
this.taskA = new Task(!this.taskA.isFinished);
|
|
285
|
+
})
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
@Component
|
|
291
|
+
struct ChildComponent {
|
|
292
|
+
@ObjectLink @Watch('onObjectLinkTaskChanged') taskB: Task;
|
|
293
|
+
@Link @Watch('onLinkTaskChanged') taskA: Task;
|
|
294
|
+
private context = this.getUIContext().getHostContext() as common.UIAbilityContext;
|
|
295
|
+
// 请将$r('app.string.watch_text10')替换为实际资源文件,在本示例中该资源文件的value值为"子组件任务A状态:"
|
|
296
|
+
@State type1: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text10').id);
|
|
297
|
+
// 请将$r('app.string.watch_text11')替换为实际资源文件,在本示例中该资源文件的value值为"子组件任务B状态:"
|
|
298
|
+
@State type2: string = this.context!.resourceManager.getStringSync($r('app.string.watch_text11').id);
|
|
299
|
+
|
|
300
|
+
onObjectLinkTaskChanged(changedPropertyName: string): void {
|
|
301
|
+
// 请将$r('app.string.watch_text13')替换为实际资源文件,在本示例中该资源文件的value值为"观测到子组件@ObjectLink关联的任务属性变化:"
|
|
302
|
+
hilog.info(DOMAIN, this.getUIContext()
|
|
303
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text13').id), changedPropertyName);
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
onLinkTaskChanged(changedPropertyName: string): void {
|
|
307
|
+
// 请将$r('app.string.watch_text14')替换为实际资源文件,在本示例中该资源文件的value值为"观测到子组件@Link关联的任务属性变化:"
|
|
308
|
+
hilog.info(DOMAIN, this.getUIContext()
|
|
309
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text14').id), changedPropertyName);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
build() {
|
|
313
|
+
Column() {
|
|
314
|
+
// 请将$r('app.string.watch_text7')替换为实际资源文件,在本示例中该资源文件的value值为"已完成"
|
|
315
|
+
// 请将$r('app.string.watch_text8')替换为实际资源文件,在本示例中该资源文件的value值为"未完成"
|
|
316
|
+
Text(`${this.type1} ${this.taskA.isFinished ? this.getUIContext()
|
|
317
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
318
|
+
this.getUIContext()
|
|
319
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
320
|
+
Text(`${this.type2} ${this.taskB.isFinished ? this.getUIContext()
|
|
321
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text7').id) :
|
|
322
|
+
this.getUIContext()
|
|
323
|
+
.getHostContext()!.resourceManager.getStringSync($r('app.string.watch_text8').id)}`)
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
处理步骤如下:
|
|
330
|
+
|
|
331
|
+
1. 当点击按钮切换任务状态时,父组件首先更新了被@ObjectLink关联的taskB,然后更新了被@Link关联的taskA。
|
|
332
|
+
|
|
333
|
+
2. 观察到日志依次显示:
|
|
334
|
+
|
|
335
|
+
```text
|
|
336
|
+
观测到父组件任务属性变化: taskB
|
|
337
|
+
观测到父组件任务属性变化: taskA
|
|
338
|
+
观测到子组件@Link关联的任务属性变化: taskA
|
|
339
|
+
观测到子组件@ObjectLink关联的任务属性变化: taskB
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
3. 通过日志可以看到,父组件的回调顺序和修改顺序一致,而子组件中@Link和@ObjectLink的回调触发顺序与父组件中变量更新的顺序不同。这是因为父组件的变量更新是即时的,但子组件中@Link和@ObjectLink获取更新数据的时机不同。@Link的状态更新是同步的,状态变化会立刻触发@Watch回调。而@ObjectLink的更新依赖于父组件的同步,当父组件刷新并将更新后的变量传递给子组件时,@Watch回调才会触发,因此触发顺序略晚于@Link。
|
|
343
|
+
|
|
344
|
+
4. 这是符合预期的行为,展示了@Watch回调的触发时机是根据状态变量真正变化的时间。因为@Link直接同步,而@ObjectLink需要等父组件更新子组件变量。类似地,@Prop也可能表现出与@ObjectLink类似的行为,其回调触发时间也会略晚。
|
|
345
|
+
|
|
346
|
+
### 使用changedPropertyName进行不同的逻辑处理
|
|
347
|
+
|
|
348
|
+
以下示例说明了如何在@Watch函数中使用changedPropertyName进行不同的逻辑处理。
|
|
349
|
+
|
|
350
|
+
```TypeScript
|
|
351
|
+
@Entry
|
|
352
|
+
@Component
|
|
353
|
+
struct UsePropertyName {
|
|
354
|
+
@State @Watch('countUpdated') apple: number = 0;
|
|
355
|
+
@State @Watch('countUpdated') cabbage: number = 0;
|
|
356
|
+
@State fruit: number = 0;
|
|
357
|
+
|
|
358
|
+
// @Watch 回调
|
|
359
|
+
countUpdated(propName: string): void {
|
|
360
|
+
if (propName === 'apple') {
|
|
361
|
+
this.fruit = this.apple;
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
build() {
|
|
366
|
+
Column() {
|
|
367
|
+
Text(`Number of apples: ${this.apple.toString()}`).fontSize(30)
|
|
368
|
+
Text(`Number of cabbages: ${this.cabbage.toString()}`).fontSize(30)
|
|
369
|
+
Text(`Total number of fruits: ${this.fruit.toString()}`).fontSize(30)
|
|
370
|
+
Button('Add apples')
|
|
371
|
+
.onClick(() => {
|
|
372
|
+
this.apple++;
|
|
373
|
+
})
|
|
374
|
+
Button('Add cabbages')
|
|
375
|
+
.onClick(() => {
|
|
376
|
+
this.cabbage++;
|
|
377
|
+
})
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
}
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
处理步骤如下:
|
|
384
|
+
|
|
385
|
+
1. 点击Button('Add apples')时,apple的值发生变化。
|
|
386
|
+
|
|
387
|
+
2. 状态管理框架调用@Watch函数countUpdated,发生变化的状态变量名为apple,满足if逻辑条件,fruit的值被改变。
|
|
388
|
+
|
|
389
|
+
3. 绑定了apple,fruit状态变量的Text重新渲染。
|
|
390
|
+
|
|
391
|
+
4. 点击Button('Add cabbages')时,cabbage的值发生变化。
|
|
392
|
+
|
|
393
|
+
5. 状态管理框架调用@Watch函数countUpdated,发生变化的状态变量名为cabbage,不满足if逻辑条件,fruit的值不发生变化。
|
|
394
|
+
|
|
395
|
+
6. 绑定了cabbage状态变量的Text重新渲染。
|