HarmonyOS-LazyForEach：数据懒加载

时间：2025-01-26 19:38:27

LazyForEach：数据懒加载

LazyForEach从提供的数据源中按需迭代数据，并在每次迭代过程中创建相应的组件。当在滚动容器中使用了LazyForEach，框架会根据滚动容器可视区域按需创建组件，当组件滑出可视区域外时，框架会进行组件销毁回收以降低内存占用。

接口描述

LazyForEach(
    dataSource: IDataSource,             // 需要进行数据迭代的数据源
    itemGenerator: (item: any, index?: number) => void,  // 子组件生成函数
    keyGenerator?: (item: any, index?: number) => string // 键值生成函数
): void

参数：

参数名 参数类型 必填 参数描述
dataSource IDataSource 是 LazyForEach数据源，需要开发者实现相关接口。
itemGenerator (item: any， index?:number) => void 是 子组件生成函数，为数组中的每一个数据项创建一个子组件。**说明：**item是当前数据项，index是数据项索引值。itemGenerator的函数体必须使用大括号{…}。itemGenerator每次迭代只能并且必须生成一个子组件。itemGenerator中可以使用if语句，但是必须保证if语句每个分支都会创建一个相同类型的子组件。itemGenerator中不允许使用ForEach和LazyForEach语句。
keyGenerator (item: any, index?:number) => string 否 键值生成函数，用于给数据源中的每一个数据项生成唯一且固定的键值。当数据项在数组中的位置更改时，其键值不得更改，当数组中的数据项被新项替换时，被替换项的键值和新项的键值必须不同。键值生成器的功能是可选的，但是，为了使开发框架能够更好地识别数组更改，提高性能，建议提供。如将数组反向时，如果没有提供键值生成器，则LazyForEach中的所有节点都将重建。**说明：**item是当前数据项，index是数据项索引值。数据源中的每一个数据项生成的键值不能重复。

IDataSource类型说明

interface IDataSource {
    totalCount(): number; // 获得数据总数
    getData(index: number): Object; // 获取索引值对应的数据
    registerDataChangeListener(listener: DataChangeListener): void; // 注册数据改变的监听器
    unregisterDataChangeListener(listener: DataChangeListener): void; // 注销数据改变的监听器
}
接口声明 参数类型 说明
totalCount(): number - 获得数据总数。
getData(index: number): any number 获取索引值index对应的数据。index：获取数据对应的索引值。
registerDataChangeListener(listener:DataChangeListener): void DataChangeListener 注册数据改变的监听器。listener：数据变化监听器
unregisterDataChangeListener(listener:DataChangeListener): void DataChangeListener 注销数据改变的监听器。listener：数据变化监听器

DataChangeListener类型说明

interface DataChangeListener {
    onDataReloaded(): void; // 重新加载数据完成后调用
    onDataAdded(index: number): void; // 添加数据完成后调用
    onDataMoved(from: number, to: number): void; // 数据移动起始位置与数据移动目标位置交换完成后调用
    onDataDeleted(index: number): void; // 删除数据完成后调用
    onDataChanged(index: number): void; // 改变数据完成后调用
    onDataAdd(index: number): void; // 添加数据完成后调用
    onDataMove(from: number, to: number): void; // 数据移动起始位置与数据移动目标位置交换完成后调用
    onDataDelete(index: number): void; // 删除数据完成后调用
    onDataChange(index: number): void; // 改变数据完成后调用
}
接口声明 参数类型 说明
onDataReloaded(): void - 通知组件重新加载所有数据。键值没有变化的数据项会使用原先的子组件，键值发生变化的会重建子组件。
onDataAdd(index: number): void8+ number 通知组件index的位置有数据添加。index：数据添加位置的索引值。
onDataMove(from: number, to: number): void8+ from: number,to: number 通知组件数据有移动。from: 数据移动起始位置，to: 数据移动目标位置。**说明：**数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。
onDataDelete(index: number):void8+ number 通知组件删除index位置的数据并刷新LazyForEach的展示内容。index：数据删除位置的索引值。**说明：**需要保证dataSource中的对应数据已经在调用onDataDelete前删除，否则页面渲染将出现未定义的行为。
onDataChange(index: number): void8+ number 通知组件index的位置有数据有变化。index：数据变化位置的索引值。
onDataAdded(index: number):void(deprecated) number 通知组件index的位置有数据添加。从API 8开始，建议使用onDataAdd。index：数据添加位置的索引值。
onDataMoved(from: number, to: number): void(deprecated) from: number,to: number 通知组件数据有移动。从API 8开始，建议使用onDataMove。from: 数据移动起始位置，to: 数据移动目标位置。将from和to位置的数据进行交换。**说明：**数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。
onDataDeleted(index: number):void(deprecated) number 通知组件删除index位置的数据并刷新LazyForEach的展示内容。从API 8开始，建议使用onDataDelete。index：数据删除位置的索引值。
onDataChanged(index: number): void(deprecated) number 通知组件index的位置有数据有变化。从API 8开始，建议使用onDataChange。index：数据变化监听器。

