1# LazyForEach：数据懒加载 2 3 4LazyForEach从提供的数据源中按需迭代数据，并在每次迭代过程中创建相应的组件。当LazyForEach在滚动容器中使用了，框架会根据滚动容器可视区域按需创建组件，当组件划出可视区域外时，框架会进行组件销毁回收以降低内存占用。 5 6 7## 接口描述 8 9 10```ts 11LazyForEach( 12 dataSource: IDataSource, // 需要进行数据迭代的数据源 13 itemGenerator: (item: any) => void, // 子组件生成函数 14 keyGenerator?: (item: any) => string // (可选) .键值生成函数 15): void 16interface IDataSource { 17 totalCount(): number; // Get total count of data 18 getData(index: number): any; // Get single data by index 19 registerDataChangeListener(listener: DataChangeListener): void; // Register listener to listening data changes 20 unregisterDataChangeListener(listener: DataChangeListener): void; // Unregister listener 21} 22interface DataChangeListener { 23 onDataReloaded(): void; // Called while data reloaded 24 onDataAdd(index: number): void; // Called while single data added 25 onDataMove(from: number, to: number): void; // Called while single data moved 26 onDataDelete(index: number): void; // Called while single data deleted 27 onDataChange(index: number): void; // Called while single data changed 28} 29``` 30 31**参数：** 32 33 34| 参数名 | 参数类型 | 必填 | 参数描述 | 35| ------------- | --------------------------------------- | ---- | ---------------------------------------- | 36| dataSource | IDataSource | 是 | LazyForEach数据源，需要开发者实现相关接口。 | 37| itemGenerator | (item: any) => void | 是 | 子组件生成函数，为数组中的每一个数据项创建一个子组件。<br/>**说明：**<br/>itemGenerator的函数体必须使用大括号{...}。itemGenerator每次迭代只能并且必须生成一个子组件。itemGenerator中可以使用if语句，但是必须保证if语句每个分支都会创建一个相同类型的子组件。itemGenerator中不允许使用ForEach和LazyForEach语句。 | 38| keyGenerator | (item: any) => string | 否 | 键值生成函数，用于给数据源中的每一个数据项生成唯一且固定的键值。当数据项在数组中的位置更改时，其键值不得更改，当数组中的数据项被新项替换时，被替换项的键值和新项的键值必须不同。键值生成器的功能是可选的，但是，为了使开发框架能够更好地识别数组更改，提高性能，建议提供。如将数组反向时，如果没有提供键值生成器，则LazyForEach中的所有节点都将重建。<br/>**说明：**<br/>数据源中的每一个数据项生成的键值不能重复。 | 39 40 41## IDataSource类型说明 42 43 44```ts 45interface IDataSource { 46 totalCount(): number; 47 getData(index: number): any; 48 registerDataChangeListener(listener: DataChangeListener): void; 49 unregisterDataChangeListener(listener: DataChangeListener): void; 50} 51``` 52 53| 接口声明 | 参数类型 | 说明 | 54| ---------------------------------------- | ------------------ | ------------------------------------- | 55| totalCount(): number | - | 获得数据总数。 | 56| getData(index: number): any | number | 获取索引值index对应的数据。<br/>index：获取数据对应的索引值 | 57| registerDataChangeListener(listener:DataChangeListener): void | DataChangeListener | 注册数据改变的监听器。<br/>listener：数据变化监听器 | 58| unregisterDataChangeListener(listener:DataChangeListener): void | DataChangeListener | 注销数据改变的监听器。<br/>listener：数据变化监听器 | 59 60 61## DataChangeListener类型说明 62 63 64```ts 65interface DataChangeListener { 66 onDataReloaded(): void; 67 onDataAdded(index: number): void; 68 onDataMoved(from: number, to: number): void; 69 onDataDeleted(index: number): void; 70 onDataChanged(index: number): void; 71 onDataAdd(index: number): void; 72 onDataMove(from: number, to: number): void; 73 onDataDelete(index: number): void; 74 onDataChange(index: number): void; 75} 76``` 77 78| 接口声明 | 参数类型 | 说明 | 79| ------------------------------------------------------------ | -------------------------------------- | ------------------------------------------------------------ | 80| onDataReloaded(): void | - | 通知组件重新加载所有数据。 | 81| onDataAdded(index: number):void<sup>(deprecated)</sup> | number | 通知组件index的位置有数据添加。<br/>从API 8开始，建议使用onDataAdd。<br/>index：数据添加位置的索引值 | 82| onDataMoved(from: number, to: number): void<sup>(deprecated)</sup> | from: number,<br/>to: number | 通知组件数据有移动。<br/>从API 8开始，建议使用onDataMove。<br/>from: 数据移动起始位置，to: 数据移动目标位置。<br/>**说明：**<br/>数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。 | 83| onDataDeleted(index: number):void<sup>(deprecated)</sup> | number | 通知组件删除index位置的数据并刷新LazyForEach的展示内容。<br/>从API 8开始，建议使用onDataDelete。<br/>index：数据删除位置的索引值 | 84| onDataChanged(index: number): void<sup>(deprecated)</sup> | number | 通知组件index的位置有数据有变化。<br/>从API 8开始，建议使用onDataChange。<br/>index：数据变化监听器。 | 85| onDataAdd(index: number): void<sup>8+</sup> | number | 通知组件index的位置有数据添加。<br/>index：数据添加位置的索引值 | 86| onDataMove(from: number, to: number): void<sup>8+</sup> | from: number,<br/>to: number | 通知组件数据有移动。<br/>from: 数据移动起始位置，to: 数据移动目标位置。<br/>**说明：**<br/>数据移动前后键值要保持不变，如果键值有变化，应使用删除数据和新增数据接口。 | 87| onDataDelete(index: number):void<sup>8+</sup> | number | 通知组件删除index位置的数据并刷新LazyForEach的展示内容。<br/>index：数据删除位置的索引值<br/>**说明：** <br/>需要保证dataSource中的对应数据已经在调用onDataDelete前删除，否则页面渲染将出现未定义的行为。 | 88| onDataChange(index: number): void<sup>8+</sup> | number | 通知组件index的位置有数据有变化。<br/>index：数据变化位置的索引值 | 89 90 91## 使用限制 92 93- LazyForEach必须在容器组件内使用，仅有List、Grid以及Swiper组件支持数据懒加载（即只加载可视部分以及其前后少量数据用于缓冲），其他组件仍然是一次性加载所有的数据。 94 95- LazyForEach在每次迭代中，必须创建且只允许创建一个子组件。 96 97- 生成的子组件必须是允许包含在LazyForEach父容器组件中的子组件。 98 99- 允许LazyForEach包含在if/else条件渲染语句中，也允许LazyForEach中出现if/else条件渲染语句。 100 101- 键值生成器必须针对每个数据生成唯一的值，如果键值相同，将导致键值相同的UI组件被框架忽略，从而无法在父容器内显示。 102 103- LazyForEach必须使用DataChangeListener对象来进行更新，第一个参数dataSource使用状态变量时，状态变量改变不会触发LazyForEach的UI刷新。 104 105- 为了高性能渲染，通过DataChangeListener对象的onDataChange方法来更新UI时，需要生成不同于原来的键值来触发组件刷新。 106 107- itemGenerator函数的调用顺序不一定和数据源中的数据项相同，在开发过程中不要假设itemGenerator和keyGenerator函数是否执行及其执行顺序。例如，以下示例可能无法正常运行： 108 109 110 ```ts 111 LazyForEach(dataSource, 112 item => Text(`${item.i}. item.data.label`), 113 item => item.data.id.toString()) 114 ``` 115 116 117## 示例 118 119 120```ts 121// Basic implementation of IDataSource to handle data listener 122class BasicDataSource implements IDataSource { 123 private listeners: DataChangeListener[] = []; 124 125 public totalCount(): number { 126 return 0; 127 } 128 129 public getData(index: number): any { 130 return undefined; 131 } 132 133 registerDataChangeListener(listener: DataChangeListener): void { 134 if (this.listeners.indexOf(listener) < 0) { 135 console.info('add listener'); 136 this.listeners.push(listener); 137 } 138 } 139 140 unregisterDataChangeListener(listener: DataChangeListener): void { 141 const pos = this.listeners.indexOf(listener); 142 if (pos >= 0) { 143 console.info('remove listener'); 144 this.listeners.splice(pos, 1); 145 } 146 } 147 148 notifyDataReload(): void { 149 this.listeners.forEach(listener => { 150 listener.onDataReloaded(); 151 }) 152 } 153 154 notifyDataAdd(index: number): void { 155 this.listeners.forEach(listener => { 156 listener.onDataAdd(index); 157 }) 158 } 159 160 notifyDataChange(index: number): void { 161 this.listeners.forEach(listener => { 162 listener.onDataChange(index); 163 }) 164 } 165 166 notifyDataDelete(index: number): void { 167 this.listeners.forEach(listener => { 168 listener.onDataDelete(index); 169 }) 170 } 171 172 notifyDataMove(from: number, to: number): void { 173 this.listeners.forEach(listener => { 174 listener.onDataMove(from, to); 175 }) 176 } 177} 178 179class MyDataSource extends BasicDataSource { 180 private dataArray: string[] = ['/path/image0', '/path/image1', '/path/image2', '/path/image3']; 181 182 public totalCount(): number { 183 return this.dataArray.length; 184 } 185 186 public getData(index: number): any { 187 return this.dataArray[index]; 188 } 189 190 public addData(index: number, data: string): void { 191 this.dataArray.splice(index, 0, data); 192 this.notifyDataAdd(index); 193 } 194 195 public pushData(data: string): void { 196 this.dataArray.push(data); 197 this.notifyDataAdd(this.dataArray.length - 1); 198 } 199} 200 201@Entry 202@Component 203struct MyComponent { 204 private data: MyDataSource = new MyDataSource(); 205 206 build() { 207 List({ space: 3 }) { 208 LazyForEach(this.data, (item: string) => { 209 ListItem() { 210 Row() { 211 Image(item).width('30%').height(50) 212 Text(item).fontSize(20).margin({ left: 10 }) 213 }.margin({ left: 10, right: 10 }) 214 } 215 .onClick(() => { 216 this.data.pushData('/path/image' + this.data.totalCount()); 217 }) 218 }, item => item) 219 } 220 } 221} 222``` 223