js將 HTML 頁面生成 PDF 並下載


最近碰到個需求,需要把當前頁面生成 pdf,並下載。弄了幾天,自己整理整理,記錄下來,我覺得應該會有人需要 :)

先來科普兩個插件:

html2Canvas

簡介

我們可以直接在瀏覽器端使用html2canvas,對整個或局部頁面進行“截圖”。但這並不是真的截圖,而是通過遍歷頁面DOM結構,收集所有元素信息及相應樣式,渲染出canvas image。由於html2canvas只能將它能處理的生成canvas image,因此渲染出來的結果並不是100%與原來一致。但它不需要服務器參與,整個圖片都由客戶端瀏覽器生成,使用很方便。使用使用的API也很簡潔,下面代碼可以將某個元素渲染成canvas:

html2canvas(element, {
    onrendered: 
function
(canvas) {
        
// canvas is the final rendered <canvas> element
    }
});

 

通過onrendered方法,可以將生成的canvas進行回調,比如插入到頁面中:

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,使用方法如下:

// 三個參數,第一個方向,第二個單位,第三個尺寸格式
var
 doc = 
new
 jsPDF(
'landscape'
,
'pt'
,[
205
, 
115
])
// 將圖片轉化為dataUrl
var
 imageData = ‘data:image/png;base64,iVBORw0KGgo...’;
doc.addImage(imageData, 
'PNG'
, 
0
, 
0
, 
205
, 
115
);
doc.save(
'a4.pdf'
);

文字與圖片生成PDF

// 三個參數,第一個方向,第二個尺寸,第三個尺寸格式
var
 doc = 
new
 jsPDF(
'landscape'
,
'pt'
,[
205
, 
155
])
// 將圖片轉化為dataUrl
var
 imageData = ‘data:image/png;base64,iVBORw0KGgo...’;
//設置字體大小
doc.setFontSize(
20
);
//10,20這兩參數控制文字距離左邊,與上邊的距離
doc.text(
'Stone'
, 
10
, 
20
);
// 0, 40, 控制文字距離左邊,與上邊的距離
doc.addImage(imageData, 
'PNG'
, 
0
, 
40
, 
205
, 
115
);
doc.save(
'a4.pdf'
)

生成pdf需要把轉化的元素添加到jsPDF實例中,也有添加html的功能,但某些元素無法生成在pdf中,因此可以使用html2canvas + jsPDF的方式將頁面轉成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,參數:圖片格式和清晰度(0-1)
                  
var
 pageData = canvas.toDataURL(
'image/jpeg'
, 
1.0
);
                  
//方向默認豎直,尺寸ponits,格式a4[595.28,841.89]
                  
var
 pdf = 
new
 jsPDF(
''
, 
'pt'
, 
'a4'
);
                  
//addImage后兩個參數控制添加圖片的尺寸,此處將頁面高度按照a4紙寬高比列進行壓縮
pdf.addImage(pageData, 
'JPEG'
, 
0
, 
0
, 
595.28
, 
592.28
/canvas.width * canvas.height );
pdf.save(
'stone.pdf'
);
              }
          })
      }
</script>

如果頁面內容根據a4比例轉化后高度超過a4紙高度呢,生成的pdf會怎么樣?會分頁嗎?

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

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

那么我們如何確定哪里分頁?

這個問題好回答,我們可以設置一個 pageHeight,超過這個高度的內容放入下一頁pdf。

來捋一下思路,將html頁面內容生成canvas圖片,通過 addImage將第一頁圖片添加到pdf中,超過一頁內容,通過 addPage()添加pdf頁數,然后再通過 addImage將下一頁圖片添加到pdf中。

嗯~,很好!巴特,難道沒有發現問題嗎?

這個方法實現的前提是 — — 我們能根據 pageHeight先將整頁內容生成的canvas圖片分割成對應的小圖片,然后一個蘿卜一個坑,一頁一頁 addImage進去。

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

html2canvas(document.body, {
    onrendered:
function
(canvas) {
     
//it is here we handle the canvas
    }
})

這里的 body就是要生成canvas的元素對象,一個元素生成一個canvas;那么我們需要一頁一頁的canvas,也就是說。。。你覺得可能嗎? 我覺得不太現實,按這思路要獲取頁面上不同位置的DOM元素,然后通過 htnl2canvas(element,option)來處理,先不說能不能剛好在每個 pageHeight的位置剛好找到一個DOM元素,就算找到了,這樣做累不累。累的話 :)可以看看下面這種方法。

多頁

我提供的思路是我們只生成一個canvas,對就一個,轉化元素就是你要轉成pdf內容的母元素,在這篇demo里就是 body了;其他不變,也是超過一頁內容就 addPage,然后 addImage,只不過這里添加的是同一個canvas。

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

  • 超過jsPDF實例格式尺寸的內容不顯示( varpdf=newjsPDF('','pt','a4');demo中就是a4紙的尺寸)
  • addImage有兩個參數可以控制圖片在pdf中的位置

雖然每一頁pdf上顯示的圖片是相同的,但我們通過調整圖片的位置,產生了分頁的錯覺。以第二頁為例,將豎直方向上的偏移設置為 -841.89即一張a4紙的高度,又因為超過a4紙高度范圍的圖片不顯示,所以第二頁顯示了圖片豎直方向上[841.89,1682.78]范圍內的內容,這就得到了分頁的效果,以此類推。

還是看代碼吧:

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'
);
      
//有兩個高度需要區分,一個是html頁面的實際高度,和生成pdf的頁面高度(841.89)
      
//當內容未超過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方向參數設置你要的邊距,具體代碼如下:

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);

 

以上就是本文全部分享,有不懂的可以加我qq:421217189 15274527


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM