最近碰到个需求,需要把当前页面生成 pdf,并下载。弄了几天,自己整理整理,记录下来,我觉得应该会有人需要 :)

先来科普两个插件:

我们可以直接在浏览器端使用html2canvas,对整个或局部页面进行“截图”。但这并不是真的截图,而是通过遍历页面DOM结构,收集所有元素信息及相应样式,渲染出canvas image。由于html2canvas只能将它能处理的生成canvas image,因此渲染出来的结果并不是100%与原来一致。但它不需要服务器参与,整个图片都由客户端浏览器生成,使用很方便。使用使用的API也很简洁,下面代码可以将某个元素渲染成canvas:

  1. html2canvas(element, {
  2. onrendered:
  3. function
  4. (canvas) {
  5. // canvas is the final rendered <canvas> element
  6. }
  7. });

 

  1. html2canvas(element, {
  2. onrendered:
  3. function
  4. (canvas) {
  5. document.body.appendChild(canvas);
  6. }
  7. });
  1. <html>
  2. <head>
  3. <title>
  4. html2canvas example
  5. </title>
  6. <style
  7. type
  8. =
  9. "text/css"
  10. >
  11. ...
  12. </style>
  13. </head>
  14. <body>
  15. <header>
  16. <nav>
  17. <ul>
  18. <li>
  19. one
  20. </li>
  21. ...
  22. </ul>
  23. </nav>
  24. </header>
  25. <section>
  26. <aside>
  27. <h3>
  28. it is a title
  29. </h3>
  30. <a
  31. href
  32. =
  33. ""
  34. >
  35. Stone Giant
  36. </a>
  37. ...
  38. </aside>
  39. <article>
  40. <img
  41. src
  42. =
  43. "./Stone.png"
  44. >
  45. <h2>
  46. Stone Giant
  47. </h2>
  48. <p>
  49. Coming ...
  50. </p>
  51. <p>
  52. 以一团石头...
  53. </p>
  54. </article>
  55. </section>
  56. <footer>
  57. write by linwalker @2017
  58. </footer>
  59. <script
  60. type
  61. =
  62. "text/javascript"
  63. src
  64. =
  65. "./html2canvas.js"
  66. ></script>
  67. <script
  68. type
  69. =
  70. "text/javascript"
  71. >
  72. html2canvas(document.body, {
  73. onrendered:
  74. function
  75. (canvas) {
  76. document.body.appendChild(canvas)
  77. }
  78. })
  79. </script>
  80. </body>
  81. </html>

这个例子将页面body中的元素渲染成canvas,并插入到body中。

  1. // 默认a4大小,竖直方向,mm单位的PDF
  2. var
  3. doc =
  4. new
  5. jsPDF();
  6. // 添加文本‘Download PDF’
  7. doc.text(
  8. \'Download PDF!\'
  9. ,
  10. 10
  11. ,
  12. 10
  13. );
  14. doc.save(
  15. \'a4.pdf\'
  16. );
  1. // 三个参数,第一个方向,第二个单位,第三个尺寸格式
  2. var
  3. doc =
  4. new
  5. jsPDF(
  6. \'landscape\'
  7. ,
  8. \'pt\'
  9. ,[
  10. 205
  11. ,
  12. 115
  13. ])
  14. // 将图片转化为dataUrl
  15. var
  16. imageData = data:image/png;base64,iVBORw0KGgo...’;
  17. doc.addImage(imageData,
  18. \'PNG\'
  19. ,
  20. 0
  21. ,
  22. 0
  23. ,
  24. 205
  25. ,
  26. 115
  27. );
  28. doc.save(
  29. \'a4.pdf\'
  30. );
  1. // 三个参数,第一个方向,第二个尺寸,第三个尺寸格式
  2. var
  3. doc =
  4. new
  5. jsPDF(
  6. \'landscape\'
  7. ,
  8. \'pt\'
  9. ,[
  10. 205
  11. ,
  12. 155
  13. ])
  14. // 将图片转化为dataUrl
  15. var
  16. imageData = data:image/png;base64,iVBORw0KGgo...’;
  17. //设置字体大小
  18. doc.setFontSize(
  19. 20
  20. );
  21. //10,20这两参数控制文字距离左边,与上边的距离
  22. doc.text(
  23. \'Stone\'
  24. ,
  25. 10
  26. ,
  27. 20
  28. );
  29. // 0, 40, 控制文字距离左边,与上边的距离
  30. doc.addImage(imageData,
  31. \'PNG\'
  32. ,
  33. 0
  34. ,
  35. 40
  36. ,
  37. 205
  38. ,
  39. 115
  40. );
  41. doc.save(
  42. \'a4.pdf\'
  43. )

