和往常一樣,jsPDF是一個開源的客戶端的PDF解決方案,在之前的文章中已經介紹過幾個Web端和PDF相關的庫,jsPDF同樣是一個不錯的客戶端PDF引 SDK,你可以通過jsPDF在客戶端完成相關操作,它包含了非常豐富的API,幫助你完成一系列的復雜操作!可以說它是相當領先的HTML5客戶端解決方案了!
https://github.com/MrRio/jsPDF
Github star數17k+,可以說相當受歡迎了!
一般情況下我們會考慮使用包管理,常見的就是npm了,因此安裝非常簡單
npm install jspdf --save
或者也可以使用yarn
yarn add jspdf
接下來就是制作你的文件的時候了
默認導出為a4紙張,縱向,使用毫米表示單位
var doc = new jsPDF() doc.text('Hello world!', 10, 10) doc.save('a4.pdf')
如果要更改紙張尺寸,方向或單位,可以執行以下操作:
var doc = new jsPDF({ orientation: 'landscape', unit: 'in', format: [4, 2] }) doc.text('Hello world!', 1, 1) doc.save('two-by-four.pdf')
PDF中的14種標準字體僅限于ASCII代碼頁。如果要使用UTF-8,則必須集成自定義字體,該字體提供所需的字形。jsPDF支持.ttf文件。因此,如果你希望在pdf中使用中文文本,則您的字體必須具有必要的中文字形。因此,請檢查您的字體是否支持所需的字形,否則它將顯示空白而不是文本。
要將字體添加到jsPDF,在/fontconverter/fontconverter.html中使用官網提供的fontconverter。fontconverter將創建一個js文件,其中包含提供的ttf文件的內容作為base64編碼的字符串和jsPDF的附加代碼。你只需將生成的js-File添加到項目中即可。然后,就可以在代碼中使用setFont-method并編寫UTF-8編碼文本。
常規操作
import * as jsPDF from 'jspdf'
有些框架,必須像下面這樣
import jsPDF from 'jspdf';
jsPDF的api非常豐富,在這里就不提供相關地址了,在Github必然找的到,本文重點不在于介紹jsPDF的用法,將部分API截圖展示,通過名稱大致能猜到一些意思,具體用法需要參考官網文檔:
從截圖來看,其文檔特別的詳細,具體到每一個API在js文件的行數,便于閱讀源代碼,包括參數以及返回值都非常明確:
官方提供了一個在線demo,可以直接運行代碼,感興趣的可以先嘗試一下:
jsPDF是筆者見過類似產品中較為突出的,幾乎涵蓋了所有PDF相關操作,非常詳細的文檔也讓開發者,輕松上手,在線demo還能快速學習,如果你的項目對PDF的操作比較多,不妨嘗試下jsPDF,唯一需要注意的就是解決字體問題,但是上文也提到過解決方案,感興趣的可以進行體驗!
html轉為pdf的組件有很多,但是還沒有哪一款能達到這個效果,其只要原因是wkhtmltopdf使用webkit網頁渲染引擎開發的用來將 html轉成 pdf的工具,可以跟多種腳本語言進行集成來轉換文檔。但是就使用簡便性來說還是itext等組件占據優勢,如果你要轉換格式有比較高的要求,那么wkhtmltopdf絕對是不二之選!
下載路徑
官網地址 wkhtmltopdf.org/
github地址 github.com/wkhtmltopdf…
使用方法
java調用demo
public class HtmlToPdfInterceptor extends Thread { private InputStream is; public HtmlToPdfInterceptor(InputStream is){ this.is = is; } public void run(){ try{ InputStreamReader isr = new InputStreamReader(is, "utf-8"); BufferedReader br = new BufferedReader(isr); String line = null; while ((line = br.readLine()) != null) { System.out.println(line.toString()); //輸出內容 } }catch (IOException e){ e.printStackTrace(); } }}public class HtmlToPdf { //wkhtmltopdf在系統中的路徑 private static final String toPdfTool = "D:\wkhtmltopdf\bin\wkhtmltopdf.exe"; /** * html轉pdf * @param srcPath html路徑,可以是硬盤上的路徑,也可以是網絡路徑 * @param destPath pdf保存路徑 * @return 轉換成功返回true */ public static boolean convert(String srcPath, String destPath){ File file = new File(destPath); File parent = file.getParentFile(); //如果pdf保存路徑不存在,則創建路徑 if(!parent.exists()){ parent.mkdirs(); } StringBuilder cmd = new StringBuilder(); cmd.append(toPdfTool); cmd.append(" "); cmd.append(" --header-line");//頁眉下面的線 cmd.append(" --header-center 這里是頁眉這里是頁眉這里是頁眉這里是頁眉 ");//頁眉中間內容 //cmd.append(" --margin-top 30mm ");//設置頁面上邊距 (default 10mm) cmd.append(" --header-spacing 10 ");//(設置頁眉和內容的距離,默認0) cmd.append(srcPath); cmd.append(" "); cmd.append(destPath); boolean result = true; try{ Process proc = Runtime.getRuntime().exec(cmd.toString()); HtmlToPdfInterceptor error = new HtmlToPdfInterceptor(proc.getErrorStream()); HtmlToPdfInterceptor output = new HtmlToPdfInterceptor(proc.getInputStream()); error.start(); output.start(); proc.waitFor(); }catch(Exception e){ result = false; e.printStackTrace(); } return result; } public static void main(String[] args) { HtmlToPdf.convert("https://my.oschina.net/papio/blog/835645", "d:/wkhtmltopdf.pdf"); }}復制代碼
wkhtmltopdf 參數詳解
wkhtmltopdf [OPTIONS]... <input file> [More input files] <output file>常規選項 --allow <path> 允許加載從指定的文件夾中的文件或文件(可重復) --book* 設置一會打印一本書的時候,通常設置的選項 --collate 打印多份副本時整理 --cookie <name> <value> 設置一個額外的cookie(可重復) --cookie-jar <path> 讀取和寫入的Cookie,并在提供的cookie jar文件 --copies <number> 復印打印成pdf文件數(默認為1) --cover* <url> 使用HTML文件作為封面。它會帶頁眉和頁腳的TOC之前插入 --custom-header <name> <value> 設置一個附加的HTTP頭(可重復) --debug-javascript 顯示的javascript調試輸出 --default-header* 添加一個缺省的頭部,與頁面的左邊的名稱,頁面數到右邊,例如: --header-left '[webpage]' --header-right '[page]/[toPage]' --header-line --disable-external-links* 禁止生成鏈接到遠程網頁 --disable-internal-links* 禁止使用本地鏈接 --disable-javascript 禁止讓網頁執行JavaScript --disable-pdf-compression* 禁止在PDF對象使用無損壓縮 --disable-smart-shrinking* 禁止使用WebKit的智能戰略收縮,使像素/ DPI比沒有不變 --disallow-local-file-access 禁止允許轉換的本地文件讀取其他本地文件,除非explecitily允許用 --allow --dpi <dpi> 顯式更改DPI(這對基于X11的系統沒有任何影響) --enable-plugins 啟用已安裝的插件(如Flash --encoding <encoding> 設置默認的文字編碼 --extended-help 顯示更廣泛的幫助,詳細介紹了不常見的命令開關 --forms* 打開HTML表單字段轉換為PDF表單域 --grayscale PDF格式將在灰階產生 --help Display help --htmldoc 輸出程序HTML幫助 --ignore-load-errors 忽略claimes加載過程中已經遇到了一個錯誤頁面 --lowquality 產生低品質的PDF/ PS。有用縮小結果文檔的空間 --manpage 輸出程序手冊頁 --margin-bottom <unitreal> 設置頁面下邊距 (default 10mm) --margin-left <unitreal> 將左邊頁邊距 (default 10mm) --margin-right <unitreal> 設置頁面右邊距 (default 10mm) --margin-top <unitreal> 設置頁面上邊距 (default 10mm) --minimum-font-size <int> 最小字體大小 (default 5) --no-background 不打印背景 --orientation <orientation> 設置方向為橫向或縱向 --page-height <unitreal> 頁面高度 (default unit millimeter) --page-offset* <offset> 設置起始頁碼 (default 1) --page-size <size> 設置紙張大小: A4, Letter, etc. --page-width <unitreal> 頁面寬度 (default unit millimeter) --password <password> HTTP驗證密碼 --post <name> <value> Add an additional post field (repeatable) --post-file <name> <path> Post an aditional file (repeatable) --print-media-type* 使用的打印介質類型,而不是屏幕 --proxy <proxy> 使用代理 --quiet Be less verbose --read-args-from-stdin 讀取標準輸入的命令行參數 --readme 輸出程序自述 --redirect-delay <msec> 等待幾毫秒為JS-重定向(default 200) --replace* <name> <value> 替換名稱,值的頁眉和頁腳(可重復) --stop-slow-scripts 停止運行緩慢的JavaScripts --title <text> 生成的PDF文件的標題(第一個文檔的標題使用,如果沒有指定) --toc* 插入的內容的表中的文件的開頭 --use-xserver* 使用X服務器(一些插件和其他的東西沒有X11可能無法正常工作) --user-style-sheet <url> 指定用戶的樣式表,加載在每一頁中 --username <username> HTTP認證的用戶名 --version 輸出版本信息退出 --zoom <float> 使用這個縮放因子 (default 1) 頁眉和頁腳選項--header-center* <text> (設置在中心位置的頁眉內容) --header-font-name* <name> (default Arial) (設置頁眉的字體名稱)--header-font-size* <size> (設置頁眉的字體大小)--header-html* <url> (添加一個HTML頁眉,后面是網址)--header-left* <text> (左對齊的頁眉文本)--header-line* (顯示一條線在頁眉下)--header-right* <text> (右對齊頁眉文本)--header-spacing* <real> (設置頁眉和內容的距離,默認0)--footer-center* <text> (設置在中心位置的頁腳內容) --footer-font-name* <name> (設置頁腳的字體名稱) --footer-font-size* <size> (設置頁腳的字體大小default 11)--footer-html* <url> (添加一個HTML頁腳,后面是網址)--footer-left* <text> (左對齊的頁腳文本)--footer-line* 顯示一條線在頁腳內容上)--footer-right* <text> (右對齊頁腳文本)--footer-spacing* <real> (設置頁腳和內容的距離)./wkhtmltopdf --footer-right '[page]/[topage]' http://www.baidu.com baidu.pdf./wkhtmltopdf --header-center '報表' --header-line --margin-top 2cm --header-line http://192.168.212.139/oma/ oma.pdf表內容選項中 --toc-depth* <level> Set the depth of the toc (default 3) --toc-disable-back-links* Do not link from section header to toc --toc-disable-links* Do not link from toc to sections --toc-font-name* <name> Set the font used for the toc (default Arial) --toc-header-font-name* <name> The font of the toc header (if unset use --toc-font-name) --toc-header-font-size* <size> The font size of the toc header (default 15) --toc-header-text* <text> The header text of the toc (default Table Of Contents) --toc-l1-font-size* <size> Set the font size on level 1 of the toc (default 12) --toc-l1-indentation* <num> Set indentation on level 1 of the toc (default 0) --toc-l2-font-size* <size> Set the font size on level 2 of the toc (default 10) --toc-l2-indentation* <num> Set indentation on level 2 of the toc (default 20) --toc-l3-font-size* <size> Set the font size on level 3 of the toc (default 8) --toc-l3-indentation* <num> Set indentation on level 3 of the toc (default 40) --toc-l4-font-size* <size> Set the font size on level 4 of the toc (default 6) --toc-l4-indentation* <num> Set indentation on level 4 of the toc (default 60) --toc-l5-font-size* <size> Set the font size on level 5 of the toc (default 4) --toc-l5-indentation* <num> Set indentation on level 5 of the toc (default 80) --toc-l6-font-size* <size> Set the font size on level 6 of the toc (default 2) --toc-l6-indentation* <num> Set indentation on level 6 of the toc (default 100) --toc-l7-font-size* <size> Set the font size on level 7 of the toc (default 0) --toc-l7-indentation* <num> Set indentation on level 7 of the toc (default 120) --toc-no-dots* Do not use dots, in the toc輪廓選項 --dump-outline <file> 轉儲目錄到一個文件 --outline 顯示目錄(文章中h1,h2來定) --outline-depth <level> 設置目錄的深度(默認為4)頁腳和頁眉 * [page] 由當前正在打印的頁的數目代替 * [frompage] 由要打印的第一頁的數量取代 * [topage] 由最后一頁要打印的數量取代 * [webpage] 通過正在打印的頁面的URL替換 * [section] 由當前節的名稱替換 * [subsection] 由當前小節的名稱替換 * [date] 由當前日期系統的本地格式取代 * [time] 由當前時間,系統的本地格式取代
作者:曹元
鏈接:https://juejin.im/post/6856547881873047559
來源:掘金
著作權歸作者所有。商業轉載請聯系作者獲得授權,非商業轉載請注明出處。
本文中,我將展示如何使用 Node.js、Puppeteer、headless Chrome 和 Docker 從樣式復雜的 React 頁面生成 PDF 文檔。
背景:幾個月前,一個客戶要求我們開發一個功能,用戶可以得到 PDF 格式的 React 頁面內容。該頁面基本上是患者病例的報告和數據可視化結果,其中包含許多 SVG。另外還有一些特殊的請求來操縱布局,并對 HTML 元素進行一些重新排列。因此與原始的 React 頁面相比,PDF 中應該有不同的樣式和額外的內容。
由于這個任務比用簡單的 CSS 規則解決要復雜得多,所以我們先探討了可能的實現方法。我們找到了 3 個主要解決方案。這篇博文將指導你了解它們的可能性并最終實施。
目錄:
在客戶端還是服務器端生成?
在客戶端和服務器端都可以生成PDF文件。但是讓后端處理它可能更有意義,因為你并不想耗盡用戶瀏覽器可以提供的所有資源。
即便如此,我仍然會展示這兩種方法的解決方案。
方案1:從 DOM 制作屏幕截圖
乍一看,這個解決方案似乎是最簡單的,事實證明的確是這樣,但它有其自身的局限性。如果你沒有特殊需求,例如在 PDF 中選擇文本或對文本進行搜索,那么這就是一種簡單易用的方法。
此方法簡單明了:從頁面創建屏幕截圖,并把它放到 PDF 文件中。非常直截了當。我們可以使用兩個包來實現:
開始編碼:
npm install html2canvas jspdf
就這樣!
請注意 html2canvas 的 onclone方法。當你在截圖之前需要操縱 DOM(例如隱藏打印按鈕)時,它是非常方便的。我看到過很多使用這個包的項目。但不幸的是,這不是我們想要的,因為我們需要在后端完成對 PDF 的創建工作。
方案2:只使用 PDF 庫
NPM上有幾個庫,如 jsPDF(如上所述)或PDFKit。他們的問題是,如果我想使用這些庫,我將不得不重新調整頁面結構。這肯定會損害可維護性,因為我需要將所有后續更改應用到 PDF 模板和 React 頁面中。
請看下面的代碼。你需要親自手動創建 PDF 文檔。你需要遍歷 DOM 并找出每個元素并將其轉換為 PDF 格式,這是一項繁瑣的工作。必須找到一個更簡單的方法。
這段代碼段來自 PDFKit 文檔。但是如果你的目標是直接生成一個 PDF 文件,而不是對一個已經存在的(并且不斷變化的)HTML 頁面進行轉換,它還是很有用的。
最終方案3:基于 Node.js 的 Puppeteer 和 Headless Chrome
什么是 Puppeteer?其文檔中寫道:
Puppeteer 是一個 Node 庫,它提供了一個高級 API 來控制 DevTools 協議上的 Chrome 或 Chromium。 Puppeteer 默認以 headless 模式運行 Chrome 或 Chromium,但其也可以被配置為完整的(non-headless)模式運行。
它本質上是一個可以從 Node.js 運行的瀏覽器。如果你讀過它的文檔,其中首先提到的就是你可以用 Puppeteer 來生成頁面的截圖和PDF。優秀!這正是我們想要的。
先用 npmi i puppeteer 安裝 Puppeteer,并實現我們的功能。
這是一個簡單的功能,可導航到 URL 并生成站點的 PD F文件。
首先,我們啟動瀏覽器(僅在 headless 模式下支持 PDF 生成),然后打開新頁面,設置視口,并導航到提供的URL。
設置 waitUntil:'networkidle0' 選項意味著當至少500毫秒沒有網絡連接時,Puppeteer 會認為導航已完成。 (可以從 API docs 獲取更多信息。)
之后,我們將 PDF 保存為變量,關閉瀏覽器并返回 PDF。
注意:page.pdf 方法接收 options 對象,你可以使用 'path' 選項將文件保存到磁盤。如果未提供路徑,則 PDF 將不會被保存到磁盤,而是會得到緩沖區。(稍后我將討論如何處理它。)
如果需要先登錄才能從受保護的頁面生成 PDF,首先你要導航到登錄頁面,檢查表單元素的 ID 或名稱,填寫它們,然后提交表單:
要始終將登錄憑據保存在環境變量中,不要硬編碼!
樣式控制
Puppeteer 也有這種樣式操作的解決方案。你可以在生成 PDF 之前插入樣式標記,Puppeteer 將生成具有已修改樣式的文件。
await page.addStyleTag({ content: '.nav { display: none} .navbar { border: 0px} #print-button {display: none}' })
將文件發送到客戶端并保存
好的,現在你已經在后端生成了一個 PDF 文件。接下來做什么?
如上所述,如果你不把文件保存到磁盤,將會得到一個緩沖區。你只需要把含有適當內容類型的緩沖區發送到前端即可。
現在,你只需在瀏覽器向服務器發送請求即可得到生成的 PDF。
一旦發送了請求,緩沖區的內容就應該開始下載了。最后一步是將緩沖區數據轉換為 PDF 文件。
就這樣!如果單擊“保存”按鈕,那么瀏覽器將會保存 PDF。
在 Docker 中使用 Puppeteer
我認為這是實施中最棘手的部分 —— 所以讓我幫你節省幾個小時的百度時間。
官方文檔指出*“在 Docker 中使用 headless Chrome 并使其運行起來可能會非常棘手”*。官方文檔有疑難解答部分,你可以找到有關用 Docker 安裝 puppeteer 的所有必要信息。
如果你在 Alpine 鏡像上安裝 Puppeteer,請確保在看到頁面的這一部分時再向下滾動一點。否則你可能會忽略一個事實:你無法運行最新的 Puppeteer 版本,并且你還需要用一個標記禁用 shm :
const browser = await puppeteer.launch({ headless: true, args: ['--disable-dev-shm-usage'] });
否則,Puppeteer 子進程可能會在正常啟動之前耗盡內存。
方案 3 + 1:CSS 打印規則
可能有人認為從開發人員的角度來看,簡單地使用 CSS 打印規則很容易。沒有 NPM 模塊,只有純 CSS。但是在跨瀏覽器兼容性方面,它的表現如何呢?
在選擇 CSS 打印規則時,你必須在每個瀏覽器中測試結果,以確保它提供的布局是相同的,并且它不是100%能做到這一點。
例如,在給定元素后面插入一個 break-after 并不是一個多么高深的技術,但是你可能會驚訝的發現要在 Firefox 中使用它需要使用變通方法。
除非你是一位經驗豐富的 CSS 大師,在創建可打印頁面方面有很多的經驗,否則這可能會非常耗時。
如果你可以使打印樣式表保持簡單,打印規則是很好用的。
讓我們來看一個例子吧。
@media print { .print-button { display: none; } .content div { break-after: always; } }
上面的 CSS 隱藏了打印按鈕,并在每個 div 之后插入一個分頁符,其中包含content 類。有一篇很棒的文章總結了你可以用打印規則做什么,以及它們有什么問題,包括瀏覽器兼容性。
考慮到所有因素,如果你想從不那么復雜的頁面生成 PDF,CSS打印規則非常有效。
總結
讓我們快速回顧前面介紹的方案,以便從 HTML 頁面生成 PDF 文件:
雖然今天是愚人節,但是以上所有內容都是在真的!
作者:瘋狂的技術宅
鏈接:https://juejin.im/post/5ca1dc0251882543d569e075
*請認真填寫需求信息,我們會在24小時內與您取得聯系。