【轉(zhuǎn)發(fā)】Javascript 將 HTML 頁面生成 PDF 并下載

原文https://mp.weixin.qq.com/s/PnkM12KSg8M44c4s1lqPhw

項目源碼地址:https://github.com/linwalker/render-html-to-pdf

html2canvas

簡介

我們可以直接在瀏覽器端使用html2canvas恋拷,對整個或局部頁面進行“截圖”。但這并不是真的截圖扮碧,而是通過遍歷頁面DOM結(jié)構(gòu)焕阿,收集所有元素信息及相應樣式凉当,渲染出canvas image茄靠。

由于html2canvas只能將它能處理的生成canvas image,因此渲染出來的結(jié)果并不是100%與原來一致屡久。但它不需要服務器參與忆首,整個圖片都由客戶端瀏覽器生成,使用很方便被环。

使用

使用的API也很簡潔糙及,下面代碼可以將某個元素渲染成canvas:

html2canvas(element, {

? ?onrendered: function(canvas) {

? ? ? ?// canvas is the final rendered <canvas> element

? ?}

});

通過onrendered方法,可以將生成的canvas進行回調(diào)筛欢,比如插入到頁面中:

html2canvas(element, {

? ?onrendered: function(canvas) {

? ? ? document.body.appendChild(canvas);

? ?}

});

做個小例子(demo1)代碼如下:

<html>

?<head>

? ?<title>html2canvas example</title>

? ?<style type="text/css">...</style>

?</head>

?<body>

? ?<header>

? ? ?<nav>

? ? ? ?<ul>

? ? ? ? ?<li>one</li>

? ? ? ? ?...

? ? ? ?</ul>

? ? ?</nav>

? ?</header>

? ?<section>

? ? ?<aside>

? ? ? ?<h3>it is a title</h3>

? ? ? ?<a href="">Stone Giant</a>

? ? ? ?...

? ? </aside>

? ? ?<article>

? ? ? ?<img src="./Stone.png">

? ? ? ?<h2>Stone Giant</h2>

? ? ? ?<p>Coming ... </p>

? ? ? ?<p>以一團石頭...</p>

? ? ?</article>

? ?</section>

? ?<footer>write by linwalker @2017</footer>

? ?<script type="text/javascript" src="./html2canvas.js"></script>

? ?<script type="text/javascript">

? ? ? ?html2canvas(document.body, {

? ? ? ? ?onrendered:function(canvas) {

? ? ? ? ? ?document.body.appendChild(canvas)

? ? ? ? ?}

? ? ? ?})

? ?</script>

?</body>

</html>

這個例子將頁面body中的元素渲染成canvas丁鹉,并插入到body中。

jsPDF

jsPDF庫可以用于瀏覽器端生成PDF悴能。

文字生成PDF

使用方法如下:

// 默認a4大小,豎直方向雳灾,mm單位的PDF

var doc = new jsPDF();

// 添加文本‘Download PDF’

doc.text('Download PDF!', 10, 10);

doc.save('a4.pdf');

圖片生成PDF

使用方法如下:

// 三個參數(shù)漠酿,第一個方向,第二個單位谎亩,第三個尺寸格式

var doc = new jsPDF('landscape','pt',[205, 115])

// 將圖片轉(zhuǎn)化為dataUrl

var imageData = ‘data:image/png;base64,iVBORw0KGgo...’;

doc.addImage(imageData, 'PNG', 0, 0, 205, 115);

doc.save('a4.pdf');

文字與圖片生成PDF

// 三個參數(shù)炒嘲,第一個方向,第二個尺寸匈庭,第三個尺寸格式

var doc = new jsPDF('landscape','pt',[205, 155])

// 將圖片轉(zhuǎn)化為dataUrl

var imageData = ‘data:image/png;base64,iVBORw0KGgo...’;

//設置字體大小

doc.setFontSize(20);

//10,20這兩參數(shù)控制文字距離左邊夫凸,與上邊的距離

doc.text('Stone', 10, 20);

// 0, 40, 控制文字距離左邊,與上邊的距離

doc.addImage(imageData, 'PNG', 0, 40, 205, 115);

doc.save('a4.pdf')

生成pdf需要把轉(zhuǎn)化的元素添加到jsPDF實例中阱持,也有添加html的功能夭拌,但某些元素無法生成在pdf中,因此可以使用html2canvas + jsPDF的方式將頁面轉(zhuǎn)成pdf。通過html2canvas將遍歷頁面元素鸽扁,并渲染生成canvas蒜绽,然后將canvas圖片格式添加到jsPDF實例,生成pdf桶现。

html2canvas + jsPDF

單頁

將demo1的例子修改下:

<script type="text/javascript" src="./js/jsPdf.debug.js"></script>

<script type="text/javascript">

? ? ?var downPdf = document.getElementById("renderPdf");

? ? ?downPdf.onclick = function() {

? ? ? ? ?html2canvas(document.body, {

? ? ? ? ? ? ?onrendered:function(canvas) {

? ? ? ? ? ? ? ? ?//返回圖片dataURL躲雅,參數(shù):圖片格式和清晰度(0-1)

? ? ? ? ? ? ? ? ?var pageData = canvas.toDataURL('image/jpeg', 1.0);

? ? ? ? ? ? ? ? ?//方向默認豎直,尺寸ponits骡和,格式a4[595.28,841.89]

? ? ? ? ? ? ? ? ?var pdf = new jsPDF('', 'pt', 'a4');

? ? ? ? ? ? ? ? ?//addImage后兩個參數(shù)控制添加圖片的尺寸相赁,此處將頁面高度按照a4紙寬高比列進行壓縮

? ? ? ? ? ? ? ? ?pdf.addImage(pageData, 'JPEG', 0, 0, 595.28, 592.28/canvas.width * canvas.height );

? ? ? ? ? ? ? ? ?pdf.save('stone.pdf');

? ? ? ? ? ? ?}

? ? ? ? ?})

? ? ?}

</script>

如果頁面內(nèi)容根據(jù)a4比例轉(zhuǎn)化后高度超過a4紙高度呢,生成的pdf會怎么樣慰于?會分頁嗎钮科?

你可以試試,驗證一下自己的想法东囚。

jsPDF提供了一個很有用的API跺嗽,addPage(),我們可以通過pdf.addPage()页藻,來添加一頁pdf桨嫁,然后通過pdf.addImage(...),將圖片賦予這頁pdf來顯示份帐。

那么我們?nèi)绾未_定哪里分頁璃吧?

這個問題好回答,我們可以設置一個pageHeight废境,超過這個高度的內(nèi)容放入下一頁pdf畜挨。

來捋一下思路,將html頁面內(nèi)容生成canvas圖片噩凹,通過addImage將第一頁圖片添加到pdf中巴元,超過一頁內(nèi)容,通過addPage()添加pdf頁數(shù),然后再通過addImage將下一頁圖片添加到pdf中驮宴。

嗯~逮刨,很好!巴特堵泽,難道沒有發(fā)現(xiàn)問題嗎修己?

這個方法實現(xiàn)的前提是 — — 我們能根據(jù)pageHeight先將整頁內(nèi)容生成的canvas圖片分割成對應的小圖片,然后一個蘿卜一個坑迎罗,一頁一頁addImage進去睬愤。

What? 想一想我們的canvas是腫么來的,不用拉上去纹安,直接看下面:

html2canvas(document.body, {

? ?onrendered:function(canvas) {

? ? //it is here we handle the canvas

? ?}

})

這里的body就是要生成canvas的元素對象尤辱,一個元素生成一個canvas砂豌;那么我們需要一頁一頁的canvas,也就是說啥刻。奸鸯。。

你覺得可能嗎可帽? 我覺得不太現(xiàn)實娄涩,按這思路要獲取頁面上不同位置的DOM元素,然后通過htnl2canvas(element,option)來處理映跟,先不說能不能剛好在每個pageHeight的位置剛好找到一個DOM元素蓄拣,就算找到了,這樣做累不累努隙。

累的話 :)可以看看下面這種方法球恤。

多頁

我提供的思路是我們只生成一個canvas,對就一個荸镊,轉(zhuǎn)化元素就是你要轉(zhuǎn)成pdf內(nèi)容的母元素咽斧,在這篇demo里就是body了;其他不變躬存,也是超過一頁內(nèi)容就addPage张惹,然后addImage,只不過這里添加的是同一個canvas。

當然這樣做只會出現(xiàn)多頁重復的pdf岭洲,那到底怎么實現(xiàn)正確分頁顯示宛逗。其實主要利用了jsPDF的兩點:

超過jsPDF實例格式尺寸的內(nèi)容不顯示(varpdf=newjsPDF('','pt','a4');demo中就是a4紙的尺寸)

addImage有兩個參數(shù)可以控制圖片在pdf中的位置

雖然每一頁pdf上顯示的圖片是相同的,但我們通過調(diào)整圖片的位置盾剩,產(chǎn)生了分頁的錯覺雷激。以第二頁為例,將豎直方向上的偏移設置為-841.89即一張a4紙的高度告私,又因為超過a4紙高度范圍的圖片不顯示屎暇,所以第二頁顯示了圖片豎直方向上[841.89,1682.78]范圍內(nèi)的內(nèi)容,這就得到了分頁的效果驻粟,以此類推恭垦。

還是看代碼吧:

