首页 > web前端 > js教程 > 正文

AG Grid React 实现无限滚动:服务端数据源配置详解

心靈之曲
发布: 2025-08-19 17:48:25
原创
724人浏览过

ag grid react 实现无限滚动:服务端数据源配置详解

本文旨在指导开发者如何在 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;
登录后复制

代码解释:

来画数字人直播
来画数字人直播

来画数字人自动化直播,无需请真人主播,即可实现24小时直播,无缝衔接各大直播平台。

来画数字人直播 0
查看详情 来画数字人直播
  1. onGridReady: 当 AG Grid 初始化完成后调用。在这个函数中,我们获取 AG Grid 的 API 实例,并设置服务端数据源。
  2. api.setServerSideDatasource({ getRows }): 这行代码是关键,它告诉 AG Grid 使用服务端数据源,并指定 getRows 函数来获取数据。
  3. getData: 这个函数模拟了从服务器获取数据的过程。它接收一个 params 对象,其中包含请求的信息,例如起始行和结束行。
  4. params.successCallback(data, data.lastRow): 在成功获取数据后,调用 successCallback 函数,将数据和总记录数传递给 AG Grid。data 是当前请求的数据,data.lastRow 是数据集中总记录数。AG Grid 根据这个值来判断是否还有更多数据可以加载。
  5. rowModelType="serverSide": 设置 AG Grid 使用服务端行模型。
  6. serverSideInfiniteScroll={true}: 启用服务端无限滚动。
  7. cacheBlockSize={10}: 设置每次请求的记录数,也就是缓存块大小。
  8. 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();
    });
}
登录后复制

代码解释:

  1. params.request: params 对象包含一个 request 属性,其中包含了 AG Grid 发送的请求信息,例如起始行 (startRow)、结束行 (endRow)、过滤条件 (filterModel) 和排序条件 (sortModel)。
  2. this.getData(request): 调用你的 API 获取数据。你需要根据 request 中的信息来构建 API 请求。
  3. params.successCallback(data, total): 在成功获取数据后,调用 successCallback 函数,将数据和总记录数传递给 AG Grid。data 是当前请求的数据,total 是数据集中总记录数。
  4. 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 的无限滚动功能。

以上就是AG Grid React 实现无限滚动:服务端数据源配置详解的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号