当前位置: 首页 > 工具软件 > HTML2PDF > 使用案例 >

vue.js+jspdf.js+html2pdf.js 实现页面导出PDF

梁兴文
2023-12-01

vue.js+jspdf.js+html2pdf.js 实现页面导出PDF

原本是导出word但客户考虑到问到的安全性要求改成了PDF,由于之前的word导出也是有前端生成的,所以为了不增加工作量导出依旧有前端完成。起初在网上找了很多方法都无法实现,都想放弃了让后端写,后来看到了关于jspdf.js+html2canvas.js的文章,想着试试看吧。对于前端导出PDF我就是个小白,啥也不会。按着文章一步步写吧。

安装插件html2canvas和jspdf

npm install html2canvas--save
npm install jspdf --save

在项目中引入

新建htmlToPdf.js

我直接在自己新建的common文件夹中新建了htmlToPdf.js
scale 这个属性还是需要设置一下的,一开始没有设置导致导出的PDF很模糊。
htmlToPdf.js 代码根据自己实现有稍作修改

import html2canvas from 'html2canvas';
import JsPDF from 'jspdf';

/**
 * @param  ele          要生成 pdf 的DOM元素(容器)
 * @param  padfName     PDF文件生成后的文件名字
 * */

function downloadPDF(ele, pdfName){

  let el=document.getElementById(ele)  //通过getElementById获取要导出的内容
  let eleW = el.offsetWidth;// 获得该容器的宽
  let eleH = el.offsetHeight;// 获得该容器的高

  let eleOffsetTop = el.offsetTop;  // 获得该容器到文档顶部的距离
  let eleOffsetLeft = el.offsetLeft; // 获得该容器到文档最左的距离
  var canvas = document.createElement("canvas");
  var abs = 0;
  let win_in = document.documentElement.clientWidth || document.body.clientWidth; // 获得当前可视窗口的宽度(不包含滚动条)
  let win_out = window.innerWidth; // 获得当前窗口的宽度(包含滚动条)

  if(win_out>win_in){
    abs = (win_out - win_in)/2;    // 获得滚动条宽度的一半
  }
  canvas.width = eleW * 2;    // 将画布宽&&高放大两倍
  canvas.height = eleH * 2;

  var context = canvas.getContext("2d");
  context.scale(2, 2);
  context.translate(-eleOffsetLeft -abs, -eleOffsetTop);

  html2canvas( el, {
    dpi: 96,     //分辨率
    scale: 2,    //设置缩放
    useCORS:true,  //允许canvas画布内 可以跨域请求外部链接图片, 允许跨域请求。,
    //backgroundColor:'#ffffff',这样背景还是黑的
    bgcolor :'#ffffff',//应该这样写
    logging:false   //打印日志用的 可以不加默认为false
  } ).then( (canvas)=>{
    // el.setAttribute("crossOrigin",'anonymous');
    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 = 595.28/contentWidth * contentHeight;
    let pageData = canvas.toDataURL('image/jpeg', 1.0);
    var pdf = new JsPDF('', 'pt', 'a4');

    if (leftHeight < pageHeight) {
      //在pdf.addImage(pageData, 'JPEG', 左,上,宽度,高度)设置在pdf中显示;
      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(pdfName);
  })
}
export default {
  downloadPDF
}
在main.js中引入
import htmlToPdf from '../src/common/htmlToPdf';
Vue.use(htmlToPdf)
vue页面应用

由于我的页面很长有十几个表格,所以我预先把每个表格的样式设置好,这样导出时就不会出现被割掉的现象。但不知道到有没有更好的方法。

<template>
  <div :id="resultOriginal" class="portrait">
    <div class="box" style="">
        //表一
    </div>
    <div class="box" style="">
        //表二
    </div>
    ...  //这里是你要导出的内容
  </div>
</template>

<script>
  import htmlToPdf from "../../../common/htmlToPdf";
    export default {
        name: "expResultOriginal",
      data(){
        return{
          ...
        }
      },
      created(){
          
      },
      methods:{
        handleExport1(){
          htmlToPdf.downloadPDF("resultOriginal","报告单原始记录") 
          //第一个参数是需要导出的内容的id,第二个参数是输出的文档名称
        },   
      }
    }
</script>
<style scoped>
  .box{
    width:792px;
    height:837.51pt;
    padding:30px calc((792px - 509.3pt) / 2);
    /*border: 1px solid #ccc;*/
    margin: 0 auto 4px auto;
    background: white;
    position: relative;
    color: black;
    font-weight: normal;
  }
</style>

看到这里你基本上应该可以实现导出了。对了,html2canvas.js好像不兼容IE的,因为时间关系暂时都让他们用的谷歌,之后版本升级再改。

遇到的坑

显示不清晰

上文也有提到,一开始导出的问到就是很模糊,一直被嫌弃。我明明设置了dpi这个属性,但是这个值不过设的多大多小就是不行,我电脑清晰了,可是客户的依旧模糊。后来在网上查html2canvas由哪些属性,发现scale 这个可以设置缩放比。我设置成了2,终于清晰了。

the scale to use for rendering.Defaults to the browsers device pixel ratio

图片问题(未解决)

我做了预览功能,图片在页面上能正常的显示,但是导出就不行。又开始了百度之旅,统一答案就是你跨域啦。好的吧,那就改呗。

//htmlToPdf.js
useCORS:true     
//vue页面中
<img style="width: 679px;max-width: 679px;max-height:930px" crossorigin="anonymous" :src="item.path">

以上这两个都加上了,跨域解决了。但是新的问题又来了,图片显示不全。在文档数据量不大时图片可以正常显示,但文档内容一多图片就不见了。猜测是渲染时间不够,还没加载完成就导出了。也试了很多方法,就是不行。还在寻找解决方法。

2020.9.22更新

图片确实是渲染时间不够导致无法显示,但是没有找到关键代码,为了不耽误甲方上线时间改用了dom-to-image。但是这个插件也是有问题的,我的报告大概超过三十页之后就无法导出了,因为转成Base64后太长了。和甲方确认过基本上都是少于三十页的,所以暂时就用这个了,后期版本更新再换后端导出。以下是dom-to-image的代码,我是把之前的htmlToPdf.js内容修改的,文件还是放在原来的位置。大致内容相同,只是替换了将html转成图片的方法。

import JsPDF from 'jspdf';
import domtoimage from 'dom-to-image';

/**
 * @param  ele          要生成 pdf 的DOM元素(容器)
 * @param  padfName     PDF文件生成后的文件名字
 * */

function downloadPDF(ele, pdfName){

  let el=document.getElementById(ele)
  let eleW = el.offsetWidth;// 获得该容器的宽
  let eleH = el.offsetHeight;// 获得该容器的高

  var canvas = document.createElement("canvas");

  canvas.width = eleW * 2;    // 将画布宽&&高放大两倍
  canvas.height = eleH * 2;

  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 = 595.28/contentWidth * contentHeight;

  domtoimage.toJpeg(el,
    {
      quality: 0.85,    //清晰度
      width:eleW,
      height:eleH,
      scale:2,
    })
    .then((dataUrl)=>{
      let pageData = dataUrl;
      var pdf = new JsPDF('', 'pt', 'a4');
      //有两个高度需要区分,一个是html页面的实际高度,和生成pdf的页面高度(841.89)
      //当内容未超过pdf一页显示的范围,无需分页
      if (leftHeight < pageHeight) {
        //在pdf.addImage(pageData, 'JPEG', 左,上,宽度,高度)设置在pdf中显示;
        pdf.addImage(pageData, 'JPEG', 0, 0, imgWidth, imgHeight);
        // pdf.addImage(pageData, 'JPEG', 20, 40, 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(pdfName);
    })
    .catch(function (err) {
      console.error('wrong!',err)
    })
}
export default {
  downloadPDF
}
2020.12.24更新

之前说的dom-to-image这个插件在导出到三十页的样子就报错了,现在我想了个很傻的方法,就是把报告截成两半,在上一半生成后再去执行下一半的,最后执行PDF导出的功能。办法虽傻但至少目前来说是可行的。有人说toSVGde 方法可能可用,试了一下对我的不可行。但是这个插件可参考的内容太少了,还是要好好研究一下。

到底了,希望能帮到你。

 类似资料: