338

最近碰到个需求,需要把当前页面生成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


如果觉得我的文章对你有用,请随意赞赏
已赞赏

你可能感兴趣的

67 条评论
MangGoDio · 2017年07月03日

HTML生成的图片特别长,分页的时候根据高度分有时候就会出现一半文字在上一页一半文字在下一页的问题,请问楼主有什么好点的解决思路么

+5 回复

0

同问

麓_i · 2018年01月22日
0

同问

Kikyou · 2018年01月23日
0

你们处理了没?求解

轶马当仙 · 2018年06月25日
斌套餐 · 2017年04月29日

小小

回复

灬wk · 2017年06月21日

你好,下载下来pdf不清楚怎么破,谢谢

回复

0

@灬wk 你这个问题是怎么解决的呢?我现在也碰到了这个问题下载下来的PDF很模糊

zhang · 2018年07月15日
0

@灬wk 有高清的那个js,你搜一下,绝对高清

塞风 · 2018年08月07日
Leo_99 · 2017年06月22日

添加页眉页脚,生成目录可以破吗?

回复

0

这不太好做,这个demo例子是吧整个document.body转成canvas,再利用jsPDF转成pdf

linwalker 作者 · 2017年06月27日
0

恩,最后用pdfmake做的,页面中的图片、echarts图表等元素用html2canvas转成canvas放进去的,好处是他能自动分页,够清晰,页眉页脚也都可以。缺点是得专门做配置项,另外目前还没有生成目录的功能。。。

Leo_99 · 2017年06月28日
0

求发个有页眉页脚的demo例子

fxk01 · 2018年01月16日
灬wk · 2017年06月22日

还有发现了个问题,谷歌好好的,但是火狐会出现漏页,和黑页面,ie直接报错了。。。。。

回复

0

浏览器兼容我没试过,可能两个插件对浏览器支持的不一样

linwalker 作者 · 2017年06月27日
0

我也遇到同样的问题,IE目前还不支持promise方法

shadow · 2017年10月18日
惜音 · 2017年09月17日

var pageHeight = contentWidth / 592.28 * 841.89;为什么不是/595.28呢?

回复

0

..不小心打错了

linwalker 作者 · 2017年11月04日
粉红顽皮豹 · 2017年10月11日

复制了一份 下载下来的pdf怎么是黑屏呢?

回复

hanbin · 2017年10月16日

前台生成pdf也会出现黑屏,当量大了之后

回复

Suavity · 2017年10月17日

打印按钮要放在页面的最上方才能打印完全~ 放在中间位置,则只会导出浏览器目前能看到的页面内容

回复

老黑 · 2017年11月22日

您好,怎么能控制PDF强制分页,比如我在第一页显示个标题,第二页显示内容呢!大神 求解。

回复

0

请问这个问题你解决了吗

一米阳光 · 2018年12月03日
0
tinxlj · 5月31日
伪造者 · 2017年11月28日

您好,您这个可以调整PDF方向么,就是我要的PDF是横向的可以么

回复

蓠人 · 2017年12月22日

您好,要打印的内容放到弹窗里边,除了第一页,后面的都是黑屏怎么解决?

回复

十三 · 2018年01月05日

您好,这个可以支持table表单吗,我这里生成的没有表格边框

回复

0

我的也没有表格,而且还是黑的背景

rxfworkspace · 2018年01月12日
rxfworkspace · 2018年01月12日

您好,这种不支持表格转化吗?

回复

E克儿 · 2018年01月17日

您好,请问html高度过大时,得到的图片地址是空的,就是说没有截图成功是什么原因呢,html高度不是特别特别大时,就正常

回复

清减半夏时光 · 2018年03月22日

这个生成的.pdf怎么预览,是用output这个函数吗?

回复

0
塞风 · 2018年08月07日
0

PDF.output(“datauristring”)

清减半夏时光 · 2018年08月07日
强子 · 2018年05月08日

大佬好,我生成后的pdf出现了文字重叠现象,怎么破

回复

0

遇到同样的问题了,你的解决了没有?

高彦涛 · 2018年07月10日
0

@强子 我也遇到了,比如在一个p元素中,文字自动换行的情况下,这时候下载pdf就可能文字重叠。我的办法是人为添加br

塞风 · 2018年08月07日
Zengnificant · 2018年07月12日

很有想法,不过主流浏览器都默认有这功能,生成的pdf上的文字可以用鼠标复制,图片清晰,可以预览,但是只能手动,说的没错,就是浏览器的打印功能。

回复

0

@高彦涛 浏览器的打印功能就很好用了,如果不是要大批量使用,应该很好的解决你的问题了。

Zengnificant · 2018年07月12日
zhang · 2018年07月15日

请问下载下来的PDF不清楚,会有些模糊,应该怎么解决呢

回复

0

@zhang 有个高清版本的htmlcanvas,你搜一下

塞风 · 2018年08月07日
李别有 · 2018年09月07日

为什么 我按照这个弄完后 点击下载PDF无法生成

回复

0

我再一个页面引入了 3个JS 然后写了2个function,后去页面点击 下载按键,为何一点反应么有

李别有 · 2018年09月07日
0

(属性“downPDF”的值为 null、未定义或不是 Function 对象),页面给我报了一个值为空的错误

李别有 · 2018年09月07日
载入中...