网格是应用开发中常见的开发场景。它通过相交的横线和竖线,形成整齐有序的网状布局。网格适用于展示图片、媒体文件、购物商品等多种数据。当网格上下滑动时,子组件会带来测量和绘制的性能消耗。本文通过跨页面复用、加速首屏渲染、下拉刷新等场景,介绍ScrollComponents库创建高流畅滑动的网格页面。
ScrollComponents作为高性能滑动解决方案,主要解决组件复用的问题,支持通过少量的代码实现高性能滑动,同时开发者无需关注复用池管理和其他性能优化方案的交互细节。可以参考快速开始进行安装配置与快速上手。ScrollComponents框架提供了下列功能特性:
ScrollComponents三方库底层封装NodeContainer+FrameNode,结合NodeAdapter+BuildNode+自定义复用池实现懒加载、组件复用、组件预创建等能力,同时为开发者提供WaterFlowManager、ListManager、GridManager等视图管理组件,为开发者提供系统滑动组件的其他各种能力,在满足开发者正常开发的前提下提供高性能的滑动能力,只需要传入数据源和viewManager即可快速实现懒加载和组件复用的开发,可以更加聚焦业务实现。
如图1是RecyclerView整体流程图,当节点从可视区移除时,NodeAdapter会通知视图管理器将组件回收,经NodeFactory回收处理之后,组件最终被存入到组件复用池。当节点需要创建时,NodeAdapter通知视图管理器开始创建,NodeFactory会向复用池请求复用节点,获取到节点之后经过一系列更新组件、组件拼接之后返回,最后由NodeAdapter将节点添加到可视区。

GridManager仅具备基础的视图能力,开发者需要使用组件复用能力,需定义一个继承自GridManager的类,并实现onWillCreateItem()接口,具体可参考4.注册子节点模板。核心代码如下:
import { GridManager, type NodeItem, RecyclerView } from '@hadss/scroll_components';
// ...
@Component
export default struct WordGridComponent {
public gridViewManager: GridViewManager = new GridViewManager({ defaultNodeItem: 'word', context: this.getUIContext() });
// ...
};
class GridViewManager extends GridManager {
public onWillCreateItem(index: number, data: WordViewModel): NodeItem<WordCellData> | null {
// get node based on identifier 'word' from recycle pool.
let node: NodeItem<WordCellData> | null = this.dequeueReusableNodeByType('word');
node.setData({ word: data });
return node;
};
};
如果开发者想通过ScrollComponents快速创建网格,方便使用懒加载、预创建等提升滑动效率的能力,而不考虑组件复用,则直接使用ScrollComponents库提供的GridManager创建网格视图管理器即可。具体可参考ScrollComponents使用说明。
页面初始化时,开发者通过视图管理器的setViewStyle()接口,给视图设置对应的视图属性。
aboutToAppear(): void {
this.gridViewManager.setViewStyle()
.alignItems(GridItemAlignment.STRETCH);
this.gridViewManager.setViewStyle()
.columnsTemplate('repeat(auto-fill, 70)')
.columnsGap(5)
.rowsGap(5);
// ...
} import { GridManager, NodeItem, RecyclerView } from "@hadss/scroll_components";
import WordGridViewModel from "../viewModel/WordGridViewModel";
import WordViewModel from "../viewModel/WordViewModel";
// ...
@Component
export default struct WordGridComponent {
gridViewManager: GridViewManager = new GridViewManager({ defaultNodeItem: 'word', context: this.getUIContext() });
viewModel: WordGridViewModel = new WordGridViewModel(this.gridViewManager);
aboutToAppear(): void {
// ...
// associates the builder with the identifier 'word'.
this.gridViewManager.registerNodeItem('word', wrapBuilder(buildWordCell));
this.viewModel.loadData();
}
build() {
Column() {
// place the grid in a column.
RecyclerView({
viewManager: this.gridViewManager
})
}
.width('100%')
}
} @Observed
export default class WordGridViewModel {
@Track data: WordViewModel[] = [];
gridViewManager?: GridManager;
// ...
async loadData() {
// simulated request data.
for (let index = 0; index < 15; index++) {
let viewModel: WordViewModel = new WordViewModel();
// ...
this.data.push(viewModel);
}
this.gridViewManager?.setDataSource(this.data);
}
}
1. 注册子节点模板方法registerNodeItem()中使用@builder函数目前仅支持全局。
2. 开发者如果使用this.gridViewManager.preCreate()实现组件预创建,则需要在注册节点模板后预创建组件。
开发者自定义模板后,在定义视图管理器时需要实现onWillCreateItem()接口,并在此接口中通过dequeueReusableNodeByType()获取可复用node,实现组件复用,同时也需要在复用组件的aboutToReuse生命期中,对数据进行更新。
如果复用的单元格组件结构相同,数据不同时,直接注册节点模板。
import WordCell from './WordCellComponent';
/**
* define item template.
*
* @param data data of node
*/
@Builder
function buildWordCell(data: WordCellData) {
WordCell({ word: data.word });
}
@Component
export default struct WordGridComponent {
// ...
aboutToAppear(): void {
// ...
// associates the builder with the identifier 'word'.
this.gridViewManager.registerNodeItem('word', wrapBuilder(buildWordCell));
// ...
}
// ...
};
class GridViewManager extends GridManager {
public onWillCreateItem(index: number, data: WordViewModel): NodeItem<WordCellData> | null {
// get node based on identifier 'word' from recycle pool.
let node: NodeItem<WordCellData> | null = this.dequeueReusableNodeByType('word');
node.setData({ word: data });
return node;
};
}; 如果复用的单元格组件结构基本相同,存在部分差异,差异的部分会复用失效。ScrollComponents提供了PartReuse来保证命中组件复用。