使用限制

  • LazyForEach必须在容器组件内使用，仅有List、Grid、Swiper以及WaterFlow组件支持数据懒加载（可配置cachedCount属性，即只加载可视部分以及其前后少量数据用于缓冲），其他组件仍然是一次性加载所有的数据。
  • LazyForEach在每次迭代中，必须创建且只允许创建一个子组件。
  • 生成的子组件必须是允许包含在LazyForEach父容器组件中的子组件。
  • 允许LazyForEach包含在if/else条件渲染语句中，也允许LazyForEach中出现if/else条件渲染语句。
  • 键值生成器必须针对每个数据生成唯一的值，如果键值相同，将导致键值相同的UI组件被框架忽略，从而无法在父容器内显示。
  • LazyForEach必须使用DataChangeListener对象来进行更新，第一个参数dataSource使用状态变量时，状态变量改变不会触发LazyForEach的UI刷新。
  • 为了高性能渲染，通过DataChangeListener对象的onDataChange方法来更新UI时，需要生成不同于原来的键值来触发组件刷新。

键值生成规则

在LazyForEach循环渲染过程中，系统会为每个item生成一个唯一且持久的键值，用于标识对应的组件。当这个键值变化时，ArkUI框架将视为该数组元素已被替换或修改，并会基于新的键值创建一个新的组件。

LazyForEach提供了一个名为keyGenerator的参数，这是一个函数，开发者可以通过它自定义键值的生成规则。如果开发者没有定义keyGenerator函数，则ArkUI框架会使用默认的键值生成函数，即(item: any, index: number) => { return viewId + ‘-’ + (); }, viewId在编译器转换过程中生成，同一个LazyForEach组件内其viewId是一致的。

组件创建规则

在确定键值生成规则后，LazyForEach的第二个参数itemGenerator函数会根据键值生成规则为数据源的每个数组项创建组件。组件的创建包括两种情况：LazyForEach首次渲染和LazyForEach非首次渲染。

首次渲染

  • 生成不同键值

在LazyForEach首次渲染时，会根据上述键值生成规则为数据源的每个数组项生成唯一键值，并创建相应的组件。

// Basic implementation of IDataSource to handle data listener
class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  // 该方法为框架侧调用，为LazyForEach组件向其数据源处添加listener监听
  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  // 该方法为框架侧调用，为对应的LazyForEach组件在数据源处去除listener监听
  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  // 通知LazyForEach组件需要重载所有子组件
  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  // 通知LazyForEach组件需要在index对应索引处添加子组件
  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  // 通知LazyForEach组件在index对应索引处数据有变化，需要重建该子组件
  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  // 通知LazyForEach组件需要在index对应索引处删除该子组件
  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
}

@Entry
@Component
struct MyComponent {
  private data: MyDataSource = new MyDataSource();
   
  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

在上述代码中，键值生成规则是keyGenerator函数的返回值item。在LazyForEach循环渲染时，其为数据源数组项依次生成键值Hello 0、Hello 1 … Hello 20，并创建对应的ListItem子组件渲染到界面上。

运行效果如下图所示。

图1 LazyForEach正常首次渲染

img

  • 键值相同时错误渲染

当不同数据项生成的键值相同时，框架的行为是不可预测的。例如，在以下代码中，LazyForEach渲染的数据项键值均相同，在滑动过程中，LazyForEach会对划入划出当前页面的子组件进行预加载，而新建的子组件和销毁的原子组件具有相同的键值，框架可能存在取用缓存错误的情况，导致子组件渲染有问题。

class BasicDataSource implements IDataSource {
 private listeners: DataChangeListener[] = [];
 private originDataArray: string[] = [];

 public totalCount(): number {
   return 0;
 }

 public getData(index: number): string {
   return [index];
 }

 registerDataChangeListener(listener: DataChangeListener): void {
   if ((listener) < 0) {
     ('add listener');
     (listener);
   }
 }

 unregisterDataChangeListener(listener: DataChangeListener): void {
   const pos = (listener);
   if (pos >= 0) {
     ('remove listener');
     (pos, 1);
   }
 }

 notifyDataReload(): void {
   (listener => {
     ();
   })
 }

 notifyDataAdd(index: number): void {
   (listener => {
     (index);
   })
 }

 notifyDataChange(index: number): void {
   (listener => {
     (index);
   })
 }

 notifyDataDelete(index: number): void {
   (listener => {
     (index);
   })
 }
}

class MyDataSource extends BasicDataSource {
 private dataArray: string[] = [];

 public totalCount(): number {
   return ;
 }

 public getData(index: number): string {
   return [index];
 }

 public addData(index: number, data: string): void {
   (index, 0, data);
   (index);
 }

 public pushData(data: string): void {
   (data);
   ( - 1);
 }
}

@Entry
@Component
struct MyComponent {
 private data: MyDataSource = new MyDataSource();

 aboutToAppear() {
   for (let i = 0; i <= 20; i++) {
     (`Hello ${i}`)
   }
 }

 build() {
   List({ space: 3 }) {
     LazyForEach(, (item: string) => {
       ListItem() {
         Row() {
           Text(item).fontSize(50)
             .onAppear(() => {
               ("appear:" + item)
             })
         }.margin({ left: 10, right: 10 })
       }
     }, (item: string) => 'same key')
   }.cachedCount(5)
 }
}

运行效果如下图所示。可以看到Hello 0在滑动过程中被错误渲染为Hello 13。

图2 LazyForEach存在相同键值

img

非首次渲染

当LazyForEach数据源发生变化，需要再次渲染时，开发者应根据数据源的变化情况调用listener对应的接口，通知LazyForEach做相应的更新，各使用场景如下。

  • 添加数据
class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
}

@Entry
@Component
struct MyComponent {
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          // 点击追加子组件
          (`Hello ${()}`);
        })
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

当我们点击LazyForEach的子组件时，首先调用数据源data的pushData方法，该方法会在数据源末尾添加数据并调用notifyDataAdd方法。在notifyDataAdd方法内会又调用方法，该方法会通知LazyForEach在该处有数据添加，LazyForEach便会在该索引处新建子组件。

运行效果如下图所示。

图3 LazyForEach添加数据

img

  • 删除数据
class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
  
  public deleteData(index: number): void {
    (index, 1);
    (index);
  }
}

@Entry
@Component
struct MyComponent {
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string, index: number) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          // 点击删除子组件
          ((item));
        })
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

当我们点击LazyForEach的子组件时，首先调用数据源data的deleteData方法，该方法会删除数据源对应索引处的数据并调用notifyDatDelete方法。在notifyDataDelete方法内会又调用方法，该方法会通知LazyForEach在该处有数据删除，LazyForEach便会在该索引处删除对应子组件。

运行效果如下图所示。

