一文徹底搞懂前端實現文件預覽(word、excel、pdf、ppt、mp4、圖片、文本)
前言
因為業務需要,很多文件需要在前端實現預覽,今天就來了解一下吧。
Demo地址:https://zhuye1993.github.io/file-view/dist/index.html
實現方案
找了網上的實現方案,效果看起來不錯,放在下面的表格里,里面有一些是可以直接通過npm在vue中引入使用。
文檔格式 | 老的開源組件 | 替代開源組件 |
word(docx) | mammoth | docx-preview(npm) |
powerpoint(pptx) | pptxjs | pptxjs改造開發 |
excel(xlsx) | sheetjs、handsontable | exceljs(npm)、handsontable(npm)(npm) |
pdf(pdf) | pdfjs | pdfjs(npm) |
圖片 | jquery.verySimpleImageViewer | v-viewer(npm) |
docx文件實現前端預覽
代碼實現
- 首先npm i docx-preview
- 引入renderAsync方法
- 將blob數據流傳入方法中,渲染word文檔
import { defaultOptions, renderAsync } from "docx-preview";
renderAsync(buffer, document.getElementById("container"), null,
options: {
className: string = "docx", // 默認和文檔樣式類的類名/前綴
inWrapper: boolean = true, // 啟用圍繞文檔內容渲染包裝器
ignoreWidth: boolean = false, // 禁止頁面渲染寬度
ignoreHeight: boolean = false, // 禁止頁面渲染高度
ignoreFonts: boolean = false, // 禁止字體渲染
breakPages: boolean = true, // 在分頁符上啟用分頁
ignoreLastRenderedPageBreak: boolean = true,//禁用lastRenderedPageBreak元素的分頁
experimental: boolean = false, //啟用實驗性功能(制表符停止計算)
trimXmlDeclaration: boolean = true, //如果為真,xml聲明將在解析之前從xml文檔中刪除
debug: boolean = false, // 啟用額外的日志記錄
}
);
實現效果:
pdf實現前端預覽
代碼實現
- 首先npm i pdfjs-dist
- 設置PDFJS.GlobalWorkerOptions.workerSrc的地址
- 通過PDFJS.getDocument處理pdf數據,返回一個對象pdfDoc
- 通過pdfDoc.getPage單獨獲取第1頁的數據
- 創建一個dom元素,設置元素的畫布屬性
- 通過page.render方法,將數據渲染到畫布上
import * as PDFJS from "pdfjs-dist/legacy/build/pdf";
// 設置pdf.worker.js文件的引入地址
PDFJS.GlobalWorkerOptions.workerSrc = require("pdfjs-dist/legacy/build/pdf.worker.entry.js");
// data是一個ArrayBuffer格式,也是一個buffer流的數據
PDFJS.getDocument(data).promise.then(pdfDoc=>{
const numPages = pdfDoc.numPages; // pdf的總頁數
// 獲取第1頁的數據
pdfDoc.getPage(1).then(page =>{
// 設置canvas相關的屬性
const canvas = document.getElementById("the_canvas");
const ctx = canvas.getContext("2d");
const dpr = window.devicePixelRatio || 1;
const bsr =
ctx.webkitBackingStorePixelRatio ||
ctx.mozBackingStorePixelRatio ||
ctx.msBackingStorePixelRatio ||
ctx.oBackingStorePixelRatio ||
ctx.backingStorePixelRatio ||
1;
const ratio = dpr / bsr;
const viewport = page.getViewport({ scale: 1 });
canvas.width = viewport.width * ratio;
canvas.height = viewport.height * ratio;
canvas.style.width = viewport.width + "px";
canvas.style.height = viewport.height + "px";
ctx.setTransform(ratio, 0, 0, ratio, 0, 0);
const renderContext = {
canvasContext: ctx,
viewport: viewport,
};
// 數據渲染到canvas畫布上
page.render(renderContext);
})
})
實現效果:
excel實現前端預覽
代碼實現
- 下載exceljs、handsontable的庫
- 通過exceljs讀取到文件的數據
- 通過workbook.getWorksheet方法獲取到每一個工作表的數據,將數據處理成一個二維數組的數據
- 引入@handsontable/vue的組件HotTable
- 通過settings屬性,將一些配置參數和二維數組數據傳入組件,渲染成excel樣式,實現預覽
// 加載excel的數據
(new ExcelJS.Workbook().xlsx.load(buffer)).then(workbook=>{
// 獲取excel的第一頁的數據
const ws = workbook.getWorksheet(1);
// 獲取每一行的數據
const data = ws.getRows(1, ws.actualRowCount);
})
// 渲染頁面
import { HotTable } from "@handsontable/vue";
<hot-table :settings="hotSettings"></hot-table>
hotSettings = {
language: "zh-CN",
readOnly: true,
data: this.data,
cell: this.cell,
mergeCells: this.merge,
colHeaders: true,
rowHeaders: true,
height: "calc(100vh - 107px)",
// contextMenu: true,
// manualRowMove: true,
// 關閉外部點擊取消選中時間的行為
outsideClickDeselects: false,
// fillHandle: {
// direction: 'vertical',
// autoInsertRow: true
// },
// afterSelectionEnd: this.afterSelectionEnd,
// bindRowsWithHeaders: 'strict',
licenseKey: "non-commercial-and-evaluation"
}
實現效果
pptx的前端預覽
主要是通過jszip庫,加載二進制文件,再經過一些列處理處理轉換實現預覽效果,實現起來比較麻煩,就不貼代碼了,感興趣的可以下載代碼查看。
實現效果
總結
主要介紹了word、excel、pdf文件實現預覽的方式,前端實現預覽最好的效果還是PDF,不會出現一些文字錯亂和亂碼的問題,所以一般好的方案就是后端配合將不同格式的文件轉換成pdf,再由前端實現預覽效果,將會保留文件的一些樣式的效果,對于圖片、txt文件的實現,感興趣的可以看下代碼。
代碼地址