目录

如何深度观测反序列化和未被@Observed/@ObservedV2装饰的对象

问题现象

场景一:JSON字符串使用JSON.parse转换为对象,该对象为嵌套类型的对象,直接修改该对象的属性时,无法刷新页面。

场景二:被@Sendable装饰器装饰的多线程共享数据等未被@Observed/@ObservedV2装饰器装饰的嵌套对象,无法刷新页面。

场景三:collections类型数据无法刷新页面。

背景知识

状态管理V2版本可以用UIUtils.makeObserved,状态管理V1版本API19以后可以用UIUtils.makeV1Observed实现对未被@Observed/@ObservedV2装饰的对象、系统返回的对象、interface等数据的深度监听。适用情况可参考官网makeObserved概述:

  1. class的定义在三方包中:开发者无法手动对class中需要观察的属性加上@Trace标签,可以使用makeObserved使得当前对象可以被观察。
  2. 当前类的成员属性不能被修改:因为@Trace观察类属性会动态修改类的属性,这个行为在@Sendable装饰的class中是不被允许的,此时可以使用makeObserved(@Sendable装饰的类型不支持makeV1Observed)。
  3. interface或者JSON.parse返回的匿名对象:这类场景往往没有明确的class声明,开发者无法使用@Trace标记当前属性可以被观察,此时可以使用makeObserved。

相较于UIUtils.makeObserved的限制条件,UIUtils.makeV1Observed限制条件可参考官网链接:makeV1Observed概述与限制条件。

解决方案

场景

问题现象

解决方案

场景一

JSON字符串使用JSON.parse转换为对象,该对象为嵌套类型的对象,直接修改该对象的属性时,无法刷新页面。

  1. 方案一:参考makeObserved的入参为JSON.parse的返回值,可以将未使用new创建的对象转化为可深度观测的对象。
  2. 方案二:状态管理V1可以使用makeV1Observed方法代替@Observed装饰器,该方案下即使不是通过new创建的也可以进行深度观测。

场景二

被@Sendable装饰器装饰的多线程共享数据等未被@Observed/@ObservedV2装饰器装饰的嵌套对象,无法刷新页面。

  1. 方案一:参考makeObserved和@Sendable装饰的class配合使用,可以实现在子线程做大数据处理,在UI线程做ViewModel的显示和观察数据的需求。
  2. 方案二:将@Sendable数据与深度观测的数据分开管理。

场景三

collections类型数据无法刷新页面。

详情可参考官方文档:makeObserved和collections.Array/Set/Map配合使用。

[h2]场景一

JSON字符串使用JSON.parse转换为对象,该对象为嵌套类型的对象,直接修改该对象的属性时,无法刷新页面。

[h2]场景二

被@Sendable装饰器装饰的多线程共享数据无法被@Observed/@ObservedV2装饰器装饰,无法刷新页面。

[h2]场景三

详情可参考官方文档:makeObserved和collections.Array/Set/Map配合使用。

常见FAQ

Q:场景一中是否还有其它方案能避免JSON.parse转换的对象无法深度观测的问题?

A:可以使用三方库class-transformer-arkts进行转换。

Q:UIUtils.makeObserved将对象变为可观察数据后,可观察多深层的数据改动?

A:UIUtils.makeObserved能递归代理所有层级的属性变化,确保任何深度的数据修改(如:objA.b.c.d=newValue)都能被检测并驱动UI更新。

总结

根据以上背景知识与常见场景,makeObserved与makeV1Observed的使用限制与对比如下:

场景

makeObserved

makeV1Observed

状态管理版本

状态管理V2

状态管理V1

观测深度

自动递归代理所有层级的属性变化。

代理一层的属性变化,若需要代理所有深度需要手动递归。需要搭配@ObjectLink一起使用。

支持的数据类型

JSON.parse返回的Object、Array、Map、Set、Date、collections.Array、collections.Set、collections.Map、@Sendable装饰的类、未被@Observed或@ObservedV2装饰的类等。

普通的class、Array、Map、Set、Date等。

不支持的数据类型

undefined、null和非Object类型。

collections类型、@Sendable装饰的class、非object类型、undefined、null以及被@ObservedV2、makeObserved的返回值和V2装饰器装饰的built-in类型的变量(Array、Map、Set和Date)。

根据以上的使用限制,makeV1Observed相较于makeObserved存在较大的局限性,同时由于转换后的数据是不同的状态管理版本,使用时需要注意状态管理版本之间的混用规则等问题。