html2canvas(document.body, {

?onrendered:function(canvas) {

? ? ?var contentWidth = canvas.width;

? ? ?var contentHeight = canvas.height;

? ? ?//一頁pdf顯示html頁面生成的canvas高度;

? ? ?var pageHeight = contentWidth / 592.28 * 841.89;

? ? ?//未生成pdf的html頁面高度

? ? ?var leftHeight = contentHeight;

? ? ?//頁面偏移

? ? ?var position = 0;

? ? ?//a4紙的尺寸[595.28,841.89],html頁面生成的canvas在pdf中圖片的寬高

? ? ?var imgWidth = 595.28;

? ? ?var imgHeight = 592.28/contentWidth * contentHeight;

? ? ?var pageData = canvas.toDataURL('image/jpeg', 1.0);

? ? ?var pdf = new jsPDF('', 'pt', 'a4');

? ? ?//有兩個高度需要區(qū)分格嗅,一個是html頁面的實際高度,和生成pdf的頁面高度(841.89)

? ? ?//當內(nèi)容未超過pdf一頁顯示的范圍唠帝,無需分頁

? ? ?if (leftHeight < pageHeight) {

? ? ?pdf.addImage(pageData, 'JPEG', 0, 0, imgWidth, imgHeight );

? ? ?} else {

? ? ? ? ?while(leftHeight > 0) {

? ? ? ? ? ? ?pdf.addImage(pageData, 'JPEG', 0, position, imgWidth, imgHeight)

? ? ? ? ? ? ?leftHeight -= pageHeight;

? ? ? ? ? ? ?position -= 841.89;

? ? ? ? ? ? ?//避免添加空白頁

? ? ? ? ? ? ?if(leftHeight > 0) {

? ? ? ? ? ? ? ?pdf.addPage();

? ? ? ? ? ? ?}

? ? ? ? ?}

? ? ?}

? ? ?pdf.save('content.pdf');

?}

})

兩邊留邊距

修改imgWidth屯掖,并且在addImage時x方向參數(shù)設置你要的邊距,具體代碼如下:

var imgWidth = 555.28;

var imgHeight = 555.28/contentWidth * contentHeight;

...

pdf.addImage(pageData, 'JPEG', 20, 0, imgWidth, imgHeight );

...

pdf.addImage(pageData, 'JPEG', 20, position, imgWidth, imgHeight);

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末襟衰,一起剝皮案震驚了整個濱河市贴铜,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖绍坝,帶你破解...
    沈念sama閱讀 212,816評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件徘意,死亡現(xiàn)場離奇詭異,居然都是意外死亡轩褐,警方通過查閱死者的電腦和手機椎咧,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,729評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來把介,“玉大人勤讽,你說我怎么就攤上這事∞痔撸” “怎么了脚牍?”我有些...
    開封第一講書人閱讀 158,300評論 0 348
  • 文/不壞的土叔 我叫張陵肆糕,是天一觀的道長逗柴。 經(jīng)常有香客問我,道長辟躏,這世上最難降的妖魔是什么君纫? 我笑而不...
    開封第一講書人閱讀 56,780評論 1 285
  • 正文 為了忘掉前任驯遇,我火速辦了婚禮,結(jié)果婚禮上庵芭,老公的妹妹穿的比我還像新娘妹懒。我一直安慰自己,他們只是感情好双吆,可當我...
    茶點故事閱讀 65,890評論 6 385
  • 文/花漫 我一把揭開白布眨唬。 她就那樣靜靜地躺著,像睡著了一般好乐。 火紅的嫁衣襯著肌膚如雪匾竿。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 50,084評論 1 291
  • 那天蔚万,我揣著相機與錄音岭妖,去河邊找鬼。 笑死反璃,一個胖子當著我的面吹牛昵慌,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播淮蜈,決...
    沈念sama閱讀 39,151評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼斋攀,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了梧田?” 一聲冷哼從身側(cè)響起淳蔼,我...
    開封第一講書人閱讀 37,912評論 0 268
  • 序言:老撾萬榮一對情侶失蹤鹉梨,失蹤者是張志新(化名)和其女友劉穎晌坤,沒想到半個月后泡仗,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,355評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,666評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了却桶。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,809評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖趁啸,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蛤签,我是刑警寧澤,帶...
    沈念sama閱讀 34,504評論 4 334
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響豪嚎,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜糯耍,卻給世界環(huán)境...
    茶點故事閱讀 40,150評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧抛虏,春花似錦、人聲如沸错忱。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽凛虽。三九已至,卻和暖如春钠署,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背该面。 一陣腳步聲響...
    開封第一講書人閱讀 32,121評論 1 267
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人揽思。 一個月前我還...
    沈念sama閱讀 46,628評論 2 362
  • 正文 我出身青樓见擦,卻偏偏與公主長得像钉汗,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子鲤屡,可洞房花燭夜當晚...
    茶點故事閱讀 43,724評論 2 351

推薦閱讀更多精彩內(nèi)容