目录

@Monitor使用限制及常见问题介绍

问题现象

背景知识

@Monitor:作为状态管理V2版本的装饰器,用于增强状态管理框架对状态变量变化的监听能力,当监听的对象是V2装饰器装饰的状态变量时,状态变量的改变可以触发@Monitor装饰的函数执行。该装饰器存在一些官方的使用限制,详见官网:概述、限制条件以及常见问题场景。

解决方案

针对问题现象中的场景,解决方案一览表格如下:

场景

场景描述

解决方案

场景一

状态管理V1迁移V2时,@Monitor代替@Watch导致动画失效。

使用applySync/flushUpdates/flushUIUpdates接口解决@Monitor导致动画失效的问题。

场景二

没有被@Trace修饰属性也会一起被@Monitor监听。

不要用一个@Monitor同时监听没有被@Trace修饰的属性和被@Trace修饰的属性。为避免出现意料之外的情况@Monitor不建议监听普通变量。

场景三

在onReady中初始化的值会在@Monitor之后被篡改,怎么做到不被篡改?

设置一个变量判断是否是初始化状态,onReady初始化触发@Monitor函数时,执行return,跳过后续@Monitor函数中修改参数的部分。

常见FAQ

Q:@Monitor装饰器如何监听AppStorage变化?

A:@Monitor装饰器用于监听被状态管理V2装饰器@Local、@Param、@Provider、@Consumer或@Computed装饰的状态变量。由于AppStorage为状态管理V1的全局储存“中枢”,不能被状态管理V2装饰器装饰,所以@Monitor装饰器不能监听AppStorage变化。

Q:@Monitor监听状态变量,变量初始化时不会触发吗?

A:初始化时不生效。当@Monitor定义在@ComponentV2装饰的自定义组件中时,@Monitor会在状态变量初始化完成之后生效,并在组件销毁时失效。详见常见问题:自定义组件中@Monitor对变量监听的生效及失效时间。

Q:@Monitor监听数组不生效?

A:当@Monitor监听整个数组时,更改数组的某一项不会被监听到。同时无法监听内置类型(Array、Map、Date、Set)的API调用引起的变化。详见官方文档:通用监听能力。

Q:通过@Monitor无法监听类属性的变化?

A:请检查是否出现以下情况导致监听失效:

  1. 检查类是否被@ObservedV2/@Trace装饰,没有被@Trace装饰的属性无法被@Monitor监听。
  2. 检查被@ObservedV2/@Trace装饰的类是否通过new操作符创建,没有被new操作符创建的实例无法被@Monitor监听。

Q:@Monitor无法监听class中static修饰的变量吗?

A:@Monitor无法监听class中static修饰的变量,建议使用单例模式或者使用emitter.on等方式代替。