在開發過程中要求對 PDF
類型的發票提供 預覽 和 下載 功能,**PDF
** 類型文件的來源又包括 H5 移動端
和 **PC 端
**,而針對這兩個不同端的處理會有些許不同,下文會有所提及。
針對 PDF 預覽
的文章不在少數,但似乎都沒有提及可能遇到的問題,或是提供對應的具體需求場景下如何選擇,因此,本文的核心就是結合實際需求場景下,看看目前各種實現方案到底哪一個更適合,當然希望大家可以在評論區對文中的內容進行斧正,或是提供更優質的方案。
基本要求:
產品要求:
pdf 文件
預覽時的字體要 和 實際文件的 字體保證一致性 9E27229A.gif PDF 預覽 先拋開上面的各種要求,咱們先總結下目前實現 PDF
預覽的幾種常用方式:
借助各種類庫,基于代碼實現預覽 ,如基于 **`pdfjs-dist`** [1] 的包直接基于各個瀏覽器內置的 PDF
預覽插件 ,如 <iframe src="xxx">、<embed src="xxx" >
接下來分別看看以上方案如何實現,以及是否符合上述提供的要求!
<embed> / <iframe>
實現預覽<embed>
標簽<embed>
元素 將外部內容嵌入文檔中的指定位置,此內容由 外部應用程序 或 其他交互式內容源 (如 瀏覽器插件 )提供。
說簡單點,就是使用 <embed>
來展示的資源是完全交由它所在的環境提供的展示功能,即如果當前的應用環境支持這個資源的展示那么就可以正常展示,如果不支持那就無法展示。
使用起來也是非常簡單:
<embed type="application/pdf" :src="pdfUrl" width="800" height="600" /> 復制代碼
多數現代瀏覽器已經棄用并取消了對瀏覽器插件的支持,現在已經不建議使用 <embed>
標簽,但可以使用 <img>、<iframe>、<video>、<audio>
等標簽代替。
<iframe>
標簽基于 <iframe>
的方式和以上差不多,整體效果也一致,這里這就不在額外展示:
<iframe :src="pdfUrl" width="800" height="600" /> 復制代碼
值得注意的是,即便使用的是 <iframe>
但實際展開其內層結構后你會發現:
其內部還是 <embed>
標簽?這是怎么回事,不是說最好不建議使用 <embed>
嗎?
首先來在 **`caniuse`** [2] 查看兼容情況,如下:
我們再找一個不支持 <embed>
的瀏覽器,比如 IE
,來試試效果:
換成 <iframe>
試試,如下:
顯然,<embed>
在不兼容的環境直接無法顯示,而 <iframe>
是能夠正常識別的,只不過 <iframe>
加載的資源無法被 IE
瀏覽器處理,即本質原因是 IE
瀏覽器根本就不支持對類似 PDF
等文件的預覽,比如當嘗試直接在地址欄中輸入 http://127.0.0.1:3000/src/assets/2.pdf
時會得到:
因此,通常情況下當瀏覽器不支持內聯 PDF
時,應該提供一個 PDF
的回退鏈接,即以下載的方式來實現,而這就是 **pdfobject** [3] 做的事情,實際上它的源碼內容比較簡單,核心就是 PDFObject 會檢測瀏覽器對內聯/嵌入 PDF 的支持,如果支持嵌入,則嵌入 PDF,如果瀏覽器不支持嵌入,則不會嵌入 PDF,并提供一個指向 PDF 的回退鏈接 ,例如在 IE
中的表現:
事實上,這其實只是幫我們少寫了一些兼容性的代碼而已,也不一定符合大部分人的場景,在這里提到只是因為其與 <embed>
之間存在的聯系。
vue3-pdfjs 實現預覽 為什么不直接使用 pdfjs-dist
? **pdf.js** [4] 幾個明顯的可吐槽的點:
包名稱不統一,npm
上的包名叫 pdfjs-dist
,然而在 Readme
中自己又稱其為 pdf.js
沒有清晰的文檔作為指引,只能通過其倉庫中的 examples
目錄的內容作為參考 官方示例不夠友好,例如沒有提供 vue/react
等相關的示例 因此,既然已經有基于 vue/react
封裝好的包,這里就直接用來作為演示。
具體使用 安裝和使用過程可參考 **`vue3-pdfjs`** [5] ,具體 Vue3
示例代碼如下:
<script setup lang="ts" >import { onMounted, ref } from 'vue' import { VuePdf, createLoadingTask } from 'vue3-pdfjs/esm' import type { VuePdfPropsType } from 'vue3-pdfjs/components/vue-pdf/vue-pdf-props' // Prop type definitions can also be imported import type { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api' import pdfUrl from './assets/You-Dont-Know-JS.pdf' const pdfSrc = ref<VuePdfPropsType['src' ]>(pdfUrl)const numOfPages = ref(0 ) onMounted(() => { const loadingTask = createLoadingTask(pdfSrc.value) loadingTask.promise.then((pdf: PDFDocumentProxy ) => { numOfPages.value = pdf.numPages }) }) </script> <template> <VuePdf v-for="page in numOfPages" :key="page" :src="pdfSrc" :page="page" / > </template> <style> @import '@/ assets/base.css'; </style> 復制代碼
效果如下:
存在問題 看上去加載正常的 pdf 文檔
似乎沒啥大問題,來試試加載 pdf 發票
看看,但由于實際發票敏感信息較多,這里就不貼出原本的發票內容,直接來看預覽后的發票內容:
顯然整體發票的 內容缺失得非常多 ,雖然某些發票大部分能夠展示,但如 發票抬頭 和 印章 部分可能無法正常顯示等
【注意 】無法顯示完整的內容是因為 pdf.js
是需要一些字體庫的支持,如果 原 PDF 文件
中部分字體沒有匹配到字體庫將無法在 pdf.js
中顯示,而字體庫存放在 cmaps
文件夾下
另外,預覽的字體 和 實際的字體 是 不一致 的,而由于發票的特殊性,對字體的一致性是有較大的要求,畢竟如果同一張發票字體不一致會缺乏 規范性 和 合法性(~~被要求字體一致時的說法
~~) 常見的解決方案:**解決 pdf.js 無法完全顯示 pdf 文件內容的問題** [6] ,實際上還是根據執行環境的錯誤信息進行分析,需要強行修改源碼內容。
Mozilla Firefox(火狐瀏覽器) Mozilla Firefox 內置的 PDF 閱讀器實際就是 pdf.js
,你可以直接用火狐瀏覽器預覽一下 pdf
文件,如下:
并且大多基于 pdf.js
二次封裝的庫 vue-pdf、vue3-pdfjs
等在預覽 pdf
文件的發票時通常無法顯示完整內容,需要或多或少的涉及對源碼的更改,而在 Firefox
中內置的 pdf.js
卻能夠完整的顯示對應的 pdf
文件的內容。
PDF
轉 圖片
實現預覽這種方式應該不用多說了,核心是服務端在響應 pdf
文件時,先轉換成圖片類型再返回,前端直接展示具體圖片內容即可。
具體實現 下面通過用 node
來模擬:
const pdf = require ('pdf-poppler' )const path = require ('path' )const Koa = require ('koa' )const koaStatic = require ('koa-static' )const cors = require ('koa-cors' )const app = new Koa()// 跨域 app.use(cors())// 靜態資源 app.use(koaStatic('./server' ))function getFileName (filePath ) { return filePath .split('/' ) .pop() .replace(/\.[^/.]+$/ , '' ) }function pdf2png (filePath ) { // 獲取文件名 const fileName = getFileName(filePath); const dir = path.dirname(filePath); // 配置參數 const options = { format : 'png' , out_dir : dir, out_prefix : fileName, page : null , } // pdf 轉換 png return pdf .convert(filePath, options) .then((res ) => { console .log('Successfully converted !' ) return `http://127.0.0.1:4000${dir.replace('./server' ,'' )} /${fileName} -1.png` }) .catch((error ) => { console .error(error) }) }// 響應 app.use(async (ctx) => { if (ctx.path.endsWith('/getPdf' )){ const url = await pdf2png('./server/pdf/2.pdf' ) ctx.body = { url } }else { ctx.body = 'hello world!' } }) app.listen(4000 ) 復制代碼
避免踩一些坑 坑一:不推薦 pdf-image
在實現服務端將 pdf
文件轉換成圖片時需要依賴到一些第三方包,一開始使用了 **`pdf-image`** [7] 這個包,但在實際轉換時發生較多的異常錯誤,順著錯誤查看源碼后發現其內部需要依賴一些額外的工具,因為其中需要使用 pdfinfo xxx
相關命令,并且其對應的 `issue` [8] 上也存在著一些類似問題,但都試了試最后還是沒有成功!
因此,更推薦使用 `pdf-poppler` [9] 其中附帶了一個 pdftocairo
的程序可以實現 pdf
到 圖片 的轉換能力,不過它目前版本支持 Windows 和 Mac OS ,如下:
坑二:path.basename not a function
在上述的代碼內容中需要獲取文件的名稱,實際上我們可以簡單直接的使用 Node Api
中 path.basename(path[, suffix])
來達到目的:
但是在程序運行時發生了如下 異常 ,對應的 代碼內容 和 運行結果 如下:
// 配置參數 const options = { format : 'png' , out_dir : dir, out_prefix : path.baseName(filePath, path.extname(filePath)), // 發生異常 page : null , } 復制代碼
這個暫時沒有找到是什么原因,只能自己簡單實現了一個 getFileName
方法用于獲取文件的名稱。
報錯原因 :太依賴編輯器的自動提示,將 basename 輸出成 baseName ,沒錯就是 n 和 N 的區別.
坑三:細節
上述內容通過 koa
啟動模擬業務服務,由于 業務服務(http://127.0.0.1:4000
) 和 應用服務 (http://127.0.0.1:3000
) 間的端口不一致,因此會產生 跨域 ,此時可以通過 koa-cors
來解決,值得注意的是有時候的那個業務服務器重啟時 koa-cors
可能不起作用。
由于響應的內容直接在 koa
通用中間件中返回,因此,如果你需要支持業務服務提供 靜態資源 的訪問能力,就可以通過 koa-static
來實現,值得注意的是,當你通過 koa-static
指定靜態文件資源后,如 **app.use(koaStatic('./static'))
**,此時如果你直接通過 http://127.0.0.1:4000/static/pdf/xxx.png
時,那么會得到 404 Not Found 的錯誤,原因在于 koa-static
是直接把 /static/ 設置成了 根路徑 ,因此正確的訪問路徑為:http://127.0.0.1:4000/pdf/xxx.png
。
效果演示 發票內容不方便展示這里就不直接展示了,只需要關注生成的圖片和路徑即可:
PDF 下載 這里的下載實際不僅指 pdf
的下載,而是客戶端方面所能支持的下載方式,最常見的如下幾種:
a 標簽 ,例如 <a href="xxxx" download="xxx">下載</a>
location.href ,例如 window.location.href = xxx
window.open ,例如 window.open(xxx)
Content-disposition ,例如 Content-disposition:attachment;filename="xxx"
<a>
實現下載<a>
的 download
屬性用于指示瀏覽器 下載 href 指定的 URL ,而不是導航到該資源,通常會提示用戶將其保存為本地文件,如果 download
屬性有指定內容,這個值就會在下載保存過程中作為 預填充的文件名 ,主要是因為如下原因:
這個值可能會通過 Javascript
進行動態修改 或者 Content-Disposition
中指定的 download
屬性優先級高于 a.download
這種應該是大家最熟悉的方式了,但熟悉歸熟悉,還有一些值得注意的點:
非同源的資源 仍需要進行下載,那么可以將其轉換為 **`blob: URL`** [10] 和 **`data: URL`** [11] 形式若 HTTP 響應頭中的 **`Content-Disposition`** [12] 屬性中指定了一個不同的文件名,那么會優先使用 Content-Disposition
中的內容 HTTP 若 HTTP 響應頭中的 **`Content-Disposition`** [13] 被設置為 Content-Disposition='inline'
,那么在 Firefox 中會優先使用 Content-Disposition
的 download
屬性 靜態方式:
<a href="http://127.0.0.1:4000/pdf/2-1.png" download="2.pdf" >下載</a> 復制代碼
動態方式:
function download (url, filename ) { const a = document .createElement("a" ); // 創建 a 標簽 a.href = url; // 下載路徑 a.download = filename; // 下載屬性,文件名 a.style.display = "none" ; // 不可見 document .body.appendChild(a); // 掛載 a.click(); // 觸發點擊事件 document .body.removeChild(a); // 移除 } 復制代碼
Blob 方式
if (reqConf.responseType == 'blob' ) { // 返回文件名 let contentDisposition = config.headers['content-disposition' ]; if (!contentDisposition) { contentDisposition = `;filename=${decodeURI (config.headers.filename)} ` ; } const fileName = window .decodeURI(contentDisposition.split(`filename=` )[1 ]); // 文件類型 const suffix = fileName.split('.' )[1 ]; // 創建 blob 對象 const blob = new Blob([config.data], { type : FileType[suffix], }); const link = document .createElement('a' ); link.style.display = 'none' ; link.href = URL.createObjectURL(blob); // 創建 url 對象 link.download = fileName; // 下載后文件名 document .body.appendChild(link); link.click(); document .body.removeChild(link); // 移除隱藏的 a 標簽 URL.revokeObjectURL(link.href); // 銷毀 url 對象 } 復制代碼
Content-disposition
和 location.href/window.open
實現下載這看似是三種下載方式,但實際上就是一種,而且還是以 Content-disposition
為準。
Content-Disposition
響應頭 指示回復的內容該以何種形式展示,是以 內聯 的形式(即網頁或頁面的一部分)展示,還是以 附件 的形式 下載 并保存到本地,如下:
inline
: 是 默認值 ,表示回復中的消息體會以頁面的一部分或者整個頁面的形式展示Content -Disposition : inline 復制代碼
attachment
: 設置為此值意味著消息體應該被下載到本地,大多數瀏覽器會呈現一個 "保存為" 的對話框,并將 filename
的值預填為下載后的文件名Content-Disposition : attachment ; filename ="filename .jpg " 復制代碼
因此,基于 location.href='xxx'
和 window.open(xxx)
的方式能實現下載就是基于 Content-Disposition: attachment; filename="filename.jpg"
的形式,又或者說是觸發了瀏覽器本身的下載行為,滿足了這個條件,無論是通過 a
標簽跳轉 、location.href 導航 、window.open 打開新頁面 、直接在地址欄上輸入 URL 等都可以實現下載。
H5 移動端的下載 H5
移動端針對于 預覽 操作而言基于以上的方式都是可以實現,但是 下載 操作可就不同了,因為這是要區分場景:
基于 手機瀏覽器 的下載方式和上述提到的內容大致上也是一致的,本質上只要所在的客戶端支持下載那就沒有問題,然而在 微信內置瀏覽器 中你使用常規的下載方式可能達不到預期:
在 Android
中使用常規的下載方式,通常會彈出對話框,詢問你是否需要喚醒 手機瀏覽器 來實現對應資源的下載,部分機型卻不會 在 IOS
中以上方式都 無法實現下載 ,因此通常情況下會打開一個新的 webview
來提供預覽,部分機型在新的頁面中支持 長按屏幕 的方式進行保存操作,但并不是所有機型都支持 本質原因是在 微信內置瀏覽器 中屏蔽任何的 下載鏈接 ,如 APP 的下載鏈接 、普通文件 的下載鏈接 等等。
H5 移動端的下載還能怎么做? 由于這是 微信內置瀏覽器 環境對下載功能的屏蔽,因此 不用再考慮(~~想都不敢想
~~)基于 微信內置瀏覽器 來實現下載功能,轉而應該考慮的是如何實現 間接下載 :
判斷當前是否是屬于 微信內置瀏覽器 ,若是則幫助用戶自動喚起 手機瀏覽器 實現下載,但并不是所有機型都支持 喚起 操作,因此最好是提示使用用戶直接通過 手機瀏覽器 實現下載,為了方便用戶,可以實現 一鍵復制 的功能進行輔助 另一種就直接提示只支持 PC
端下載 ,放棄對移動端的下載操作 BD272F44.gif 最后 綜上所述,實際在實現 pdf
預覽的過程中可能暫時沒有辦法達到完美的方式,特別是針對類似 發票類 的 pdf
文件,仍存在如下的問題:
無法保證 pdf
預覽 時,預覽的字體和實際發票 字體 保持一致 現有大部分的預覽方式都基于 pdf.js
的方式實現,而 pdf.js
內部通過 PDFJs.getDocument(url/buffer)
的方式基于 文件地址 或 數據流 來獲取內容,再通過 canvas
處理渲染 pdf
文件,感興趣可以去研究 pdf.js
源碼。
pdf.js
帶來相關問題就是如果對應的 pdf
文件中包含了 pdf.js
中不存在的字體,那么就無法完整渲染,另外渲染出來的字體和原本的 pdf
文件字體會存在差異。
針對這兩點,目前發現谷歌內置的 pdf
插件似乎提供了很好的支持,意味著其他瀏覽器如果包含了谷歌相關的插件(如:Edge、QQ Browser),就可以直接基于 <iframe>
的方式實現預覽,又或者為了更嚴謹字體一致性只能通過下載的方式來查看源文件。
實現不了產品的要求怎么辦?
例如上述探討的方案其實無法滿足文章開頭提到的部分要求。產品提出需求的目的也是為了提供更好的用戶體驗(~~正常情況下
),但是這些要求仍然要落實到技術上,而技術支持程度如何需要我們及時反饋( 除非你的產品是技術經驗
~~),因此作為開發者你需要提供充足的內容向產品證明,然后自己再給出一些間接實現的方案(又或者產品自己就給出新的方案
),看是否符合 第二預期 ,核心就是 合理溝通 + 其他方案 (每個人的處境不同,實際情況也許 ... 懂得都懂
)。
9E38506E.jpg 以上是個人的一些看法和理解,有不當之處,可以在評論區指正!!!
希望本文對你有所幫助!!!