本文旨在指导开发者如何在 React 项目中使用 AG Grid 实现无限滚动功能。通过配置服务端数据源，当用户滚动到表格底部时，自动向后端 API 请求数据并追加到现有数据中，从而实现高性能的虚拟化加载，避免一次性加载大量数据造成的性能问题。本文将详细介绍 onGridReady 方法中服务端数据源的配置，以及 getRows 方法的具体实现，并提供示例代码。
AG Grid 无限滚动实现
AG Grid 提供了强大的无限滚动功能，允许你在表格中加载大量数据，而无需一次性将所有数据加载到客户端。这对于处理大型数据集，例如从数据库中检索数据时，非常有用。核心在于配置 AG Grid 的服务端数据源，使得表格在需要时才从服务器获取数据。
配置服务端数据源
首先，需要在 AG Grid 的配置项中指定 onGridReady 方法。这个方法会在 AG Grid 初始化完成后被调用。在这个方法中，你需要设置服务端数据源。
import React, { useRef, useEffect } from 'react';
import { AgGridReact } from 'ag-grid-react';
import 'ag-grid-community/styles/ag-grid.css';
import 'ag-grid-community/styles/ag-theme-alpine.css';
function MyGrid() {
const gridRef = useRef(null);
const onGridReady = (params) => {
const api = params.api;
const getRows = (params) => {
// 在这里实现数据获取逻辑
getData(params);
};
api.setServerSideDatasource({ getRows });
};
const getData = (params) => {
// 模拟API请求
setTimeout(() => {
const startRow = params.request.startRow;
const endRow = params.request.endRow;
// 假设你的API返回一个包含数据和总记录数的对象
const result = fetchMyData(startRow, endRow);
params.successCallback(result.rows, result.lastRow);
}, 500);
};
const fetchMyData = (startRow, endRow) => {
// 实际的API请求应该在这里实现
// 这里只是一个模拟
const pageSize = endRow - startRow;
const rows = Array.from({ length: pageSize }, (_, i) => ({
id: startRow + i,
value: `Row ${startRow + i}`
}));
const totalRows = 1000; // 假设总共有 1000 行数据
return {
rows: rows,
lastRow: totalRows
};
};
const columnDefs = [
{ headerName: 'ID', field: 'id' },
{ headerName: 'Value', field: 'value' }
];
return (
<div className="ag-theme-alpine" style={{ height: 400, width: 600 }}>
<AgGridReact
ref={gridRef}
columnDefs={columnDefs}
rowModelType="serverSide"
serverSideInfiniteScroll={true}
onGridReady={onGridReady}
cacheBlockSize={10} // 设置缓存块大小
maxBlocksInCache={2} // 设置缓存中的最大块数
/>
</div>
);
}
export default MyGrid;代码解释：
- onGridReady: 当 AG Grid 初始化完成后调用。在这个函数中，我们获取 AG Grid 的 API 实例，并设置服务端数据源。
- api.setServerSideDatasource({ getRows }): 这行代码是关键，它告诉 AG Grid 使用服务端数据源，并指定 getRows 函数来获取数据。
- getData: 这个函数模拟了从服务器获取数据的过程。它接收一个 params 对象，其中包含请求的信息，例如起始行和结束行。
- params.successCallback(data, data.lastRow): 在成功获取数据后，调用 successCallback 函数，将数据和总记录数传递给 AG Grid。data 是当前请求的数据，data.lastRow 是数据集中总记录数。AG Grid 根据这个值来判断是否还有更多数据可以加载。
- rowModelType="serverSide": 设置 AG Grid 使用服务端行模型。
- serverSideInfiniteScroll={true}: 启用服务端无限滚动。
- cacheBlockSize={10}: 设置每次请求的记录数，也就是缓存块大小。
- maxBlocksInCache={2}: 设置缓存中的最大块数。
实现 getRows 方法
getRows 方法是服务端数据源的核心。它负责接收 AG Grid 的请求，从服务器获取数据，并将数据返回给 AG Grid。
getRows(params) {
const request = {
startRow: params.request.startRow,
endRow: params.request.endRow,
filterModel: params.request.filterModel,
sortModel: params.request.sortModel
};
// 调用你的 API 获取数据
this.getData(request)
.then(({ data, total }) => {
// 成功获取数据，调用 successCallback
params.successCallback(data, total);
})
.catch(() => {
// 获取数据失败，调用 failCallback
params.failCallback();
});
}代码解释：
- params.request: params 对象包含一个 request 属性，其中包含了 AG Grid 发送的请求信息，例如起始行 (startRow)、结束行 (endRow)、过滤条件 (filterModel) 和排序条件 (sortModel)。
- this.getData(request): 调用你的 API 获取数据。你需要根据 request 中的信息来构建 API 请求。
- params.successCallback(data, total): 在成功获取数据后，调用 successCallback 函数，将数据和总记录数传递给 AG Grid。data 是当前请求的数据，total 是数据集中总记录数。
- params.failCallback(): 如果获取数据失败，调用 failCallback 函数。
注意事项
- 总记录数： 确保 successCallback 函数中的第二个参数（总记录数）正确。AG Grid 使用这个值来判断是否还有更多数据可以加载。
- 排序和过滤： 如果你的表格支持排序和过滤，你需要确保 getRows 方法能够处理这些请求。你需要将 params.request.filterModel 和 params.request.sortModel 传递给你的 API，并根据这些信息来过滤和排序数据。
- 性能优化： 无限滚动可以提高表格的性能，但仍然需要注意性能优化。例如，你可以使用缓存来减少 API 请求的次数。
- 错误处理： 在 getRows 方法中，要处理 API 请求失败的情况，并调用 params.failCallback() 函数。
总结
通过配置 AG Grid 的服务端数据源，可以轻松实现无限滚动功能，从而提高表格的性能。关键在于正确配置 onGridReady 方法和实现 getRows 方法。同时，需要注意总记录数、排序和过滤、性能优化和错误处理等方面。希望本文能够帮助你更好地理解和使用 AG Grid 的无限滚动功能。