图4 LazyForEach删除数据

img

  • 改变单个数据
class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
  
  public deleteData(index: number): void {
    (index, 1);
    (index);
  }
  
  public changeData(index: number, data: string): void {
    (index, 1, data);
    (index);
  }
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }


  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string, index: number) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          (index, item + '00');
        })
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

当我们点击LazyForEach的子组件时，首先改变当前数据，然后调用数据源data的changeData方法，在该方法内会调用notifyDataChange方法。在notifyDataChange方法内会又调用方法，该方法通知LazyForEach组件该处有数据发生变化，LazyForEach便会在对应索引处重建子组件。

运行效果如下图所示。

图5 LazyForEach改变单个数据

img

  • 改变多个数据
class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
  
  public deleteData(index: number): void {
    (index, 1);
    (index);
  }
  
  public changeData(index: number): void {
    (index);
  }
    
  public reloadData(): void {
    ();
  }
    
  public modifyAllData(): void {
     = ((item: string) => {
        return item + '0';
    })
  }
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string, index: number) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          ();
          ();
        })
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

当我们点击LazyForEach的子组件时，首先调用data的modifyAllData方法改变了数据源中的所有数据，然后调用数据源的reloadData方法，在该方法内会调用notifyDataReload方法。在notifyDataReload方法内会又调用方法，通知LazyForEach需要重建所有子节点。LazyForEach会将原所有数据项和新所有数据项一一做键值比对，若有相同键值则使用缓存，若键值不同则重新构建。

运行效果如下图所示。

图6 LazyForEach改变多个数据

img

  • 改变数据子属性

若仅靠LazyForEach的刷新机制，当item变化时若想更新子组件，需要将原来的子组件全部销毁再重新构建，在子组件结构较为复杂的情况下，靠改变键值去刷新渲染性能较低。因此框架提供了@Observed与@ObjectLink机制进行深度观测，可以做到仅刷新使用了该属性的组件，提高渲染性能。开发者可根据其自身业务特点选择使用哪种刷新方式。

class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: StringData[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): StringData {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: StringData[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): StringData {
    return [index];
  }

  public addData(index: number, data: StringData): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: StringData): void {
    (data);
    ( - 1);
  }
}

@Observed
class StringData {
  message: string;
  constructor(message: string) {
     = message;
  }  
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  @State data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (new StringData(`Hello ${i}`));
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: StringData, index: number) => {
        ListItem() {
          ChildComponent({data: item})
        }
        .onClick(() => {
           += '0';
        })
      }, (item: StringData, index: number) => ())
    }.cachedCount(5)
  }
}

@Component
struct ChildComponent {
  @ObjectLink data: StringData
  build() {
    Row() {
      Text().fontSize(50)
        .onAppear(() => {
          ("appear:" + )
        })
    }.margin({ left: 10, right: 10 })
  }
}

此时点击LazyForEach子组件改变时，重渲染依赖的是ChildComponent的@ObjectLink成员变量对其子属性的监听，此时框架只会刷新Text()，不会去重建整个ListItem子组件。

图7 LazyForEach改变数据子属性

img

常见使用问题

  • 渲染结果非预期

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
  
  public deleteData(index: number): void {
    (index, 1);
    (index);
  }
}

@Entry
@Component
struct MyComponent {
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string, index: number) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          // 点击删除子组件
          (index);
        })
      }, (item: string) => item)
    }.cachedCount(5)
  }
}

    图8 LazyForEach删除数据非预期

    img

    当我们多次点击子组件时，会发现删除的并不一定是我们点击的那个子组件。原因是当我们删除了某一个子组件后，位于该子组件对应的数据项之后的各数据项，其index均应减1，但实际上后续的数据项对应的子组件仍然使用的是最初分配的index，其itemGenerator中的index并没有发生变化，所以删除结果和预期不符。

    修复代码如下所示。

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: string[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): string {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: string[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): string {
    return [index];
  }

  public addData(index: number, data: string): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: string): void {
    (data);
    ( - 1);
  }
  
  public deleteData(index: number): void {
    (index, 1);
    (index);
  }
    
  public reloadData(): void {
    ();
  }
}

@Entry
@Component
struct MyComponent {
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (`Hello ${i}`)
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: string, index: number) => {
        ListItem() {
          Row() {
            Text(item).fontSize(50)
              .onAppear(() => {
                ("appear:" + item)
              })
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
          // 点击删除子组件
          (index);
          // 重置所有子组件的index索引
          ();
        })
      }, (item: string, index: number) => item + ())
    }.cachedCount(5)
  }
}

    在删除一个数据项后调用reloadData方法，重建后面的数据项，以达到更新index索引的目的。

    图9 修复LazyForEach删除数据非预期

    img

  • 重渲染时图片闪烁

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: StringData[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): StringData {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: StringData[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): StringData {
    return [index];
  }

  public addData(index: number, data: StringData): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: StringData): void {
    (data);
    ( - 1);
  }
    
  public reloadData(): void {
    ();
  }
}

class StringData {
  message: string;
  imgSrc: Resource;
  constructor(message: string, imgSrc: Resource) {
       = message;
       = imgSrc;
  }  
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  private data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (new StringData(`Hello ${i}`, $r('')));
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: StringData, index: number) => {
        ListItem() {
          Column() {
            Text().fontSize(50)
              .onAppear(() => {
                ("appear:" + )
              })
            Image()
              .width(500)
              .height(200)
          }.margin({ left: 10, right: 10 })
        }
        .onClick(() => {
           += '00';
          ();
        })
      }, (item: StringData, index: number) => (item))
    }.cachedCount(5)
  }
}

    图10 LazyForEach仅改变文字但是图片闪烁问题

    img

    在我们点击ListItem子组件时，我们只改变了数据项的message属性，但是LazyForEach的刷新机制会导致整个ListItem被重建。由于Image组件是异步刷新，所以视觉上图片会发生闪烁。为了解决这种情况我们应该使用@ObjectLink和@Observed去单独刷新使用了的Text组件。

    修复代码如下所示。

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: StringData[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): StringData {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: StringData[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): StringData {
    return [index];
  }

  public addData(index: number, data: StringData): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: StringData): void {
    (data);
    ( - 1);
  }
}

@Observed
class StringData {
  message: string;
  imgSrc: Resource;
  constructor(message: string, imgSrc: Resource) {
       = message;
       = imgSrc;
  }  
}

@Entry
@Component
struct MyComponent {
  @State data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (new StringData(`Hello ${i}`, $r('')));
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: StringData, index: number) => {
        ListItem() {
          ChildComponent({data: item})
        }
        .onClick(() => {
           += '0';
        })
      }, (item: StringData, index: number) => ())
    }.cachedCount(5)
  }
}

@Component
struct ChildComponent {
  @ObjectLink data: StringData
  build() {
    Column() {
      Text().fontSize(50)
        .onAppear(() => {
          ("appear:" + )
        })
      Image()
        .width(500)
        .height(200)
    }.margin({ left: 10, right: 10 })
  }
}

    图11 修复LazyForEach仅改变文字但是图片闪烁问题

    img

  • @ObjectLink属性变化UI未更新

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: StringData[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): StringData {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: StringData[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): StringData {
    return [index];
  }

  public addData(index: number, data: StringData): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: StringData): void {
    (data);
    ( - 1);
  }
}

@Observed
class StringData {
  message: NestedString;
  constructor(message: NestedString) {
     = message;
  }  
}

@Observed
class NestedString {
  message: string;
  constructor(message: string) {
     = message;
  }  
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  @State data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (new StringData(new NestedString(`Hello ${i}`)));
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: StringData, index: number) => {
        ListItem() {
          ChildComponent({data: item})
        }
        .onClick(() => {
           += '0';
        })
      }, (item: StringData, index: number) => () + ())
    }.cachedCount(5)
  }
}

