目录

接收网络数据时,如何解决无法刷新@LocalBuilder装饰的组件的问题

问题现象

已采用@ObservedV2/@Trace修饰嵌套类和UIUtils.makeObserved对接收的数据转化为可深度观测的状态变量的情况下,目前this.person在aboutToAppear中的修改,以及后续onClick中的修改中,无法触发LocalBuilder中UI刷新。什么原因导致的无法刷新,且应该如何实现LocalBuilder中UI刷新?

代码示例如下:

import { UIUtils } from '@kit.ArkUI'

@Entry
@ComponentV2
export struct Index {
  @Local person: Person = new Person()

  aboutToAppear(): void {
    // 模拟发送接口请求数据
    setTimeout(() => {
      this.person = UIUtils.makeObserved(
        {
          mine: {
            size: '大',
            color: '蓝色'
          }
        })
    }, 1000)
  }

  @LocalBuilder
  myBuilder(item: Bag) {
    Column() {
      Text(item.size)
      Text(item.color)
    }
  }

  build() {
    Column() {
      this.myBuilder(this.person.mine)
      Button('change')
        .onClick(() => {
          let num = Math.random() * 100
          this.person.mine.color = `红${num}`
        })
    }
    .width('100%')
    .height('100%')
    .justifyContent(FlexAlign.Center)
  }
}

@ObservedV2
class Bag {
  @Trace size: string = '初始size小'
  @Trace color: string = '初始color红色';
}

class Person {
  mine: Bag = new Bag()
}

截图如下,渲染结果值依然为初始值,没有变化,点击change也没有变化。

背景知识

问题定位

网络数据接收UI不刷新一般可参考以下方案排查:

  1. 是否使用@Observed/@ObservedV2装饰要监听的类。由问题代码可知,需要监听的是Bag类中属性对应的UI刷新,已经使用@ObservedV2装饰器装饰Bag类,并用@Trace装饰器装饰需要监听的属性。该项排查内容无问题。
  2. 使用的是状态管理V2下的@ObservedV2装饰器的情况下是否满足其使用的限制条件,详见概述、使用限制等。由问题代码可知,代码中接收数据时,并没有通过new操作符重新构造,而是通过字面量直接赋值。但是,由于使用了makeObserved方法将字面量转换为了可深度观测的状态变量。该项排查内容无问题。

接收网络返回的数据时,返回的是一整个类的序列化字符串。通过JSON.parse()进行反序列化后整体赋值给this.person,或类似字面量方式整体赋值给this.person时,由于该方式没有通过new操作符创建为状态变量,所以修改后无法刷新UI。需要用makeObserved等方法转换为可深度观测的状态变量。

  1. 代码中存在@LocalBuilder装饰的自定义构建函数,需要判断是否是值传递导致的UI不刷新。

    从问题代码中可以看到,@LocalBuilder自定义构建函数内传递的参数是Bag类型,实际调用时是直接传递的Bag类:this.person.mine。使用的是引用传递的方式,所以当this.person修改时,没有触发UI刷新。该项排查内容存在问题。

  2. 未使用ForEach等渲染组件,所以不是键值问题导致的UI不刷新。ForEach键值渲染不刷新问题,详见官方文档:ForEach:循环渲染。该项排查内容无问题。

分析结论

问题代码中,@LocalBuilder自定义构建函数使用了值传递的方式,导致了UI不刷新。

修改建议

总结

以上方案通过V2版本的状态管理器特性以及引用传递/回调传递的方式实现@LocalBuilder自定义构建函数内UI刷新。