5、【最终篇】前端页面如何优雅的显示PDF:虚拟滚动

推荐阅读

上节回顾

以上4节我们完成了PDF的预览,和基本功能的实现,前端渲染PDF的原理就是为每一页数据添加canvas,如果要渲染页面的文字就会在 canvas 同级添加一个 div 显示文本信息,如果pdf文件页数特别多的时候,就会重复操作以上操作,导致浏览器的回流和重绘。这就会造成性能浪费,导致页面卡顿。可以自己找一个几千页的PDF文件感受一下。

有了以上的分析,我们就知道改如何优化PDF渲染,我们假设页面上面有一个列表,列表里面每一个元素都保存着pdf页面信息和文本信息,那么我们的优化就从 pdf 大文件优化转化成了前端页面长列表优化。

如果是优化长列表,我们能列举出好多优化方案:懒加载,虚拟滚动。我们这节就用虚拟滚动优化PDF大文件 使用的依赖包是 react-virtualized

react-virtualized

List: 用法很简单,我们本节只列举出我们必要的一些属性

  • width

列表的宽度约束,定义 pdf 视图的宽度

  • height

列表的高度约束,定义 pdf 视图的宽度,如果超过这个高度都不进行 render,只做虚拟的dom

  • rowHeight

行高,列表元素的高度,可以是一个数字类型或者是一个函数根据索引动态的获取每一个元素的高度

  • rowCount

当前列表的元素总数

  • rowRenderer

每行要渲染的内容

  • overscanRowCount

在列表的可见范围之上/之下呈现的行数。这可以帮助减少在某些浏览器/设备上滚动时的闪烁

  • scrollToAlignment

控制滚动到行的对齐方式 ('auto','start', 'end','center')

  • scrollToIndex

滚动到行的索引,可以根据这个属性进行PDF的翻页

  • onRowsRendered

使用有关刚刚渲染的行的信息调用回调,滚动的时候可以得到的信息{ overscanStartIndex, overscanStopIndex, startIndex:, stopIndex },在这个函数里,我们能够动态的渲染页面,每次只渲染一个页面。

假如说,dom 中渲染的列表索引是 5 6 7 8 9

  1. overscanStartIndex dom 显示所列表的最上面索引 5
  2. overscanStopIndex dom 显示所列表的最下面索引 9
  3. startIndex: 当前渲染的列表索引
  4. stopIndex: 下一个需要渲染的索引

*更多内容请参考gitHub: https://github.com/bvaughn/react-virtualized

开始编码

  • 安装并使用
yarn add react-virtualized

import { List as VList } from 'react-virtualized';
  • 动态渲染页面

PDF 文件每一页的宽和高都是不一样的所以我们需要一个数组保存文件的每一页数据

const getPageInfo = async (curPdf) => {
    const page = await curPdf.getPage(1);
    const viewport = page.getViewport({ scale: scale * devicePixelRatio });
    const width = viewport.width;
    const height = viewport.height;
    const array = []
    for (let index = 0; index < curPdf.numPages; index++) {
        array.push({ width, height })
    }
    setNumPages(array)
}

通过 getPage 函数获取每一个的信息,这里我们只保存第一页的信息,在滚动的时候动态的修改这个数组,保证每一页的数据都是准确的。

根据 react-virtualized List 文档我们定义一些属性值,编写如下代码

<VList
    style={{
        margin: 'auto'
    }}
    overscanRowCount={3}
    scrollToAlignment="start"
    rowCount={numPages?.length}
    width={numPages[0].width}
    height={numPages[0].height}
    rowRenderer={renderItem}
    rowHeight={getItemHeight}
    scrollToIndex={currentPage - 1}
    onRowsRendered={({
        overscanStartIndex,
        overscanStopIndex,
        startIndex,
        stopIndex,
    }) => {
        renderPdf(startIndex, pdf)
        setCurrentPage(stopIndex + 1)
    }}
/>

在 onRowsRendered 函数中,我们在滚动页面的时候,更新当前页码,同样更新渲染当前页面信息

const renderItem = ({ key, index, style }) => (
    <div key={key} style={{ ...style, border: '1px solid #dddddd' }} data-index={index}>
        <canvas
            data-page-number={index + 1}
            style={{ width: style.width, height: style.height }}
        />
        <div
            data-page-number={index + 1}
            className="textLayer"
            style={{ width: style.width, height: style.height }}
        ></div>
    </div>
)

在渲染每一页的内容是,我们定义两个标签,canvas 和 div 分别用来显示 PDF 信息和文本信息。在渲染的时候,通过一下方法,把内容渲染到相应的标签里面

# 渲染 pdf 信息
const canvas = document.querySelector(`canvas[data-page-number='${num + 1}']`);
... 一系列操作(以上4节己经说过)
// Render PDF page into canvas context
const renderContext = {
    canvasContext: context,
    viewport: viewport
};
const renderTask = page.render(renderContext);

# 渲染 文本信息
const textLayerDiv = document.querySelector(`div[data-page-number='${num + 1}']`)
if (textLayerDiv) {
    // 创建新的TextLayerBuilder实例
    const textLayer = new TextLayerBuilder({
        textLayerDiv,
        pageIndex: page.pageIndex,
        viewport,
    });

    textLayer.setTextContent(textContent);

    textLayer.render();
}

相关函数在之前的文章已经说过,就不再多说啦,这里不同的就是渲染到标签的方式不同,之前是通过js创建div,appendChild,插入到dom,这里是先把dom元素渲染出来,通过属性获得dom元素。

  • 实现翻页
    HTML 部分就不再说了,上一节已经说过了,这里只说一下如何实现翻页过程,

PDF 保存的文件页面信息是从第一页开始的,List 把渲染的内容看成一个长列表,索引值是从0 开始的,通过改变属性 scrollToIndex 的索引实现翻页

本节完整代码:https://github.com/LiuSandy/react-pdf-render


到此我们由浅入深的把前端如何优雅的渲染PDF文件都已经讲完了,希望对您有所帮助,欢迎 + VX 公众号【编程琐事】。在 GitHub 给一个 Start 吧!!!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容