React虛擬渲染實現50個或者一百個圖表渲染

Posted on by

前言

最近有個需求，一個頁面上要渲染50個或者100個圖表，把功能實現後，頁面太卡瞭。之前用過虛擬渲染能解決此類的問題，但用的都是別人寫好的庫，想瞭想，自己實現也並不復雜，於是決定自己實現一下。

需求

每行渲染3個圖表，右上角的切換可以有50個，100個，或者更多。 

方案

虛擬列表其實就是對可視區域做渲染。對不可見的內容不渲染或者預渲染一部分，預渲染一部分，可以減少白屏的內容

我們從上面的圖可以看到

  • 可視區域就是我們能看到的內容
  • 真實列表的長度 整個元素內容所占的高度
  • 邊框為實線的Item 真正渲染的內容
  • 預渲染內容 為瞭防止白屏，提前渲染幾條數據

實現

假如現在有 90 條數據，可以區域內容隻能顯示3條

實現虛擬渲染，有關鍵幾個變量我們說下。

  • preload 預加載的條數，指的是我們上邊圖的預渲染內容
  • itemHeight列表每一項的高度
  • scrollTop 可視區滾動條的高度
  • screenHeight 可視區域的高度
  • visibleCount 可視區域可以看到的條數。

公式 Math.ceil(screenHeight / itemHeight);

start列表當中開始的索引。

公式 start = Math.floor(((scrollTop + screenHeight) / itemHeight)) – preload;

註意：邊界的判斷 

start = start < 0 ? 0 : start;

end 列表當中結束的索引

公式 end = start + visibleCount + preload;

註意：邊界的判斷 

end = end > data.length ? data.length : end;

VirtualScroll 組件實現

import React, { useRef, useState, useEffect } from 'react';
import { requestTimeout, cancelTimeout } from '../../utils/timer';
import styles from './index.less';
const VirtualScroll = ({ data, itemHeight, preload = 1, renderItem }) => {
  const [v, setUpdateValue] = useState(0); // 用來更新組件
  const containerRef = useRef(null);
  const resetIsScrollingTimeoutId = useRef(null);
  /**
  * 可視區域滾動事件
  * 防抖處理
  */
  const onScroll = (e) => {
    if (resetIsScrollingTimeoutId.current !== null) {
      cancelTimeout(resetIsScrollingTimeoutId.current);
    }
    resetIsScrollingTimeoutId.current = requestTimeout(
      () => { setUpdateValue(val => (val + 1)); },
      150
    );
  }
  useEffect(() => {
    if (containerRef.current) {
      setUpdateValue(val => (val + 1));
    }
  }, [containerRef.current])
  if (!containerRef.current) {
    return <div className={styles.container} ref={containerRef}></div>;
  }
  let start = 0; // 開始的索引
  let end = 0; // 結束索引
  // const screenHeight = 300;
  const { scrollTop, offsetHeight: screenHeight } = containerRef.current;
  const visibleCount = Math.ceil((screenHeight / itemHeight)); // 顯示的數量
  start = Math.floor(((scrollTop + screenHeight) / itemHeight)) - preload; // 開始的索引
  start = start < 0 ? 0 : start; // 判斷邊界
  end = start + visibleCount + preload; //
  end = end > data.length ? data.length : end; // 判斷結束邊界
  const visibleData = data.map((item, index) => {
    item.index = index;
    return item;
  }).slice(start, end);
  /**
  * ${data.length * itemHeight}px 容器的總高度
  * ${ item.index * itemHeight}px 沒個元素的高度
  */
  return (
    <div className={styles.container} ref={containerRef} onScroll={onScroll}>
      <div style={{ width: '100%', height: `${data.length * itemHeight}px`, }}>
        {
          visibleData?.map((item, index) => {
            return <div key={item.index} style={{ position: 'absolute', width: '100%', height: `${itemHeight}px`, top: `${ item.index * itemHeight}px`}}>
              {renderItem(item)}
            </div>
          })
        }
      </div>
    </div>
  );
}
export default VirtualScroll;

接著我們看下timer工具方法，主要是有個防抖操作參考 react-window

const now = () => Date.now();
export function cancelTimeout(timeoutID) {
  cancelAnimationFrame(timeoutID.id);
}
export function requestTimeout(callback, delay) {
  const start = now();
  function tick() {
    if (now() - start >= delay) {
      callback.call(null);
    } else {
      timeoutID.id = requestAnimationFrame(tick);
    }
  }
  const timeoutID = {
    id: requestAnimationFrame(tick),
  };
  return timeoutID;
}

這裡我們看到用瞭requestAnimationFrame.它告訴瀏覽器——你希望執行一個動畫，並且要求瀏覽器在下次重繪之前調用指定的回調函數更新動畫。該方法需要傳入一個回調函數作為參數，該回調函數會在瀏覽器下一次重繪之前執行。回調函數執行次數通常是每秒60次

使用

import React from 'react';
import { FullScreenBox, VirtualScroll } from '../../../components';
import { BarChart } from 'charts';
import { Row, Col, Select } from 'antd';
//造數據
let eventRateData = [];
for (let index = 0; index < 60; index++) {
  const d = [
    { x: 'text', y: 3.0, itemType: null, count: 0 },
    { x: 'asdasdzzzcv', y: 1.0, itemType: null, count: 0 },
  ];
  d.cacheIndex = index + 1;
  eventRateData.push(d)
}
// 對數據進行分組，每組有3條chart數據
function arrayGroup(arr, count = 3) {
  const arrResult = [];
  let begin = 0;
  let end = count;
  for (let i = 0; i < Math.ceil(arr.length / count); i++) {
    const splitArr = arr.slice(begin, end);
    arrResult.push(splitArr);
    begin = end;
    end = end + count;
  }
  return arrResult;
}
function Chart({ data }) {
  return <BarChart data={data} height={200} title alias={['數據集名稱', '引用次數']} />
}
const EventView = props => {
  const [state, setState] = useImmer({
    count: 20
  })
  let data = eventRateData.slice(0, state.count);
  data = arrayGroup(data, 3);
  const renderItem = (item) => {
    return <Row>
      {
        item.map(child => {
          return <Col span={8} style={{ height: '200px' }}>
            <Chart data={child} title alias={['數據集名稱', '引用次數']} />
          </Col>
        })
      }
    </Row>
  }
  return (
      <VirtualScroll
        renderItem={renderItem}
        data={data}
        itemHeight={200}
        preload={3}
      >
      </VirtualScroll>
  );
}
export default EventView;

通過以上內容，我們實現瞭虛擬滾動。

結束語

我們實現瞭固定高度的虛擬滾動，如果元素內容高度不固定，我們還需要動態獲取高度。這塊內容後續我們也實現一下，更多關於React虛擬渲染的資料請關註WalkonNet其它相關文章！

推薦閱讀：