开发者可参考图3日志打印"generateItem reuse "表示复用,检验是否复用成功。

子组件1:
// child component in item
@Component
export default struct UserCardComponent {
@State user: UserInfoViewModel = new UserInfoViewModel();
public aboutToReuse(params: Record<string, ESObject>): void {
let input = params as CardCellData;
this.user = input.user;
}
public build(): void {
// ...
};
};
@Builder
export function buildUserCard(params: CardCellData) {
UserCardComponent({ user: params.user });
}; 子组件2:
// child component in item
@Component
export default struct ManagerCardComponent {
@State user: UserInfoViewModel = new UserInfoViewModel();
public aboutToReuse(params: Record<string, ESObject>): void {
let input = params as CardCellData;
this.user = input.user;
}
public build(): void {
// ...
};
};
@Builder
export function buildManagerCard(params: CardCellData) {
ManagerCardComponent({ user: params.user });
} 单元格组件:
// item component
@Component
export default struct CardComponent {
@State user: UserInfoViewModel = new UserInfoViewModel();
public aboutToReuse(params: Record<string, ESObject>): void {
let input = params as CardCellData;
this.user = input.user;
}
// ...
build() {
Column() {
if (this.user.role === 'manager') {
// when need to reuse a subcomponent, use PartReuse to encapsulate it.
PartReuse({
type: 'manager',
builder: wrapBuilder(buildManagerCard),
data: {
user: this.user
}
});
} else {
PartReuse({
type: 'user',
builder: wrapBuilder(buildUserCard),
data: {
user: this.user
}
});
}
}
.bindContextMenu(this.optMenu(), ResponseType.LongPress)
.width('90%')
.height(80);
};
};
@Builder
export function buildCard(data: CardCellData) {
CardComponent({ user: data.user });
} 组件注册:
// card grid view
@Component
export default struct CardGridComponent {
// ...
public aboutToAppear(): void {
// ...
// register the reusable template.
this.gridViewManager.registerNodeItem('card', wrapBuilder(buildCard));
this.gridViewManager.registerNodeItem('user', wrapBuilder(buildUserCard));
this.gridViewManager.registerNodeItem('manager', wrapBuilder(buildManagerCard));
// ...
}
// ...
public build(): void {
Stack({ alignContent: Alignment.Bottom }) {
// main grid
RecyclerView({
viewManager: this.gridViewManager
});
// ...
};
};
};
/**
* grid manager class
*/
class GridViewManager extends GridManager {
public onWillCreateItem(index: number, data: UserInfoViewModel): NodeItem<CardCellData> | null {
let node: NodeItem<CardCellData> | null = this.dequeueReusableNodeByType('card');
node?.setData({ user: data });
return node;
}
} 如果GridItem结构差异较大,包括布局差异大、差异的组件数量较多、组件类型不同等因素,导致直接复用GridItem困难,则可定义多个复用模板。
@Component
export default struct WorkComponent {
// ...
public aboutToAppear(): void {
// ...
this.gridViewManager.registerNodeItem('video', wrapBuilder(buildVideoWork));
this.gridViewManager.registerNodeItem('picture', wrapBuilder(buildPictureWork));
this.gridViewManager.registerNodeItem('photoContainer', wrapBuilder(buildPhoto));
// ...
}
// ...
};
/**
* grid manager class
*/
class GridViewManager extends GridManager {
public onWillCreateItem(index: number, data: WorkViewModel): NodeItem<WorkCellData> | null {
// select the corresponding template according to the data type.
let node: NodeItem<WorkCellData> | null = this.dequeueReusableNodeByType(data.type);
node?.setData({ work: data });
return node;
}
} RecyclerView默认会生成一个RecycledPool,通过定义复用池单例存储该pool,提供跨页面使用。以下单例仅做参考,开发者可自行封装。
import type { RecycledPool } from '@hadss/scroll_components';
export class Utils {
// ...
private static utils_: Utils;
public nodePool: RecycledPool | null = null;
// ...
} GridManager提供getRecyclePool()方法可获取RecycledPool,然后存储在全局单例中。
@Component
export default struct WorkComponent {
// ...
public aboutToAppear(): void {
if (Utils.getInstance().nodePool) {
this.gridViewManager.registerRecyclePool(Utils.getInstance().nodePool!);
} else {
// save recycle pool.
Utils.getInstance().nodePool = this.gridViewManager.getRecyclePool();
}
// ...
}
// ...
}; 跨页面使用registerRecyclePool,将全局单例中的RecyclePool注册到该页面定义的Grid视图类对象上,实现跨页面不同RecyclerView视图的复用池共享。
@Component
export default struct PhotoGridComponent {
// ...
public aboutToAppear(): void {
// ...
if (Utils.getInstance().nodePool) {
// register recycle pool.
this.gridViewManager.registerRecyclePool(Utils.getInstance().nodePool!);
} else {
Utils.getInstance().nodePool = this.gridViewManager.getRecyclePool();
}
// ...
// register template after register recycle pool.
this.gridViewManager.registerNodeItem('photoContainer', wrapBuilder(buildPhoto));
// ...
}
// ...
}; 冷启动后首次打开网格页面,由于页面的图片或者视频等媒体资源过多,出现白屏或者白块,等好几秒才缓慢刷出内容。ScrollComponents库支持组件预创建,能打开页面后瞬间看到文字、图片骨架,减少卡顿。
核心代码参考如下:
public aboutToAppear(): void {
// ...
// register the reusable template.
this.gridViewManager.registerNodeItem('card', wrapBuilder(buildCard));
this.gridViewManager.registerNodeItem('user', wrapBuilder(buildUserCard));
this.gridViewManager.registerNodeItem('manager', wrapBuilder(buildManagerCard));
// key point: `preCreate()` pre-creates the reusable template,
// which must be registered before the reusable template.
this.gridViewManager.preCreate('card', 25);
this.gridViewManager.preCreate('user', 10);
this.gridViewManager.preCreate('manager', 30);
// ...
} @Reusable:网络请求期间主线程大段空闲,请求结束后首屏组件绘帧耗时较长