@Component
struct ChildComponent {
  @ObjectLink data: StringData
  build() {
    Row() {
      Text().fontSize(50)
        .onAppear(() => {
          ("appear:" + )
        })
    }.margin({ left: 10, right: 10 })
  }
}

    图12 ObjectLink属性变化后UI未更新

    img

    @ObjectLink装饰的成员变量仅能监听到其子属性的变化，再深入嵌套的属性便无法观测到了，因此我们只能改变它的子属性去通知对应组件重新渲染，具体请查看@ObjectLink与@Observed的详细使用方法和限制条件。

    修复代码如下所示。

    class BasicDataSource implements IDataSource {
  private listeners: DataChangeListener[] = [];
  private originDataArray: StringData[] = [];

  public totalCount(): number {
    return 0;
  }

  public getData(index: number): StringData {
    return [index];
  }

  registerDataChangeListener(listener: DataChangeListener): void {
    if ((listener) < 0) {
      ('add listener');
      (listener);
    }
  }

  unregisterDataChangeListener(listener: DataChangeListener): void {
    const pos = (listener);
    if (pos >= 0) {
      ('remove listener');
      (pos, 1);
    }
  }

  notifyDataReload(): void {
    (listener => {
      ();
    })
  }

  notifyDataAdd(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataChange(index: number): void {
    (listener => {
      (index);
    })
  }

  notifyDataDelete(index: number): void {
    (listener => {
      (index);
    })
  }
}

class MyDataSource extends BasicDataSource {
  private dataArray: StringData[] = [];

  public totalCount(): number {
    return ;
  }

  public getData(index: number): StringData {
    return [index];
  }

  public addData(index: number, data: StringData): void {
    (index, 0, data);
    (index);
  }

  public pushData(data: StringData): void {
    (data);
    ( - 1);
  }
}

@Observed
class StringData {
  message: NestedString;
  constructor(message: NestedString) {
     = message;
  }  
}

@Observed
class NestedString {
  message: string;
  constructor(message: string) {
     = message;
  }  
}

@Entry
@Component
struct MyComponent {
  private moved: number[] = [];
  @State data: MyDataSource = new MyDataSource();

  aboutToAppear() {
    for (let i = 0; i <= 20; i++) {
      (new StringData(new NestedString(`Hello ${i}`)));
    }
  }

  build() {
    List({ space: 3 }) {
      LazyForEach(, (item: StringData, index: number) => {
        ListItem() {
          ChildComponent({data: item})
        }
        .onClick(() => {
           = new NestedString( + '0');
        })
      }, (item: StringData, index: number) => () + ())
    }.cachedCount(5)
  }
}

@Component
struct ChildComponent {
  @ObjectLink data: StringData
  build() {
    Row() {
      Text().fontSize(50)
        .onAppear(() => {
          ("appear:" + )
        })
    }.margin({ left: 10, right: 10 })
  }
}

    图13 修复ObjectLink属性变化后UI更新

dex: number): StringData {
return [index];
}

public addData(index: number, data: StringData): void {
  (index, 0, data);
  (index);
}

public pushData(data: StringData): void {
  (data);
  ( - 1);
}

}

@Observed
class StringData {
message: NestedString;
constructor(message: NestedString) {
= message;
}
}

@Observed
class NestedString {
message: string;
constructor(message: string) {
= message;
}
}

@Entry
@Component
struct MyComponent {
private moved: number[] = [];
@State data: MyDataSource = new MyDataSource();

aboutToAppear() {
  for (let i = 0; i <= 20; i++) {
    (new StringData(new NestedString(`Hello ${i}`)));
  }
}

build() {
  List({ space: 3 }) {
    LazyForEach(, (item: StringData, index: number) => {
      ListItem() {
        ChildComponent({data: item})
      }
      .onClick(() => {
         = new NestedString( + '0');
      })
    }, (item: StringData, index: number) => () + ())
  }.cachedCount(5)
}

}

图13 修复ObjectLink属性变化后UI更新

img

相关文章