本文中,我將展示如何使用 Node.js、Puppeteer、headless Chrome 和 Docker 從樣式復(fù)雜的 React 頁面生成 PDF 文檔。
背景:幾個(gè)月前,一個(gè)客戶要求我們開發(fā)一個(gè)功能,用戶可以得到 PDF 格式的 React 頁面內(nèi)容。該頁面基本上是患者病例的報(bào)告和數(shù)據(jù)可視化結(jié)果,其中包含許多 SVG。另外還有一些特殊的請(qǐng)求來操縱布局,并對(duì) HTML 元素進(jìn)行一些重新排列。因此與原始的 React 頁面相比,PDF 中應(yīng)該有不同的樣式和額外的內(nèi)容。
由于這個(gè)任務(wù)比用簡(jiǎn)單的 CSS 規(guī)則解決要復(fù)雜得多,所以我們先探討了可能的實(shí)現(xiàn)方法。我們找到了 3 個(gè)主要解決方案。這篇博文將指導(dǎo)你了解它們的可能性并最終實(shí)施。
目錄:
在客戶端還是服務(wù)器端生成?
在客戶端和服務(wù)器端都可以生成PDF文件。但是讓后端處理它可能更有意義,因?yàn)槟悴⒉幌牒谋M用戶瀏覽器可以提供的所有資源。
即便如此,我仍然會(huì)展示這兩種方法的解決方案。
方案1:從 DOM 制作屏幕截圖
乍一看,這個(gè)解決方案似乎是最簡(jiǎn)單的,事實(shí)證明的確是這樣,但它有其自身的局限性。如果你沒有特殊需求,例如在 PDF 中選擇文本或?qū)ξ谋具M(jìn)行搜索,那么這就是一種簡(jiǎn)單易用的方法。
此方法簡(jiǎn)單明了:從頁面創(chuàng)建屏幕截圖,并把它放到 PDF 文件中。非常直截了當(dāng)。我們可以使用兩個(gè)包來實(shí)現(xiàn):
開始編碼:
npm install html2canvas jspdf
就這樣!
請(qǐng)注意 html2canvas 的 onclone方法。當(dāng)你在截圖之前需要操縱 DOM(例如隱藏打印按鈕)時(shí),它是非常方便的。我看到過很多使用這個(gè)包的項(xiàng)目。但不幸的是,這不是我們想要的,因?yàn)槲覀冃枰诤蠖送瓿蓪?duì) PDF 的創(chuàng)建工作。
方案2:只使用 PDF 庫
NPM上有幾個(gè)庫,如 jsPDF(如上所述)或PDFKit。他們的問題是,如果我想使用這些庫,我將不得不重新調(diào)整頁面結(jié)構(gòu)。這肯定會(huì)損害可維護(hù)性,因?yàn)槲倚枰獙⑺泻罄m(xù)更改應(yīng)用到 PDF 模板和 React 頁面中。
請(qǐng)看下面的代碼。你需要親自手動(dòng)創(chuàng)建 PDF 文檔。你需要遍歷 DOM 并找出每個(gè)元素并將其轉(zhuǎn)換為 PDF 格式,這是一項(xiàng)繁瑣的工作。必須找到一個(gè)更簡(jiǎn)單的方法。
這段代碼段來自 PDFKit 文檔。但是如果你的目標(biāo)是直接生成一個(gè) PDF 文件,而不是對(duì)一個(gè)已經(jīng)存在的(并且不斷變化的)HTML 頁面進(jìn)行轉(zhuǎn)換,它還是很有用的。
最終方案3:基于 Node.js 的 Puppeteer 和 Headless Chrome
什么是 Puppeteer?其文檔中寫道:
Puppeteer 是一個(gè) Node 庫,它提供了一個(gè)高級(jí) API 來控制 DevTools 協(xié)議上的 Chrome 或 Chromium。 Puppeteer 默認(rèn)以 headless 模式運(yùn)行 Chrome 或 Chromium,但其也可以被配置為完整的(non-headless)模式運(yùn)行。
它本質(zhì)上是一個(gè)可以從 Node.js 運(yùn)行的瀏覽器。如果你讀過它的文檔,其中首先提到的就是你可以用 Puppeteer 來生成頁面的截圖和PDF。優(yōu)秀!這正是我們想要的。
先用 npmi i puppeteer 安裝 Puppeteer,并實(shí)現(xiàn)我們的功能。
這是一個(gè)簡(jiǎn)單的功能,可導(dǎo)航到 URL 并生成站點(diǎn)的 PD F文件。
首先,我們啟動(dòng)瀏覽器(僅在 headless 模式下支持 PDF 生成),然后打開新頁面,設(shè)置視口,并導(dǎo)航到提供的URL。
設(shè)置 waitUntil:'networkidle0' 選項(xiàng)意味著當(dāng)至少500毫秒沒有網(wǎng)絡(luò)連接時(shí),Puppeteer 會(huì)認(rèn)為導(dǎo)航已完成。 (可以從 API docs 獲取更多信息。)
之后,我們將 PDF 保存為變量,關(guān)閉瀏覽器并返回 PDF。
注意:page.pdf 方法接收 options 對(duì)象,你可以使用 'path' 選項(xiàng)將文件保存到磁盤。如果未提供路徑,則 PDF 將不會(huì)被保存到磁盤,而是會(huì)得到緩沖區(qū)。(稍后我將討論如何處理它。)
如果需要先登錄才能從受保護(hù)的頁面生成 PDF,首先你要導(dǎo)航到登錄頁面,檢查表單元素的 ID 或名稱,填寫它們,然后提交表單:
要始終將登錄憑據(jù)保存在環(huán)境變量中,不要硬編碼!
樣式控制
Puppeteer 也有這種樣式操作的解決方案。你可以在生成 PDF 之前插入樣式標(biāo)記,Puppeteer 將生成具有已修改樣式的文件。
await page.addStyleTag({ content: '.nav { display: none} .navbar { border: 0px} #print-button {display: none}' })
將文件發(fā)送到客戶端并保存
好的,現(xiàn)在你已經(jīng)在后端生成了一個(gè) PDF 文件。接下來做什么?
如上所述,如果你不把文件保存到磁盤,將會(huì)得到一個(gè)緩沖區(qū)。你只需要把含有適當(dāng)內(nèi)容類型的緩沖區(qū)發(fā)送到前端即可。
現(xiàn)在,你只需在瀏覽器向服務(wù)器發(fā)送請(qǐng)求即可得到生成的 PDF。
一旦發(fā)送了請(qǐng)求,緩沖區(qū)的內(nèi)容就應(yīng)該開始下載了。最后一步是將緩沖區(qū)數(shù)據(jù)轉(zhuǎn)換為 PDF 文件。
就這樣!如果單擊“保存”按鈕,那么瀏覽器將會(huì)保存 PDF。
在 Docker 中使用 Puppeteer
我認(rèn)為這是實(shí)施中最棘手的部分 —— 所以讓我?guī)湍愎?jié)省幾個(gè)小時(shí)的百度時(shí)間。
官方文檔指出*“在 Docker 中使用 headless Chrome 并使其運(yùn)行起來可能會(huì)非常棘手”*。官方文檔有疑難解答部分,你可以找到有關(guān)用 Docker 安裝 puppeteer 的所有必要信息。
如果你在 Alpine 鏡像上安裝 Puppeteer,請(qǐng)確保在看到頁面的這一部分時(shí)再向下滾動(dòng)一點(diǎn)。否則你可能會(huì)忽略一個(gè)事實(shí):你無法運(yùn)行最新的 Puppeteer 版本,并且你還需要用一個(gè)標(biāo)記禁用 shm :
const browser = await puppeteer.launch({ headless: true, args: ['--disable-dev-shm-usage'] });
否則,Puppeteer 子進(jìn)程可能會(huì)在正常啟動(dòng)之前耗盡內(nèi)存。
方案 3 + 1:CSS 打印規(guī)則
可能有人認(rèn)為從開發(fā)人員的角度來看,簡(jiǎn)單地使用 CSS 打印規(guī)則很容易。沒有 NPM 模塊,只有純 CSS。但是在跨瀏覽器兼容性方面,它的表現(xiàn)如何呢?
在選擇 CSS 打印規(guī)則時(shí),你必須在每個(gè)瀏覽器中測(cè)試結(jié)果,以確保它提供的布局是相同的,并且它不是100%能做到這一點(diǎn)。
例如,在給定元素后面插入一個(gè) break-after 并不是一個(gè)多么高深的技術(shù),但是你可能會(huì)驚訝的發(fā)現(xiàn)要在 Firefox 中使用它需要使用變通方法。
除非你是一位經(jīng)驗(yàn)豐富的 CSS 大師,在創(chuàng)建可打印頁面方面有很多的經(jīng)驗(yàn),否則這可能會(huì)非常耗時(shí)。
如果你可以使打印樣式表保持簡(jiǎn)單,打印規(guī)則是很好用的。
讓我們來看一個(gè)例子吧。
@media print { .print-button { display: none; } .content div { break-after: always; } }
上面的 CSS 隱藏了打印按鈕,并在每個(gè) div 之后插入一個(gè)分頁符,其中包含content 類。有一篇很棒的文章總結(jié)了你可以用打印規(guī)則做什么,以及它們有什么問題,包括瀏覽器兼容性。
考慮到所有因素,如果你想從不那么復(fù)雜的頁面生成 PDF,CSS打印規(guī)則非常有效。
總結(jié)
讓我們快速回顧前面介紹的方案,以便從 HTML 頁面生成 PDF 文件:
雖然今天是愚人節(jié),但是以上所有內(nèi)容都是在真的!
作者:瘋狂的技術(shù)宅
鏈接:https://juejin.im/post/5ca1dc0251882543d569e075
DF轉(zhuǎn)HTML在網(wǎng)絡(luò)應(yīng)用中越來越受到重視,PDF作為一種電子文件格式廣泛應(yīng)用于各種場(chǎng)景,例如在線教育、電子商務(wù)等。但是PDF作為一種專有格式,在網(wǎng)絡(luò)應(yīng)用中存在一定的限制,比如不便于搜索引擎索引的問題。因此,將PDF轉(zhuǎn)換為HTML格式就顯得尤為重要。HTML作為一種開放標(biāo)準(zhǔn),在瀏覽器中的兼容性強(qiáng),結(jié)構(gòu)清晰,方便搜索引擎抓取,能很好地解決PDF在網(wǎng)絡(luò)應(yīng)用中的一些問題。那你們知道PDF怎么轉(zhuǎn)HTML嗎?下面就為大家分享幾種不錯(cuò)的方法。
以下是可以將PDF轉(zhuǎn)HTML的方法:
一、使用全能PDF轉(zhuǎn)換助手將PDF轉(zhuǎn)HTML
這是一款功能豐富的PDF轉(zhuǎn)換工具,支持將PDF文件轉(zhuǎn)換為多種格式,包括HTML。它具有直觀的操作界面和簡(jiǎn)單易用的操作流程,即使對(duì)于初學(xué)者也很友好。
【轉(zhuǎn)換步驟】
步驟一:打開軟件后,選擇“PDF轉(zhuǎn)HTML”功能。
步驟二:添加PDF文件,接著調(diào)整“頁碼選擇”,然后點(diǎn)擊“開始轉(zhuǎn)換”即可。
二、使用HODO將PDF轉(zhuǎn)HTML
這是一個(gè)受歡迎的PDF轉(zhuǎn)HTML平臺(tái),它專注于提供出色的轉(zhuǎn)換質(zhì)量和準(zhǔn)確性。它的轉(zhuǎn)換引擎使用先進(jìn)的算法,可以保留原始PDF文件的布局和格式,并將其轉(zhuǎn)換為高質(zhì)量的HTML文件。
【轉(zhuǎn)換步驟】
步驟一:使用瀏覽器打開平臺(tái)的網(wǎng)站后,選擇“PDFto HTML”功能。
步驟二:添加PDF文件,接著平臺(tái)就會(huì)自動(dòng)識(shí)別并進(jìn)行轉(zhuǎn)換。
三、使用ZAMZAR將PDF轉(zhuǎn)HTML
這是另一個(gè)在線文件轉(zhuǎn)換平臺(tái),提供多種文件格式之間的轉(zhuǎn)換服務(wù),包括PDF到HTML的轉(zhuǎn)換。這個(gè)平臺(tái)非常方便使用,我們不需要安裝任何軟件。
【轉(zhuǎn)換步驟】
步驟一:打開平臺(tái)后,通過“ChooseFiles”上傳PDF文件。
步驟二:在“WebFormats”中選擇“HTML”格式,接著點(diǎn)擊“ConvertNow”就能完成轉(zhuǎn)換。
看完這篇文章,大家都學(xué)會(huì)PDF怎么轉(zhuǎn)HTML了嗎?以上三種方法都可以很好地實(shí)現(xiàn)PDF到HTML的轉(zhuǎn)換,幫助我們利用PDF內(nèi)容在網(wǎng)頁中發(fā)揮更廣泛的價(jià)值。具體選擇哪種方法,需要大家結(jié)合自身實(shí)際轉(zhuǎn)換需求來定。
何保持頁面樣式基本不變的前提下將HTML頁面導(dǎo)出為PDF,下面提供一些示例代碼,純屬個(gè)人原創(chuàng),如對(duì)你有幫助請(qǐng)記得加關(guān)注、加收藏、點(diǎn)贊、轉(zhuǎn)發(fā)、分享~謝謝~~
<div>
<!-- 要打印的內(nèi)容區(qū) -->
<div ref="contentRef">
<div class="print-item print-out-flow">這是脫離文檔流的內(nèi)容區(qū)域</div>
<div class="print-item">這是一行內(nèi)容,也是最小葉子元素內(nèi)容</div>
</div>
<!-- 打印內(nèi)容容器 -->
<div ref="printContainerRef" class="print-container"></div>
</div>
/**
* 1.使用一個(gè)隱藏div裝載有滾動(dòng)條的div.innerHTML
* 2.隱藏div使用position: absolute, z-index: -999, left: -9999px, width: 900px 控制讓用戶無感知
* 3.根據(jù)需要覆寫隱藏div內(nèi)html樣式(例如textarea多行顯示有問題, 可以新增一個(gè)隱藏的div
* 包裹textarea的綁定值, 然后在打印樣式中覆寫樣式, 隱藏textarea并顯示對(duì)應(yīng)div)
*/
handleExport() {
// 下面是VUE組件內(nèi)獲取DOM元素代碼,將內(nèi)容放置到打印區(qū)(定義的隱藏DIV)中
const contentRef = this.$refs.contentRef as HTMLElement;
const printContainerRef = this.$refs.printContainerRef as HTMLElement;
// 打印區(qū)的需額外處理絕對(duì)定位值, 調(diào)整使得第一個(gè)元素的.top值為0, 以便于頁面計(jì)算
printContainerRef.innerHTML = contentRef.innerHTML;
// 所有葉子div元素加上 print-item 樣式名, 脫離文檔流的額外添加 print-out-flow
handlePrintItem(printContainerRef); // 解決多頁內(nèi)容可能被切割問題
html2canvas(printContainerRef, {allowTaint: false, useCORS: true}).then((canvas: any) => {
const contentHeight = canvas.height;
const contentWidth = canvas.width;
// pdf每頁顯示的內(nèi)容高度
const pageHeight = contentWidth / 595.28 * 841.89;
// 未生成pdf的頁面高度
let offsetHeight = contentHeight;
// 頁面偏移值
let position = 0;
// a4紙的尺寸[595.28, 841.89], canvas圖片按a4紙大小縮放后的寬高
const imgWidth = 595.28;
const imgHeight = 595.28 / contentWidth * contentHeight;
const dataURL = canvas.toDataURL('image/jpeg', 1.0);
const doc = new jsPDF('p', 'pt', 'a4');
if (offsetHeight < pageHeight) {
doc.addImage(dataURL, 'JPEG', 0, 0, imgWidth, imgHeight);
} else {
while (offsetHeight > 0) {
doc.addImage(dataURL, 'JPEG', 0, position, imgWidth, imgHeight);
offsetHeight -= pageHeight;
position -= 841.89;
if (offsetHeight > 0) {
doc.addPage();
}
}
}
doc.save(this.generateReportFileName());
printContainerRef.innerHTML = '';
});
}
上干貨代碼:上面分頁導(dǎo)出PDF可能網(wǎng)上能看到類型代碼,但絕對(duì)找不到下面的代碼,純手搓解決分頁元素被切開問題(思路:獲取自身定位,如自己剛好在被分頁處,則加上一定的margin-top值將內(nèi)容向下移)
/**
* 處理打印元素項(xiàng), 修復(fù)分頁后被切割的元素
* @param printContainerRef 打印內(nèi)容div容器
* @param itemClassName 打印最小元素標(biāo)識(shí)類名
* @param outFlowClassName 脫離文檔流的元素標(biāo)識(shí)類名
*/
export function handlePrintItem(
printContainerRef: HTMLElement,
itemClassName: string = 'print-item',
outFlowClassName: string = 'print-out-flow'
): void {
const rootClientRect = printContainerRef.getBoundingClientRect();
// 初始化頁面相關(guān)數(shù)據(jù)
const totalHeight = rootClientRect.height; // 內(nèi)容總高度
const a4PageHeight = (printContainerRef.clientWidth / 595.28) * 841.89; // a4紙高度
let pageNum = Math.ceil(totalHeight / a4PageHeight); // 總頁數(shù)
let addPageHeight = 0; // 修正被分割元素而增加的頁面高度總和
let currentPage = 1; // 當(dāng)前正在處理切割的頁面
const splitItemObj: { [key: number]: HTMLElement[] } = {}; // 內(nèi)容中各頁被切割元素存儲(chǔ)對(duì)象
const printItemNodes: NodeListOf<HTMLElement> = printContainerRef.querySelectorAll(`.${itemClassName}`);
for (let item of printItemNodes) {
// 如果當(dāng)前頁已經(jīng)是最后一頁, 則中斷判斷
if (currentPage >= pageNum) {
break;
}
// 獲取元素絕對(duì)定位數(shù)據(jù)
const clientRect = item.getBoundingClientRect();
let top = clientRect.top;
const selfHeight = clientRect.height;
// 如果當(dāng)前元素距離頂部高度大于當(dāng)前頁面頁腳高度, 則開始判斷下一頁頁腳被切割元素
if (top > currentPage * a4PageHeight) {
// 換頁前修正上一頁被切割元素
addPageHeight += fixSplitItems(currentPage, a4PageHeight, splitItemObj[currentPage], outFlowClassName);
pageNum = Math.ceil((totalHeight + addPageHeight) / a4PageHeight);
top = item.getBoundingClientRect().top;
currentPage++;
}
// 如果元素剛好處于兩頁之間, 則記錄該元素
if (top > (currentPage - 1) * a4PageHeight && top < currentPage * a4PageHeight && top + selfHeight > currentPage * a4PageHeight) {
if (!splitItemObj[currentPage]) {
splitItemObj[currentPage] = [];
}
splitItemObj[currentPage].unshift(item);
// 如果當(dāng)前元素是最后一個(gè)元素, 則直接處理切割元素, 否則交由處理下一頁元素時(shí)再處理切割
if (item === printItemNodes[printItemNodes.length - 1]) {
fixSplitItems(currentPage, a4PageHeight, splitItemObj[currentPage], outFlowClassName);
}
}
}
}
/**
* 修復(fù)當(dāng)前頁所有被切割元素
* @param currentPage 當(dāng)前頁
* @param pageHeight 每頁高度
* @param splitElementItems 當(dāng)前被切割元素?cái)?shù)組
* @param outFlowClassName 脫離文檔流的樣式類名
*/
function fixSplitItems(
currentPage: number,
pageHeight: number,
splitElementItems: HTMLElement[],
outFlowClassName: string
): number {
if (!splitElementItems || !splitElementItems.length) {
return 0;
}
const yMargin = 5; // y方向距離頁眉的距離
const splitItemsMinTop = getSplitItemsMinTop(splitElementItems);
if (!splitItemsMinTop) {
return 0;
}
let fixHeight = currentPage * pageHeight - splitItemsMinTop + yMargin;
const outFlowElement = splitElementItems.find((item) => item.classList.contains(outFlowClassName));
if (outFlowElement && outFlowElement.parentElement) {
const parentPreviousElement = outFlowElement.parentElement.previousElementSibling as HTMLElement;
fixHeight += getMarinTopNum(parentPreviousElement, outFlowElement.parentElement);
outFlowElement.parentElement.style.marginTop = `${fixHeight}px`;
return fixHeight;
}
splitElementItems.forEach((splitElement) => {
splitElement.style.marginTop = `${fixHeight}px`;
});
return fixHeight;
}
/**
* 獲取被切割元素?cái)?shù)組中最小高度值(如一行有多個(gè)元素被切割,則選出距離頂部最小的高度值)
* @param splitElementItems 當(dāng)前被切割元素?cái)?shù)組
*/
function getSplitItemsMinTop(
splitElementItems: HTMLElement[]
): number | undefined {
// 獲取元素中最小top值作為基準(zhǔn)進(jìn)行修正
let minTop: number | undefined;
let minElement: HTMLElement | undefined;
splitElementItems.forEach((splitElement) => {
let top = splitElement.getBoundingClientRect().top;
if (minTop) {
minTop = top < minTop ? top : minTop;
minElement = top < minTop ? splitElement : minElement;
} else {
minTop = top;
minElement = splitElement;
}
});
// 修正當(dāng)前節(jié)點(diǎn)及其前面同層級(jí)節(jié)點(diǎn)的margin值
if (minTop && minElement) {
const previousElement = splitElementItems[splitElementItems.length - 1].previousElementSibling as HTMLElement;
minTop -= getMarinTopNum(previousElement, minElement);
}
return minTop;
}
/**
* 通過前一個(gè)兄弟元素和元素自身的位置確認(rèn)一個(gè)距離頂部高度修正值
* @param previousElement 前一個(gè)兄弟元素
* @param curElement 當(dāng)前元素
*/
function getMarinTopNum(previousElement: HTMLElement, curElement: HTMLElement): number {
let preMarginNum = 0;
let curMarginNum = 0;
if (previousElement) {
// 獲取外聯(lián)樣式需要getComputedStyle(), 直接.style時(shí)對(duì)象的值都為空
const previousMarginBottom = window.getComputedStyle(previousElement).marginBottom;
preMarginNum = previousMarginBottom ? Number(previousMarginBottom.replace('px', '')) : 0;
}
const marginTop = window.getComputedStyle(curElement).marginTop;
curMarginNum = marginTop ? Number(marginTop.replace('px', '')) : 0;
return preMarginNum > curMarginNum ? preMarginNum : curMarginNum;
}
以上純?cè)瓌?chuàng)!歡迎加關(guān)注、加收藏、點(diǎn)贊、轉(zhuǎn)發(fā)、分享(代碼閑聊站)~
*請(qǐng)認(rèn)真填寫需求信息,我們會(huì)在24小時(shí)內(nèi)與您取得聯(lián)系。