ScrollComponents:网络请求期间主线程空闲较少,请求结束后首屏组件绘帧耗时较短

实现方式 | 冷启动完成时延 | 主线程空闲时间 | 首屏组件创建时间 |
|---|---|---|---|
ScrollComponents | 2.5s | 281ms | 223ms |
@Reusable | 2.8s | 998ms | 467ms |
结论:ScrollComponents在冷启动场景下,完成时延优于原生@Reusable。整体完成时延优化300ms。
下拉刷新是提升用户体验的关键功能,既要保证数据无缝加载,又要维持流畅的交互效果。下拉刷新场景下使用懒加载刷新避免媒体资源加载造成UI渲染阻塞。效果参考:示例6(实现下拉刷新上拉加载更多)。
@Component
export default struct WorkComponent {
// ...
public gridViewManager: GridViewManager = new GridViewManager({ defaultNodeItem: 'video', context: this.getUIContext() });
@State public viewModel: WorkGridViewModel = new WorkGridViewModel(this.gridViewManager);
// ...
public build(): void {
Refresh({ refreshing: $$this.viewModel.isRefresh, builder: this.refreshBuilder() }) {
// ...
// main grid
RecyclerView({
viewManager: this.gridViewManager
});
// ...
}
// ...
.onRefreshing(() => {
this.viewModel.refreshData();
});
};
}; @Observed
export default class WorkGridViewModel {
// ...
@Track public isRefresh: boolean = false;
// ...
public gridViewManager?: GridManager;
constructor(gridViewManager: GridManager) {
this.gridViewManager = gridViewManager;
}
public loadData(): void {
// ...
// refresh data source
this.gridViewManager?.nodeAdapter.deleteData(0, lastLength);
this.gridViewManager?.setDataSource(this.data);
}
/**
* refresh display data
*/
public refreshData(): void {
setTimeout(() => {
this.loadData();
this.isRefresh = false;
}, 1000);
}
// ...
} 当开发网格页面涉及大量数据,需要进行分页或分批次进行请求时,结合ScrollComponents提供的懒加载能力实现加载更多的效果。效果参考:Refresh示例6实现下拉刷新上拉加载更多。
@Component
export default struct WorkComponent {
// ...
public gridViewManager: GridViewManager = new GridViewManager({ defaultNodeItem: 'video', context: this.getUIContext() });
@State public viewModel: WorkGridViewModel = new WorkGridViewModel(this.gridViewManager);
// ...
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.onReachEnd(() => {
// listen the scroll position.
this.viewModel.loadMore();
});
// ...
}
// ...
}; @Observed
export default class WorkGridViewModel {
// ...
@Track public isLoading: boolean = false;
public gridViewManager?: GridManager;
// ...
/**
* mock load more data when reach end
*/
public loadMore(): void {
if (this.worksCount <= this.data.length) {
return;
}
this.isLoading = true;
setTimeout(() => {
if (this.worksCount > this.data.length) {
for (let index = 0; index < 20; index++) {
if (this.data.length < this.worksCount) {
this.gridViewManager?.nodeAdapter.pushData([this.generateData()]);
this.isLoading = false;
}
}
}
this.isLoading = false;
}, 500);
}
// ...
/**
* generate mock Work
*
* @returns work data
*/
public generateData(): WorkViewModel {
// ...
}
} public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.columnsTemplate(this.viewModel.columnsTemplate);
// ...
} public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.layoutDirection(GridDirection.Row);
// ...
} 在单元格组件中添加文本组件进行数据显示。
// item component
@Component
export default struct WordCell {
@State word: WordViewModel = new WordViewModel();
public aboutToReuse(params: Record<string, ESObject>): void {
let input = params as WordCellData;
this.word = input.word;
}
public build(): void {
// ...
// define a text component that displays data in a cell after receiving it.
Text(this.word.value)
.height('15%');
// ...
};
}; 分别设置columnsGap和rowsGap为8vp。
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.columnsGap(8) // set column spacing to 8vp.
.rowsGap(8); // set row spacing to 8vp.
// ...
} 通过columnsTemplate设置网格为三列等份网格。
public aboutToAppear(): void {
// ...
// only set the columnsTemplate property. when the content exceeds the grid area, it can be scrolled vertically.
this.gridViewManager.setViewStyle()
.columnsTemplate('1fr 1fr 1fr');
// ...
} // card grid view
@Component
export default struct CardGridComponent {
public scroller: Scroller = new Scroller();
public gridViewManager: GridViewManager = new GridViewManager({ defaultNodeItem: 'card', context: this.getUIContext() });
@State public viewModel: CardGridViewModel = new CardGridViewModel(this.gridViewManager, this.scroller);
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle(this.scroller);
// ...
}
// ...
public build(): void {
Stack({ alignContent: Alignment.Bottom }) {
// main grid
RecyclerView({
viewManager: this.gridViewManager
});
Row() {
// button goto pre page
Button() {
// ...
}
// ...
.onClick(() => {
this.viewModel.prePage();
});
// button goto next page
Button() {
// ...
}
// ...
.onClick(() => {
this.viewModel.nextPage();
});
}
// ...
};
};
}; @Observed
export default class CardGridViewModel {
// ...
public gridViewManager?: GridManager;
public scroller?: Scroller;
constructor(gridViewManager: GridManager, scroller: Scroller) {
this.gridViewManager = gridViewManager;
this.scroller = scroller;
}
// ...
/**
* goto pre page
*/
public prePage(): void {
this.scroller?.scrollPage({
next: false,
animation: true
});
}
/**
* goto next page.
*/
public nextPage(): void {
this.scroller?.scrollPage({
next: true,
animation: true
});
}
} 通过nestedScroll设置前后两个方向的嵌套滚动模式,实现与父组件的滚动联动。
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle(this.scroller)
.nestedScroll({
scrollForward: NestedScrollMode.PARENT_FIRST,
scrollBackward: NestedScrollMode.SELF_FIRST
});
// ...
} @Component
export default struct WorkComponent {
// ...
@State public workModel: WorkViewModel = new WorkViewModel();
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.editMode(true)
.onItemDragStart((event: ItemDragInfo, itemIndex: number) => {
let model = this.viewModel.getItemData(itemIndex);
this.workModel = model;
return this.buildDrag();
})
.onItemDrop((event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => {
if (!isSuccess) {
return;
}
this.viewModel.move(itemIndex, insertIndex);
});
// ...
}
@Builder
buildDrag() {
Column() {
buildVideoWork({ work: this.workModel });
}
.width(125);
}
// ...
}; @Observed
export default class WorkGridViewModel {
// ...
public gridViewManager?: GridManager;
// ...
/**
* move work index
*
* @param fromIndex source index
* @param toIndex target index
*/
public move(fromIndex: number, toIndex: number): void {
if (toIndex >= this.data.length) {
return;
}
this.gridViewManager?.nodeAdapter.moveData(fromIndex, toIndex);
}
// ...
} 通过layoutDirection、maxCount、minCount、cellLength实现自适应效果。rowsTemplate、columnsTemplate都不设置layoutDirection、maxCount、minCount、cellLength才生效。效果参考:示例6自适应grid。
通过设置maxCount、minCount、cellLength实现自适应。
public aboutToAppear(): void {
this.gridViewManager.setViewStyle()
.width('90%')
.columnsGap(10)
.rowsGap(5)
.maxCount(10)
.minCount(2)
.cellLength(0)
.border({ color: Color.Black, width: 1 });
// ...
} 通过设置columnsTemplate为repeat(auto-fill, 70)实现自适应列数。
aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.columnsTemplate('repeat(auto-fill, 70)')
.columnsGap(5)
.rowsGap(5);
// ...
} 设置alignItems为GridItemAlignment.STRETCH时,以当前行最高的单元格高度为其他单元格的高度。
aboutToAppear(): void {
this.gridViewManager.setViewStyle()
.alignItems(GridItemAlignment.STRETCH);
// ...
} 开启边缘渐隐,并设置边缘渐隐长度为40vp。
public aboutToAppear(): void {
// ...
this.gridViewManager.setViewStyle()
.fadingEdge(true, { fadingEdgeLength: LengthMetrics.vp(40) });
// ...
} 可以使用gridViewManager.setItemViewStyle()接口设置单元格样式。效果参考:示例2设置griditem样式示例2设置griditem样式示例2设置griditem样式。
使用gridViewManager.setItemViewStyle()设置单元格样式和属性。
public aboutToAppear(): void {
// ...
this.gridViewManager.setItemViewStyle((gridItem) => {
gridItem({ style: GridItemStyle.PLAIN })
.width(80) // set the cell width to 80vp.
.backgroundColor($r('app.color.home_background_color'))
.selectable(false);
});
// ...
} // item component
@Component
export default struct CardComponent {
@State user: UserInfoViewModel = new UserInfoViewModel();
// ...
@Builder
optMenu() {
Row() {
Button() {
// ...
}
.backgroundColor(Color.Red)
.onClick(() => {
this.getUIContext().getHostContext()?.eventHub.emit(CommonConstants.EVENT_REMOVE_ITEM, this.user.id);
});
}
// ...
}
build() {
Column() {
// ...
}
.bindContextMenu(this.optMenu(), ResponseType.LongPress)
// ...
};
}; public aboutToAppear(): void {
// ...
// register 'delete' event listener.
this.getUIContext().getHostContext()?.eventHub.on(CommonConstants.EVENT_REMOVE_ITEM, (id: number) => {
animateToImmediately({ duration: 500 }, () => {
this.viewModel.deleteData(id);
});
});
// ...
}
public aboutToDisappear(): void {
// when the page is destroyed, cancel the deletion listener.
this.getUIContext().getHostContext()?.eventHub.off(CommonConstants.EVENT_REMOVE_ITEM);
this.viewModel.destroy();
} /**
* delete data by user id
*
* @param id user id
*/
public deleteData(id: number): void {
for (let index = 0; index < this.data.length; index++) {
let model = this.data[index];
if (model.id === id) {
// delete components and data
this.gridViewManager?.nodeAdapter.deleteData(index);
return;
}
}
}