生成pdf需要把转化的元素添加到jsPDF实例中,也有添加html的功能,但某些元素无法生成在pdf中,因此可以使用html2canvas + jsPDF的方式将页面转成pdf。通过html2canvas将遍历页面元素,并渲染生成canvas,然后将canvas图片格式添加到jsPDF实例,生成pdf。

介绍完毕,开始开工了:

将demo1的例子修改下:

  1. <script type=
  2. "text/javascript"
  3. src=
  4. "./js/jsPdf.debug.js"
  5. ></script>
  6. <script type=
  7. "text/javascript"
  8. >
  9. var
  10. downPdf = document.getElementById(
  11. "renderPdf"
  12. );
  13. downPdf.onclick =
  14. function
  15. () {
  16. html2canvas(document.body, {
  17. onrendered:
  18. function
  19. (canvas) {
  20. //返回图片dataURL,参数:图片格式和清晰度(0-1)
  21. var
  22. pageData = canvas.toDataURL(
  23. \'image/jpeg\'
  24. ,
  25. 1.0
  26. );
  27. //方向默认竖直,尺寸ponits,格式a4[595.28,841.89]
  28. var
  29. pdf =
  30. new
  31. jsPDF(
  32. \'\'
  33. ,
  34. \'pt\'
  35. ,
  36. \'a4\'
  37. );
  38. //addImage后两个参数控制添加图片的尺寸,此处将页面高度按照a4纸宽高比列进行压缩
  39. pdf.addImage(pageData,
  40. \'JPEG\'
  41. ,
  42. 0
  43. ,
  44. 0
  45. ,
  46. 595.28
  47. ,
  48. 592.28
  49. /canvas.width * canvas.height );
  50. pdf.save(
  51. \'stone.pdf\'
  52. );
  53. }
  54. })
  55. }
  56. </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是肿么来的,不用拉上去,直接看下面:

  1. html2canvas(document.body, {
  2. onrendered:
  3. function
  4. (canvas) {
  5. //it is here we handle the canvas
  6. }
  7. })

这里的 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]范围内的内容,这就得到了分页的效果,以此类推。

还是看代码吧:

  1. html2canvas(document.body, {
  2. onrendered:
  3. function
  4. (canvas) {
  5. var
  6. contentWidth = canvas.width;
  7. var contentHeight = canvas.height;
  8. //一页pdf显示html页面生成的canvas高度;
  9. var pageHeight = contentWidth / 592.28* 841.89;
  10. //未生成pdf的html页面高度
  11. var leftHeight = contentHeight;
  12. //页面偏移
  13. var
  14. position =
  15. 0
  16. ;
  17. //a4纸的尺寸[595.28,841.89],html页面生成的canvas在pdf中图片的宽高
  18. var
  19. imgWidth = 595.28
  20. ;
  21. var
  22. imgHeight = 592.28
  23. /contentWidth * contentHeight;
  24. var
  25. pageData = canvas.toDataURL(
  26. \'image/jpeg\', 1.0
  27. );
  28. var
  29. pdf = new jsPDF(
  30. \'\', \'pt\', \'a4\'
  31. );
  32. //有两个高度需要区分,一个是html页面的实际高度,和生成pdf的页面高度(841.89)
  33. //当内容未超过pdf一页显示的范围,无需分页
  34. if
  35. (leftHeight < pageHeight) {
  36. pdf.addImage(pageData,
  37. \'JPEG\', 0, 0, imgWidth, imgHeight );
    }
  38. else
  39. {
  40. while
  41. (leftHeight >
  42. 0
  43. ) {
  44. pdf.addImage(pageData,
  45. \'JPEG\', 0, position, imgWidth, imgHeight)
  46. leftHeight -= pageHeight;
  47. position -= 841.89
  48. ;
  49. //避免添加空白页
  50. if
  51. (leftHeight >
  52. 0
  53. ) {
  54. pdf.addPage();
  55. }
  56. }
  57. }
  58. pdf.save(
  59. \'content.pdf\'
  60. );
  61. }
  62. })

 

修改imgWidth,并且在addImage时x方向参数设置你要的边距,具体代码如下:

  1. var imgWidth =
  2. 555.28
  3. ;
  4. var imgHeight =
  5. 555.28
  6. /contentWidth * contentHeight;
  7. ...
  8. pdf.addImage(pageData,
  9. \'JPEG\'
  10. ,
  11. 20
  12. ,
  13. 0
  14. , imgWidth, imgHeight );
  15. ...
  16. pdf.addImage(pageData,
  17. \'JPEG\', 20, position, imgWidth, imgHeight);

 

版权声明:本文为jinzhenzong原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://www.cnblogs.com/jinzhenzong/p/9328985.html