所见即所得——HTML转图片组件开发

政采云前端团队

发布于 2022-12-01 11:19:07

3.2K0

发布于 2022-12-01 11:19:07

文章被收录于专栏：采云轩

前言

在我们日常开发中一定会遇到"所见即所得"的需求，如导出查询表格中的内容为 Excel 表格——《前端导出 Excel，让后端刮目相看》(https://juejin.cn/post/7030291455243452429)、通过后台网页配置实现配置预览页与实际页面展示的统一——《从零开发一款可视化大屏制作平台》(https://juejin.cn/post/6937257727106220040)。

今天我们也来实现一个"所见即所得"的需求：将用户所见网页提取为图片。

方案 1：最短步骤实现结果

第一个想到的方案就是通过浏览器自带的网页另存为图片去实现。

但这种方法显然是不可行的。第一需要提示用户操作进行繁琐的操作，第二无法达到局部提取为图片的效果。

方案 2：达成初步可行方案

通过调研发现，可以使用 html2canvas(http://html2canvas.hertzen.com/) 将网页先转换为 canvas 数据。再将其转换为图片的方法，最终实现我们想要的功能。

引入 html2canvas

cnpm install --save html2canvas

HTML

<div class="box">
    <!-- 将可保存为图片的内容 通过一个 标签 框起来 -->
    <div id="screenshot-box">
      <!-- 内容可以随意 -->
      <p>名称：<a-input v-model="formState.name" /></p>
      <p>年龄：<a-input v-model="formState.age" /></p>
      <p>
        班级：
        <a-radio-group v-model="formState.class">
          <a-radio value="1">班级1</a-radio>
          <a-radio value="2">班级2</a-radio>
        </a-radio-group>
      </p>
    </div>
    <a-button  @click="onSaveCanvas">保存为图片</a-button>
  </div>

// 点击保存为 Canvas
    onSaveCanvas(){
       // 这里的类名要与点击事件里的一样
        const canvas = document.querySelector('#screenshot-box');
        let that = this;
        html2canvas(canvas,{scale:2,logging:false,useCORS:true}).then(function(canvas) {
          const type = 'png';
          let imgData = canvas.toDataURL(type);
          // 图片格式处理
          let _fixType = function(type) {
          type = type.toLowerCase().replace(/jpg/i, 'jpeg');
          let r = type.match(/png|jpeg|bmp|gif/)[0];
          return 'image/' + r;
        };
            imgData = imgData.replace(_fixType(type),'image/octet-stream');
            let filename = "htmlImg" + '.' + type;
            // 保存为文件
            //  以bolb文件下载
 that.downFileToLocal(filename,that.convertBase64ToBlob(imgData))
        });
    },

如此我们便实现了初步的功能

当然，我们也可以设置一个预览图片来预览我们将要导出的图片

HTML

<img :src="previewPic" alt="预览图片">

this.previewPic = URL.createObjectURL(that.convertBase64ToBlob(imgData));

展示效果

将方案进行拓展并升级

需求止步于此，但秉承着"将事情做的更好"的我们岂能止步于此。

实现 HTML 导出为 Word

我们需要通过 html-docx 来实现导出为 Word（导出 Word 目前只支持原生 HTML + CSS）。

引入 html-docx

cnpm install --save html-docx-js

HTML

<div id="export-word">
      <table border >
        <tr>
          <th>姓名</th>
          <th>年龄</th>
        </tr>
        <tr>
          <td>贾维斯</td>
          <td>2</td>
        </tr>
      </table>
    </div>
    <a-button  @click="onWordExport">导出为word</a-button>

onWordExport(){
        var contentHtml = document.getElementById("export-word").innerHTML;
        const cssHTML = `table {
                          width: 200px;
                          border: 1px solid #ccc;
                          color:red;
                        }`
        var content = `<!DOCTYPE html><html>
            <head>
                <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
                <style>
                    ${cssHTML}
                </style>
            </head>
            <body>
                ${contentHtml}
            </body>
            </html>`
        var converted = htmlDocx.asBlob(content,{orientation:"landscape"});
        this.downFileToLocal('word文件名.docx',converted)
    }

展示效果

如此我们便实现了导出 HTML 为 Word。

实现 HTML 导出为 PDF

目前市面上 HTML 导出 PDF 的实现方式有多种，如 jsPDF (https://github.com/parallax/jsPDF)、iText (https://blog.csdn.net/weixin_43897590/article/details/124729389)、wkhtmltopdf (https://github.com/wkhtmltopdf/wkhtmltopdf) 等。在不同情况下我们应该使用不同的解决方案：

方案	优点	缺点	分页	图片	表格	链接	中文	特殊字符
jsPDF	1、整个过程在客户端执行(不需要服务器参与)，调用简单	1、生成的 pdf 为图片形式，且内容失真	支持	支持	支持	不支持	支持	支持
iText	1、功能基本可以实现，比较灵活 2、生成 pdf 质量较高	1、对 html 标签严格，少一个结束标签就会报错；2、后端实现复杂，服务器需要安装字体；3、图片渲染比较复杂	支持	支持	支持	支持	支持	支持
wkhtmltopdf	1、调用方式简单；2、生成pdf质量较高	1、服务器需要安装 wkhtmltopdf 环境；2、根据网址生成 pdf，对于有权限控制的页面需要在拦截器进行处理	支持	支持	支持	支持	支持	支持

今天我们使用在客户端执行(不需要服务器参与)的方式——jsPDF。

导入 jsPDF

npm install --save jspdf

HTML

 <a-button  @click="onPDFExport">导出为PDF</a-button>

// 导出为 PDF
    onPDFExport(){
      const canvas = document.querySelector('#screenshot-box');
      html2canvas(canvas).then(function(canvas) {
        let contentWidth = canvas.width;
            let contentHeight = canvas.height;
            //一页 pdf 显示 html 页面生成的 canvas 高度;
            let pageHeight = contentWidth / 592.28 * 841.89;
            //未生成 pdf 的 html 页面高度
            let leftHeight = contentHeight;
            //页面偏移
            let position = 0;
            //a4 纸的尺寸[595.28,841.89]，html 页面生成的 canvas 在 pdf 中图片的宽高
            let imgWidth = 595.28;
            let imgHeight = 592.28/contentWidth * contentHeight;

            let pageData = canvas.toDataURL('image/jpeg', 1.0);

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

展示效果

如此我们便实现了导出 HTML 为 PDF。

将功能封装为组件

实现一次 HTML 导出图片需要写的代码太多，很多参数也需要按需定制。是否能够将其封装成组件呢？

我们可以通过 Vue 的插槽 (https://v2.cn.vuejs.org/v2/api/#v-slot) 将我们导出的内容进行插入

完整组件

<template>
  <div class="box">
    <!-- 将可保存为图片的内容 通过一个 标签 框起来 -->
    <div :id="id">
        <!-- 需要导出的内容 -->
        <slot></slot>
    </div>
  </div>
</template>
<script>
//引入 html2canvas
import html2canvas from 'html2canvas';
export default {
  name: "Html2Image",
  props: {
    id: { // id
      type: String,
      default: 'export-box',
    },
    filename: { // 导出文件名称
      type: String,
      default: 'htmlPic',
    },
    outType:{ // 导出类型
      type: String,
      default: 'png',
      validator(value) {
        return ['png', 'jpg', 'bmp','jpeg','gif'].includes(value)
      }
    },
    isFile: { // 是否为导出文件
      type: Boolean,
      default: false,
    },
    
  },
  methods: {
    //点击保存为 Canvas
    onSaveCanvas(){
       // 这里的类名要与点击事件里的一样
        const canvas = document.querySelector(`#${this.id}`);
        let that = this;
        html2canvas(canvas,{scale:2,logging:false,useCORS:true}).then(function(canvas) {
          const type = that.outType;
          let imgData = canvas.toDataURL(type);
          
          // 图片格式处理
          let _fixType = function(type) {
            type = type.toLowerCase().replace(/jpg/i, 'jpeg');
            let r = type.match(/png|jpeg|bmp|gif/)[0];
            return 'image/' + r;
          };
          imgData = imgData.replace(_fixType(type),'image/octet-stream');
          if(!that.isFile){
              const retn = URL.createObjectURL(that.convertBase64ToBlob(imgData))
              that.$emit('onExport',retn)
              return retn
          }
          //  以 bolb 文件下载
          that.downFileToLocal(that.filename + '.' + type,that.convertBase64ToBlob(imgData))
        });
    },
    // base64 转化为 Blob 对象
    convertBase64ToBlob(imageEditorBase64) {
      let base64Arr = imageEditorBase64.split(",");
      let imgtype = "";
      let base64String = "";
      if (base64Arr.length > 1) {
        //如果是图片 base64，去掉头信息
        base64String = base64Arr[1];
        imgtype = base64Arr[0].substring(
          base64Arr[0].indexOf(":") + 1,
          base64Arr[0].indexOf(";")
        );
      }
      // 将 base64 解码
      let bytes = atob(base64String);
      //let bytes = base64;
      let bytesCode = new ArrayBuffer(bytes.length);
      // 转换为类型化数组
      let byteArray = new Uint8Array(bytesCode);
 
      // 将 base64 转换为 ascii 码
      for (let i = 0; i < bytes.length; i++) {
        byteArray[i] = bytes.charCodeAt(i);
      }
      // 生成 Blob 对象（文件对象）
      return new Blob([bytesCode], { type: imgtype });
    },
    // 下载 Blob 流文件
    downFileToLocal(fileName, blob) {
      // 创建用于下载文件的 a 标签
      const d = document.createElement("a");
      // 设置下载内容
      d.href = URL.createObjectURL(blob);
      // 设置下载文件的名字
      d.download = fileName;
      // 界面上隐藏该按钮
      d.style.display = "none";
      // 放到页面上
      document.body.appendChild(d);
      // 点击下载文件
      d.click();
      // 从页面移除掉
      document.body.removeChild(d);
      // 释放 URL.createObjectURL() 创建的 URL 对象
      window.URL.revokeObjectURL(d.href);
    },
  },
};
</script>

Attributes

参数	类型	说明
id	String	唯一 ID，盒子内容将作为导出内容
filename	String	导出的文件名称（不带文件类型后缀）
outType	String	导出文件类型
isFile	Boolean	是否导出为文件，true 将下载文件，false 返回 bolb 路径

Methods

方法	名称	说明
onSaveCanvas	执行导出或保存方法	若 isFile 为 true 则保存文件，若 isFile为false 则返回 bolb 路径

Events

方法	名称	说明
onExport	导出方法	当触发导出/下载时会触发该方法输出 Bolb 路径类型 String

使用组件

HTML

<Html2Image ref="html2Image" @onExport="exportPic" >
      <div class="export-content" style="border: 1px solid #F0F;width:200px">
        <div>1</div>
        <div>2</div>
        <div>3</div>
      </div>
    </Html2Image>
<a-button  @click="onExportImgByComponent">组件导出为图片</a-button>

// 引入组件
import Html2Image from '@/components/Html2Image/Html2Image.vue'
// 使用组件
components: { 
    Html2Image
},

// methods
onExportImgByComponent(){
      this.previewPicComponent =this.$refs.html2Image.onSaveCanvas()
    },
exportPic(baseUrl){
       // 赋值导出图片的 blob 路径
      this.previewPicComponent = baseUrl;
    },

Q&A

Q. 为什么外网图片展示不出?

A: 设置 html2canvas 方法中 useCORS 为 true 即可。

最后要说的

项目地址: https://github.com/FireSmallPanda/vuexDemo.git

HTML导出为图片组件地址: https://github.com/FireSmallPanda/vuexDemo/tree/master/src/components/ImageUpload

根据需求目前只封装了 HTML 导出为图片，相信大家可以依葫芦画瓢将导出 Word 和 PDF 也一并封装为组件。

参考文章

《前端实现将页面保存成图片功能》(https://blog.csdn.net/liuzemtx/article/details/109307540)

《base64 字串转 Blob 文件流，Blob 文件流再下载到本地》(https://blog.csdn.net/xiao970615/article/details/126305092)

《render-html-to-pdf》(https://gitcode.net/mirrors/linwalker/render-html-to-pdf?utm_source=csdn_github_accelerator) 《HTML 页面导出为 PDF》(https://blog.csdn.net/lisheng19870305/article/details/124158191)

外网图片来源——《风光摄影精选》(https://landscape.tuchong.com/)

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2022-10-11，如有侵权请联系 cloudcommunity@tencent.com 删除

https