pdf预览：如何优雅地击败内存泄漏

站长

2024年04月21日 10:55 · 阅读数 1

作者简介：大家好，我是文艺理科生Owen，某车企前端开发，负责AIGC+RAG项目

目前在卷的技术方向：工程化系列，主要偏向最佳实践

希望可以在评论区交流互动，感谢支持~~~

最近项目中有个内嵌预览pdf文件的需求，考虑到vue3项目，所以决定使用 vue-pdf-embed 快速实现预览功能。

说干就干，先来个demo~

为了复现项目真实环境，demo分为前端和服务端两部分。前端负责请求获取对应页的pdf文件流和渲染。服务端负责原文件按页拆分，并接受请求返回对应页的pdf文件流。

服务端项目搭建

服务端依赖选型如下：

依赖名称	作用
express	快速、简洁且灵活的Web应用开发框架
pdf-lib	创建和修改PDF文档

新建文件夹node-pdf-demo，安装 express 和 pdf-lib。运行 pnpm i express pdf-lib。
在根目录下准备一个pdf文件，示例中为 book.pdf。
分别新建两个文件：split.js用来拆分原文件，server.js用来封装接口。
split.js代码如下。简单来说，就是将原文档通过pdf-lib读入，拷贝每一页到新的子文档实例中，并写入磁盘中。根目录下运行node split.js。然后根目录下会有14个pdf文件了，分别对应原文档的1-14页。

// split.js
const fs = require('fs')
const PDFDocument = require('pdf-lib').PDFDocument;

(async function() {
  // 原文件路径
  const pdfPath = 'book.pdf'
  // 生成每一页的pdf文件
  const docmentAsBytes = fs.readFileSync(pdfPath);
  // 加载pdf文件流
  const pdfDoc = await PDFDocument.load(docmentAsBytes)
  const numberOfPages = pdfDoc.getPages().length;
  for (let i = 0; i < numberOfPages; i++) {
    // 创建一个子文档实例对象
    const subDocument = await PDFDocument.create();
    // 拷贝对应页的文件流
    const [copiedPage] = await subDocument.copyPages(pdfDoc, [i])
    // 将拷贝的结果保存在刚创建的子文档实例对象中
    subDocument.addPage(copiedPage);
    // 保存子文档实例对象
    const pdfBytes = await subDocument.save()
    // 将子文档实例对象写入磁盘中，以文件形式存放在根目录下
    await writePdfBytesToFile(`file-${i + 1}.pdf`, pdfBytes);
  }
})()

// 将字节流写入磁盘中
async function writePdfBytesToFile(fileName, pdfBytes) {
  return fs.promises.writeFile(fileName, pdfBytes);
}

server.js代码如下。需要重点关注的是 app，是express的实例对象。通过它，可以处理http请求，即后端封装的接口。

const fs = require('fs')
const express = require('express')
const app = express()

// 获取某一页的pdf文件流
app.get('/pdf/:page', async (req, res) => {
  // 读入请求参数对应页码的文件流
  const pdf = fs.readFileSync(`file-${+req.params.page}.pdf`)
  // 将文件页码总数写入到header中，返回给前端
  res.setHeader('totalPage', 14)
  // 返回文件流 
  res.send(pdf)
})

// 启动服务器
app.listen(3000, () => {
  console.log(`Server running on port 3000`);
});

运行node server.js，命令行输出 Server running on port 3000，说明服务端启动完成。

pdf预览：如何优雅地击败内存泄漏

前端项目搭建

快速生成项目：pnpm create vite vue3-pdf-demo --template vue
运行： cd vue3-pdf-demo pnpm install pnpm run dev
项目启动完成(文案稍微修改了下~)：

pdf预览：如何优雅地击败内存泄漏

安装依赖 pnpm i vue-pdf-embed, 启动项目 pnpm dev。
在 components下新建一个vue文件，命名为PdfPreview.vue，我们在这个文件中编写pdf预览组件。代码如下：

