前端实现文件预览功能

需求：实现一个在线预览pdf、excel、word、图片等文件的功能。
介绍：支持pdf、xlsx、docx、jpg、png、jpeg。
以下使用Vue3代码实现所有功能，建议以下的预览文件标签可以在外层包裹一层弹窗。

图片预览

iframe标签能够将另一个HTML页面嵌入到当前页面中，我们的图片也能够使用iframe标签来进行展示。

<iframe  :src="图片地址"
         style="z-index: 1000; height:650px; width: 100%; margin: 0 auto"
         sandbox="allow-scripts allow-top-navigation allow-same-origin allow-popups"
/>

sandbox 这个属性如果是单纯预览图片可以不使用，该属性对呈现在 iframe 框架中的内容启用一些额外的限制条件。属性值可以为空字符串（这种情况下会启用所有限制），也可以是用空格分隔的一系列指定的字符串。

word文档预览（docx）

先下载npm包
npm i docx-preview --save

<div class="docxRef"></div>

<script>
import { renderAsync } from 'docx-preview';

function fn() {
// 这里的res.data是 blob文件流，如果自己的不是blob文件流
// 可以通过URL.createObjectURL(参数) 参数为File格式，转换为blob文件流
    let blob = res.data
    let childRef = document.getElementsByClassName('docxRef');
    renderAsync(blob, childRef[0]) //渲染
}
fn()

</script>

blob文件流

预览excel文件(xlsx)

下载包
npm install xlsx@0.16.0

<div class="xlsxClass"></div>
const reader = new FileReader();
//通过readAsArrayBuffer将blob转换为ArrayBuffer对
reader.readAsArrayBuffer(res.data) // 这里的res.data是blob文件流
reader.onload = (event) => {
  // 读取ArrayBuffer数据变成Uint8Array
  var data = new Uint8Array(event.target.result);
  // 这里的data里面的类型和后面的type类型要对应
  var workbook = XLSX.read(data, { type: "array" });
  var sheetNames = workbook.SheetNames; // 工作表名称
  var worksheet = workbook.Sheets[sheetNames[0]];
  // var excelData = XLSX.utils.sheet_to_json(worksheet); //JSON
  let html = XLSX.utils.sheet_to_html(worksheet);
  document.getElementsByClassName('xlsxClass')[0].innerHTML = html
};

pdf预览

下载包 npm install pdfjs-dist
我使用的是npm install pdfjs-dist@2.0.943版本，以下例子使用的是vue3+vite创建的项目
以下例子通过canvas来渲染pdf

<template>
  <div class="box">
    <div class="tool-bar">
      <div>{{ pdfParams.pageNumber }} / {{ pdfParams.total }}</div>
      <button type="primary" :disabled="pdfParams.pageNumber == pdfParams.total" @click="nextPage">下一页
      </button>
      <button type="primary" :disabled="pdfParams.pageNumber == 1" @click="prevPage">上一页</button>
    </div>
    <canvas id="pdf-render"></canvas>
  </div>
</template>

<script setup>
import { onMounted, ref, reactive } from 'vue'
const pdfParams = reactive({
  pageNumber: 1, // 当前页
  total: 0, // 总页数
});

// 不要定义为ref或reactive格式，就定义为普通的变量
let pdfDoc = null;
// 这里必须使用异步去引用pdf文件，直接去import会报错，也不知道为什么
onMounted(async ()=> {
  let pdfjs = await import('pdfjs-dist/build/pdf')
  let pdfjsWorker = await import('pdfjs-dist/build/pdf.worker.entry')
  pdfjs.GlobalWorkerOptions.workerSrc = pdfjsWorker
  // 此文件位于public/test2.pdf
  let url = ref('/test2.pdf')
  pdfjs.getDocument(url.value).promise.then(doc => {
    pdfDoc = doc
    pdfParams.total = doc.numPages
    getPdfPage(1)
  })
})

