Javascript 將html轉成pdf,下載,支援多頁哦（html2canvas 和 jsPDF）

linwalker發表於2017-04-26
JavaScriptHTMLCanvasJS

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

專案原始碼地址：https://github.com/linwalker/...

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

線上演示demo2

圖片生成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');

線上演示demo3

文字與圖片生成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')

線上演示demo4

生成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>

線上演示demo5

如果頁面內容根據a4比例轉化後高度超過a4紙高度呢，生成的pdf會怎麼樣？會分頁嗎？

你可以試試，驗證一下自己的想法: demo6

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例項格式尺寸的內容不顯示
（var pdf = new jsPDF('', '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');
  }
})

線上演示demo7

兩邊留邊距

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

線上演示demo8

相關文章