<template>
  <div class="container">
    <div class="pdf-box">
      <VuePdfEmbed annotationLayer textLayer
        @rendering-failed="handleRenderFailed" :source="doc" 
        class="vue-pdf-embed" />
    </div>
    <div class="operation">
      <button @click="handleClick('prev')">&lt;</button>
      <span>{{ pageNum }}/{{ pageTotalNum }}</span>
      <button @click="handleClick('next')">&gt;</button>
    </div>
  </div>
</template>

<script setup lang="ts">
import { ref, onMounted, watch, nextTick } from 'vue';
import VuePdfEmbed, { useVuePdfEmbed } from 'vue-pdf-embed';

// essential styles
import 'vue-pdf-embed/dist/style/index.css'

// optional styles
import 'vue-pdf-embed/dist/style/annotationLayer.css'
import 'vue-pdf-embed/dist/style/textLayer.css'
import axios from 'axios'

onMounted(() => {
  request()
})

const pageTotalNum = ref(0); // 总页数
const pageNum = ref(1)
const pdfSource = ref('')

// 用来排查展示失败错误
const handleRenderFailed = (err) => {
  console.log(err, 'err');
}

// 请求获取pdf对应页码的文件流，并转为url
const request = async () => {
  pdfSource.value = ''
  axios.get(`/pdf/${pageNum.value}`, {
    responseType: 'blob'
  }).then(res => {
    pageTotalNum.value = +res.headers.totalpage
    const blob = window.URL.createObjectURL(new Blob([res.data], { type: 'application/pdf' }))
    pdfSource.value = blob
  })
}

const handleClick = (type: string) => {
  if (type === 'prev') {
    pageNum.value--
  } else if (type === 'next') {
    pageNum.value++
  }
  if (pageNum.value <= 0) {
    pageNum.value = pageTotalNum.value
  } else if (pageNum.value > pageTotalNum.value) {
    pageNum.value = 1
  }
  window.URL.revokeObjectURL(pdfSource.value)
  nextTick(() => {
    request()
  })


}
const { doc } = useVuePdfEmbed({
  source: pdfSource
})

// watch(() => pageNum.value, () => {
//   doc.value?.destroy()
// }, {
//   immediate: true
// })
</script>

<style scoped lang="scss">
.container {
  width: 500px;
  background-color: #999;

  .pdf-box {
    width: 100%;
    height: 100%;
  }
}

.operation {
  display: flex;
  justify-content: center;
  align-items: center;
  span {
    width: 50px;
    text-align: center;
  }
}

button {
  width: 50px;
  height: 50px;
}
</style>

在组件中，通过axios请求获取对应页码的文件流，返回类型是blob二进制流格式。然后通过 window.URL.createObjectURL将blob文件流格式转为url，绑定到vue-pdf-embed组件上的source属性。 pdf预览：如何优雅地击败内存泄漏

在App.vue文件中引用组件，代码如下：

<script setup>
import PdfPreview from './components/PdfPreview.vue'
</script>

<template>
  <div class="app-container">
    <div class="title">
      <h1>Owen Pdf Preview</h1>
      <img src="/src/assets/vue.svg" alt="">
    </div>
    <PdfPreview msg="Owen Pdf Preview" />
  </div>
</template>

<style scoped>
.app-container {
  display: flex;
  justify-content: space-around;
  align-items: center;
  width: 70%;
  margin: 0 auto;
}

.title {
  display: flex;
  flex-direction: column;
  align-items: center;
}

img {
  width: 200px;
  height: 200px;
}
</style>

其实运行到这里就算完成了。

pdf预览：如何优雅地击败内存泄漏

但实际自测中，发现当进行页码切换时，会不断地将url映射的blob文件对象添加到缓存中，浏览器内存会越占越大，导致网页崩溃。

pdf预览：如何优雅地击败内存泄漏

查阅了一些资料，有用的只有这5个。总结下有两种方案：

在onload事件中window.URL.revoke
this.src=''

按照建议尝试后，仍然无效。帖子中的方案都是在原生代码里使用，而在vue3中响应式变量缓存导致无法解决。