// 加载pdf的某一页
const getPdfPage = (number) => {
  pdfDoc.getPage(number).then(page => {
    const viewport = page.getViewport()
    const canvas = document.getElementById('pdf-render')
    const context = canvas.getContext('2d')
    canvas.width = viewport.viewBox[2]
    canvas.height = viewport.viewBox[3]
    viewport.width = viewport.viewBox[2]
    viewport.height = viewport.viewBox[3]
    canvas.style.width = Math.floor(viewport.width) + 'px'
    canvas.style.height = Math.floor(viewport.height) + 'px'

    let renderContext = {
      canvasContext: context,
      viewport: viewport,
      // 这里transform的六个参数，使用的是transform中的Matrix(矩阵)
      transform: [1, 0, 0, -1, 0, viewport.height]
    }
    // 进行渲染
    page.render(renderContext)
  })
}
// 下一页功能
const prevPage = () => {
  if(pdfParams.pageNumber > 1) {
    pdfParams.pageNumber -= 1
  } else {
    pdfParams.pageNumber  = 1
  }
  getPdfPage(pdfParams.pageNumber)
}
// 上一页功能
const nextPage = () => {
  if(pdfParams.pageNumber < pdfParams.total) {
    pdfParams.pageNumber += 1
  } else {
    pdfParams.pageNumber = pdfParams.total
  }
  getPdfPage(pdfParams.pageNumber)
}
</script>

以上注意点:

• 必须异步引用pdf的文件！！！
• pdf演示文件位于public/test2.pdf
• transform: [1, 0, 0, -1, 0, viewport.height],使用了transform中的Matrix(矩阵)
• 下一页和上一页功能都需要重新渲染

原文链接：https://juejin.cn/post/7246609845272395837

头

笔者之前的文章里介绍过一个代码在线编辑预览工具的实现（传送门：快速搭建一个代码在线编辑预览工具），实现了css、html、js的编辑，但是对于demo场景来说，vue单文件也是一个比较好的代码组织方式，至少笔者就经常在写vue项目的同时顺便写写各种demo，但是分享不太方便，因为单文件不能直接运行看效果，基于此，笔者决定在之前的基础上再增加一个vue单文件的编辑及预览功能。

ps.如果没看过之前的文章也没关系，这里简单介绍一下该项目：code-run，基本框架使用的是vue3.x版本， 构建工具使用的是vite，代码编辑器使用的是monaco-editor，基本原理就是把css、js、html拼接成完整的html字符串扔到iframe里进行预览。

另外项目目前存在一些坑：

1.vite不支持使用commonjs模块（笔者尚未找到解决方法，知道的朋友在评论区留个言？）。

2.三方模块目前都放在项目的public文件夹下，作为静态资源按需加载：

另外由于Monaco Editor自带的模块系统和defined/require冲突，导致目前需要手动修改各个三方模块，让它只支持全局对象的方式来使用，比如：

基本思路

想要预览vue单文件，其实就是要想办法转成浏览器能认识的css、js、html。首先想到的是使用vue-loader来转换，但是看了它的文档，发现还是必须要配合webpack才能使用，不过笔者发现了一个配套的模块vue-template-compiler，它提供了一些方法，其中有一个parseComponent方法可以用来解析vue单文件，输出各个部分的内容，输出结构如下：

所以思路就很清晰了：

1.html部分，结构固定为：

<div id="app"></div>

2.css部分，首先判断有没有使用css预处理器，有的话就先使用对应的解析器转换成css，然后再通过style标签插入到页面。

3.js部分，以vue2.x版本为例，我们最终需要生成如下所示的结构：

new Vue({
    el: '#app',
    template: '',// 模板部分内容
    // ...其他选项
})

其他选项就是vue-template-compiler解析出的script.content内容，但是单文件里基本都是export default {}形式的；template选项很简单，就是template.content的内容。

这里的处理思路是通过babel来将export default {}的形式转换成new Vue的形式，然后再添加上el和template两个属性即可，这会通过写一个babel插件来实现。

安装及使用vue-template-compiler

首先vue-template-compiler模块我们也会把它放到public文件夹下，那么它的浏览器使用版本在哪呢？我们可以先安装它：npm i vue-template-compiler，然后在node_modules里找到它，会发现其中有一个文件：

这个就是我们要的，直接把它复制到public文件夹下（当然也要注释掉它的模块导出），然后再把该模块删除即可，之后我们便可以通过全局对象使用它：

// code就是vue单文件内容字符串
let componentData = window.VueTemplateCompiler.parseComponent(code)
// 处理style、script、template三部分的内容，最后生成css字符串、js字符串、html字符串
parseVueComponentData(componentData)

生成html字符串

html部分我们要做的就是写死一个div，用它来挂载vue实例即可：

const parseVueComponentData = async (data) => {
    // html就直接渲染一个挂载vue实例的节点
    let htmlStr = `<div id="app"></div>`

    return {
        html: htmlStr
    }
}

生成css字符串

style部分如果没有使用css预处理器的话那么也很简单，直接返回样式内容即可，否则需要先使用对应的预处理器把它转换成css：

const parseVueComponentData = async (data) => {
    // 编译css
    let cssStr = []
    // vue单文件的style块可以存在多个，所以解析出的styles是个数组
    for(let i = 0; i < data.styles.length; i++) {
        let style = data.styles[i]
        // 如果使用了css预处理器，lang字段不为空
        let preprocessor = style.lang || 'css'
        if (preprocessor !== 'css') {
            // load方法会去加载对应的三方解析模块，详情请阅读上一篇文章
            await load([preprocessor])
        }
        // css方法会使用对应的解析器来解析，可参考之前的文章
        let cssData = await css(preprocessor, style.content)
        // 把解析后的css字符串添加到结果数组里
        cssStr.push(cssData)
    }
    return {
        // 最后把多个style块的css拼接成一个
        css: cssStr.join('\r\n')
    }
}

上面的css会调用对应的css预处理器的解析模块来编译，比如less的处理如下：

const css = (preprocessor, code) => {
    return new Promise((resolve, reject) => {
        switch (preprocessor) {
            case 'css':
                resolve(code)
                break;
            case 'less':
                window.less.render(code)
                    .then((output) => {
                        resolve(output.css)
                    },
                    (error) => {
                        reject(error)
                    });
                break;
        }
    })
}

生成js字符串

script部分的内容我们会使用babel来编译：

const parseVueComponentData = async (data, parseVueScriptPlugin) => {
    // babel编译，通过编写插件来完成对ast的修改
    let jsStr = data.script ? window.Babel.transform(data.script.content, {
        presets: [
            'es2015',
            'es2016',
            'es2017',
        ],
        plugins: [
            // 插件
            parseVue2ScriptPlugin(data)
        ]
    }).code : ''

    return {
        js: jsStr
    }
}

babel插件其实就是一个函数，接收一个babel对象作为参数，然后需要返回一个对象，我们可以在该对象的visitor属性里访问到AST节点，并进行一些修改，visitor中的每个函数都接收2个参数：path 和 state，path表示两个节点之间连接的对象，包含节点信息及一些操作方法，插件开发的详细文档请参考：plugin-handbook。

基本结构如下：

const parseVue2ScriptPlugin = (data) => {
    return function (babel) {
        let t = babel.types
        return {
            visitor: {

            }
        }
    }
}

转换export default语法

接下来再次明确我们的需求，我们要把export default {}的形式转换成new Vue的形式，具体怎么做呢，我们可以使用astexplorer这个工具先看看这两种结构的AST的差别是什么：

可以发现黄色部分都是一样的，只是外层的节点不一样，所以我们可以访问ExportDefaultDeclaration节点，然后把它替换成ExpressionStatement就行了，创建新节点也很简单，参考AST及babel-types