内卷时代下的前端技术-使用JavaScript在浏览器中生成PDF文档

计量领域中，计量检定是一种重要形式，主要用于评定计量器具的计量性能，确定其量值是否准确一致，实现手段包括计量检验、出具检定证书和加封盖印等。

在检定证书这一环节，存在一个难点，就是无法在线预览以及智能生成。

1、证书管理不能满足用户精准打印、特殊字符或多页打印的需求。因为在计量行业中，精密仪器较多，往往会存在一些特殊字符的应用或者会使用某些较为复杂的测量单位。

2、系统不支持批量证书更新以及批量打印等功能，在常见的场景中，出具证书是需要进行批量导出的过程。

3、无法满足实时打印预览或者PDF预览，这样直至打印前都无法确定打印的格式、范围等是否符合需求。

在这篇分享中，我们将帮助大家着重解决两个问题：

1、在浏览器中生成PDF文件；

2、解决中文以及特殊字符导出PDF乱码的问题。

在浏览器中生成PDF文件。前端生成PDF文件纯依赖于客户端的浏览器资源，对于不同的终端，导出PDF的难度会比服务端有所增加。市面上主流的浏览器有三四家，例如Chrome、Safari、FireFox等，每个浏览器对于文字内容、CSS属性处理都不一致，有可能某些配置在某个浏览器上可行，换了一个浏览器之后就有可能天差地别。另外，对于原生的PDF文件来说，仅包含英文字体，不包含任何中文字体，因此当导出的内容中含有中文字体编码时，就会显示乱码，所以通常情况下，我们都需要为PDF进行字体注册操作。

前端常见导出PDF方法

目前常用的前端生成PDF文件的方法大致有以下几种。

1、HTML2Canvas的方法将HTML 转换成图片后，在将图转PDF文件。这种方法比较适合单一页面。

2、jsPDF 直接H5转成PDF。

除了上述的方案之后，使用SpreadJS直接在线设计布局，并且可以直接生成PDF文件。带来的好处是什么呢？可视化的操作、代码量少并且可以适配不同的浏览器环境。当然也会有一定的缺点，对于字体较多的文件，需要注册不同的字体，字体文件越大，占用的带宽就越大。另外，当文件比较大的时候，有可能会存在性能问题，不过这个也几乎是前端导出PDF文件的一个瓶颈。那么较为理想的方案便是可以在前端（SpreadJS）设计、展示，最后交由后端来单独导出或者批量导出。

在浏览器中生成PDF文件

介绍了那么多，我们还是回到本篇文章的主题，如何通过前端来生成PDF文件。需要用到SpreadJS以及导出PDF相关的功能，首先需要在页面上引入相关的资源。

然后创建一个用于承载表格实例的DOM。

初始化表格控件并加载已设计好的表单，或者也可以通过setValue的接口实现简单的赋值操作。

想要表单按照指定的要求导出，可以通过代码设置打印相关的配置，也可以用设计器来进行设计。下面是配置打印信息相关的代码。

最后，通过调用savePDF方法，将工作簿对象转为blob，我们可以通过window.open来进行pdf的预览或者通过一些保存文件的插件直接将这个blob保存为PDF文件。

这是open之后的效果，我们可以直接通过浏览器导出PDF文件或者是调用浏览器的打印接口实现打印。

解决中文以及特殊字符导出PDF乱码

正如前面所说的，在国内，使用中文的报告是一件再常见不过的事，在计量检测等相关场景，特殊字符的使用也较多。在没注册对应的字体之前，导出的中文字体和特殊字体都显示的是乱码。因此，还需要处理导出中文以及特殊字符PDF乱码的问题。

前面提到了注册字体，那我们的字体应该怎么来？要什么格式的字体呢？首先，先确认我们的表单需要用到哪些字体，然后去找对应字体的ttf文件（电脑上或者是一些字体网站上都有，需注意版权问题）。找到之后将其转为base64格式的文件。具体如何转，可以找一些在线的文件转换器，不过在线的有可能会因为字体文件太大而崩溃，或者有能力的大佬可以自己写一个转换的工具。然后通过下面的方式去把我们的字体文件存储为一个js文件放到我们的项目中。

初始化表单这些就和上面的操作基本一致了，下面就是关键的注册字体步骤了。我们定义了一个font对象，里面只定义了常规（normal）的字体，里面的simkai.ttf就是我们上面的创建的字体文件。

还有一点需要注意的是，虽然注册了字体，但是要设置对应的中文字体。或者换过来说，你需要在表单上设置什么字体，就去注册对应的字体。

那我们再来看看特殊字符，注册字体与中文字体的步骤是一致的，特殊在于为了想要在页面上显示特殊字符，我们需要通过css的font-face来指定一个font-family。例如创建了一个叫sunway-font的特殊字体，想要在页面上显示。

最后就是通过savePDF方法导出PDF文件，可以看到PDF的中文和特殊字符都可以正常显示。

怎么样？学“废”了吗？不妨试试SpreadJS，“卷”起来。

者 | 大澈

大家好，我是大澈！

遇到难题，可以进问答群，问题直接群里扔，完事总有人会陪你一起搞。

建立这个平台的初衷：

1、打造一个问答平台，一个仅包含前端问题的平台，让大家可以高效处理同样问题。

2、通过不断积累问题，去练习大家的个人逻辑思维，并顺便学习相关的知识点。

3、遇到难题，遇到有共鸣的问题，一起讨论，一起沉淀，一起成长。

ONE

需求分析，问题描述

一、需求

点击导出word按钮，将页面任意指定区域的内容，导出为word文档。

二、问题

1、如何获取指定内容？

2、如何将HTML内容转换为Word文档？

3、如何导出下载Word文档？

TWO

解决问题，答案速览

实现代码如下，复制粘贴即可直接使用。

如果你有时间，具体问题梳理、代码分析、知识总结，可见第三部分。

一、使用说明

参考网上使用最多的方式，使用 FileSaver.js 和 html-docx-js 库（或其它将HTML内容转换为Word文档的库）来在Vue组件中导出内容为Word文档。

但是这种方式只能在服务端实现，在浏览器端使用会报错，这是因为浏览器的安全策略限制了对文件系统的直接访问，以防止恶意脚本滥用用户的文件系统。

为了避免报错，您可以考虑以下解决方案：

1、服务器端导出【推荐】：将生成Word文档的逻辑放在服务器端，通过Vue组件向服务器发送请求，服务器生成并返回Word文档的下载链接或文件。

2、使用其他导出方式：考虑使用其他导出方式，例如将内容转换为PDF格式或生成HTML格式的文件，以避免浏览器限制。

3、考虑使用专门的Word文档生成库【导出复杂Word】：如果您需要在浏览器中生成复杂的Word文档，可以考虑使用专门的JavaScript库，例如docxtemplater或mammoth.js，它们提供了更完整的Word文档生成功能。

4、考虑使用原生的方式实现【导出简单Word】。即我们下面要说的，利用a元素的原生文件下载功能来实现Word导出。

二、代码实例

1、在assets文件夹下新建js文件夹，然后在js文件夹下新建文件exportToWord.js，把下面代码放进去。

// 导出Word
export const exportToWord = (id, name) => {
// 获取选中区域Html
const dom = document.getElementById(id)
const content = dom.innerHTML;
const convertedContent = convertToWordDocument(content);

// Html类型数据 转换为 文件类型数据
const blob = new Blob([convertedContent], { type: 'application/msword' });

// 下载Word文档
const link = document.createElement('a');
link.href = URL.createObjectURL(blob);
link.download = name+'.doc' || 'exported.doc';
link.click();
}

//完善Html格式
const convertToWordDocument = (content) => {
const header = `<!DOCTYPE html><html><head><meta charset='utf-8'><title>Exported Document</title></head><body>`;
const footer = `</body></html>`;

return `${header}${content}${footer}`;
}

2、在需要的组件中引入exportToWord函数，直接调用即可。函数接收两个参数，第一个是指定区域元素的id，第二个是导出Word文档的名称。

<template>
<div>
<div id="word_demo">
<h1>标题</h1>
<p style="color: green">绿色字</p>
<p style="color: red">红色字</p>
<p style="color: dodgerblue">蓝色字</p>
</div>
<button @click="downLoad('word_demo', '哈哈哈')">点击导出word</button>
</div>
</template>

<script>
import { exportToWord } from '@/assets/js/exportToWord'

export default {
methods: {
downLoad(id, name) {
exportToWord(id, name)
},
}
}
</script>

THREE

问题解析，知识总结

一、如何获取指定内容？

这个比较简单，相信大家都会，这里简单提一下。

对于组件可以用ref，对于元素可以用id。

二、如何将HTML内容转换为Word文档？

通过new Blob对象，将Html类型数据转换为生成Word文档的二进制数据。

关于Blob对象：

1、简介：

Blob（Binary Large Object）是JavaScript中的一个接口，用于表示不可变的、原始数据的类似文件的对象。

它通常用于处理二进制数据，例如图像、音频、视频等。

Blob对象可以包含任意类型的数据，包括文本、数组缓冲区和其他Blob对象。

Blob对象在处理文件上传、数据传输和媒体处理等场景中非常有用。您可以将Blob对象发送到服务器、保存到本地文件系统或使用其他API进行进一步处理。

2、Blob对象的构造函数接受以下参数：

Blob(blobParts, options)：构造函数接受两个参数。

第一个参数blobParts是一个数组，其中包含将被包含在Blob对象中的数据。数组的元素可以是字符串、ArrayBuffer、ArrayBufferView、Blob对象或其他类似对象。

第二个参数options是一个可选的对象，用于指定Blob对象的属性。

在options参数中，可以使用以下属性：

type：指定Blob对象的MIME类型。默认值为空字符串。

endings：指定以何种方式标准化换行符。可能的值是transparent、native和\r\n。默认值是transparent。

3、以下是一些常用的Blob属性和方法：

属性：

Blob.size：返回Blob对象的字节大小。

Blob.type：返回Blob对象的MIME类型。

方法：

Blob.slice(start, end, contentType)：

创建并返回一个新的Blob对象，该对象包含原始Blob对象的指定字节范围。可选参数contentType用于指定新Blob对象的MIME类型。

Blob.arrayBuffer()：

返回一个Promise，该Promise解析为一个ArrayBuffer对象，其中包含Blob对象的整个内容。

Blob.text()：

返回一个Promise，该Promise解析为一个字符串，其中包含Blob对象的文本内容。

Blob.stream()：

返回一个ReadableStream对象，可以用于流式读取Blob对象的内容。

Blob.text()：

返回一个Promise，该Promise解析为一个字符串，其中包含Blob对象的文本内容。

Blob.stream()：

返回一个ReadableStream对象，可以用于流式读取Blob对象的内容。

三、如何导出下载Word文档？

通过a元素的 download 属性，来实现文件的导出下载。

在 HTML 中，a元素的 download 属性用于指定一个下载链接，告诉浏览器该链接是要被下载而不是在浏览器中打开。这样，当用户点击链接时，浏览器会弹出一个下载对话框，提示用户保存文件到本地设备。

download 属性的值可以是一个文件名，用于指定用户保存文件时的默认文件名。当用户点击下载链接时，浏览器会使用该值作为默认文件名，但用户仍然可以选择其他文件名保存。

请注意，download 属性并不是所有浏览器都支持的新特性。特别是在移动设备上，某些浏览器可能会忽略该属性并在浏览器中打开链接。因此，在使用 download 属性时，最好提供一个备用方案，例如在链接的文本或旁边添加一段说明，告诉用户右键点击链接并选择 "保存链接" 或类似选项来下载文件。

- END -

何保持页面样式基本不变的前提下将HTML页面导出为PDF，下面提供一些示例代码，纯属个人原创，如对你有帮助请记得加关注、加收藏、点赞、转发、分享~谢谢~~

基本思路：保持页面样式基本不变，使用 `html2canvas` 将页面转换为图片，然后再通过 `jspdf` 将图片分页导出为PDF文件（中间会遇到图片或文字等内容在分页处被切割开的问题，如何解决了？详见末尾干货)

上基础代码：下面为项目中实际代码截取

<div>
    <!-- 要打印的内容区 -->
    <div ref="contentRef">
        <div class="print-item print-out-flow">这是脱离文档流的内容区域</div>
        <div class="print-item">这是一行内容，也是最小叶子元素内容</div>
    </div>
    <!-- 打印内容容器 -->
    <div ref="printContainerRef" class="print-container"></div>
</div>

/**
  * 1.使用一个隐藏div装载有滚动条的div.innerHTML
  * 2.隐藏div使用position: absolute, z-index: -999, left: -9999px, width: 900px 控制让用户无感知
  * 3.根据需要覆写隐藏div内html样式(例如textarea多行显示有问题, 可以新增一个隐藏的div
  *    包裹textarea的绑定值, 然后在打印样式中覆写样式, 隐藏textarea并显示对应div)
  */
handleExport() {
   // 下面是VUE组件内获取DOM元素代码，将内容放置到打印区（定义的隐藏DIV）中
    const contentRef = this.$refs.contentRef as HTMLElement;
    const printContainerRef = this.$refs.printContainerRef as HTMLElement;
    // 打印区的需额外处理绝对定位值, 调整使得第一个元素的.top值为0, 以便于页面计算
    printContainerRef.innerHTML = contentRef.innerHTML;	
    
    // 所有叶子div元素加上 print-item 样式名, 脱离文档流的额外添加 print-out-flow
    handlePrintItem(printContainerRef);  // 解决多页内容可能被切割问题
    
    html2canvas(printContainerRef, {allowTaint: false, useCORS: true}).then((canvas: any) => {
      const contentHeight = canvas.height;
      const contentWidth = canvas.width;
      // pdf每页显示的内容高度
      const pageHeight = contentWidth / 595.28 * 841.89;
      // 未生成pdf的页面高度
      let offsetHeight = contentHeight;
      // 页面偏移值
      let position = 0;
      // a4纸的尺寸[595.28, 841.89], canvas图片按a4纸大小缩放后的宽高
      const imgWidth = 595.28;
      const imgHeight = 595.28 / contentWidth * contentHeight;

      const dataURL = canvas.toDataURL('image/jpeg', 1.0);
      const doc = new jsPDF('p', 'pt', 'a4');

      if (offsetHeight < pageHeight) {
        doc.addImage(dataURL, 'JPEG', 0, 0, imgWidth, imgHeight);
      } else {
        while (offsetHeight > 0) {
          doc.addImage(dataURL, 'JPEG', 0, position, imgWidth, imgHeight);
          offsetHeight -= pageHeight;
          position -= 841.89;

          if (offsetHeight > 0) {
            doc.addPage();
          }
        }
      }

      doc.save(this.generateReportFileName());
      printContainerRef.innerHTML = '';
    });
}

上干货代码：上面分页导出PDF可能网上能看到类型代码，但绝对找不到下面的代码，纯手搓解决分页元素被切开问题（思路：获取自身定位，如自己刚好在被分页处，则加上一定的margin-top值将内容向下移）

/** 
 * 处理打印元素项, 修复分页后被切割的元素
 * @param printContainerRef 打印内容div容器
 * @param itemClassName 打印最小元素标识类名
 * @param outFlowClassName 脱离文档流的元素标识类名
 */
export function handlePrintItem(
  printContainerRef: HTMLElement,
  itemClassName: string = 'print-item',
  outFlowClassName: string = 'print-out-flow'
): void {
  const rootClientRect = printContainerRef.getBoundingClientRect();
  // 初始化页面相关数据
  const totalHeight = rootClientRect.height;  // 内容总高度
  const a4PageHeight = (printContainerRef.clientWidth / 595.28) * 841.89; // a4纸高度
  let pageNum = Math.ceil(totalHeight / a4PageHeight);  // 总页数
  let addPageHeight = 0;  // 修正被分割元素而增加的页面高度总和
  let currentPage = 1;  // 当前正在处理切割的页面
  const splitItemObj: { [key: number]: HTMLElement[] } = {};  // 内容中各页被切割元素存储对象

  const printItemNodes: NodeListOf<HTMLElement> = printContainerRef.querySelectorAll(`.${itemClassName}`);
  for (let item of printItemNodes) {
    // 如果当前页已经是最后一页, 则中断判断
    if (currentPage >= pageNum) {
      break;
    }

    // 获取元素绝对定位数据
    const clientRect = item.getBoundingClientRect();
    let top = clientRect.top;
    const selfHeight = clientRect.height;
    // 如果当前元素距离顶部高度大于当前页面页脚高度, 则开始判断下一页页脚被切割元素
    if (top > currentPage * a4PageHeight) {
      // 换页前修正上一页被切割元素
      addPageHeight += fixSplitItems(currentPage, a4PageHeight, splitItemObj[currentPage], outFlowClassName);
      pageNum = Math.ceil((totalHeight + addPageHeight) / a4PageHeight);
      top = item.getBoundingClientRect().top;
      currentPage++;
    }
    // 如果元素刚好处于两页之间, 则记录该元素
    if (top > (currentPage - 1) * a4PageHeight && top < currentPage * a4PageHeight && top + selfHeight > currentPage * a4PageHeight) {
      if (!splitItemObj[currentPage]) {
        splitItemObj[currentPage] = [];
      }
      splitItemObj[currentPage].unshift(item);
      // 如果当前元素是最后一个元素, 则直接处理切割元素, 否则交由处理下一页元素时再处理切割
      if (item === printItemNodes[printItemNodes.length - 1]) {
        fixSplitItems(currentPage, a4PageHeight, splitItemObj[currentPage], outFlowClassName);
      }
    }
  }
}

/**
  * 修复当前页所有被切割元素
  * @param currentPage 当前页
  * @param pageHeight 每页高度
  * @param splitElementItems 当前被切割元素数组
  * @param outFlowClassName 脱离文档流的样式类名
  */
function fixSplitItems(
  currentPage: number,
  pageHeight: number,
  splitElementItems: HTMLElement[],
  outFlowClassName: string
): number {
  if (!splitElementItems || !splitElementItems.length) {
    return 0;
  }

  const yMargin = 5;  // y方向距离页眉的距离
  const splitItemsMinTop = getSplitItemsMinTop(splitElementItems);
  if (!splitItemsMinTop) {
    return 0;
  }

  let fixHeight = currentPage * pageHeight - splitItemsMinTop + yMargin;
  const outFlowElement = splitElementItems.find((item) => item.classList.contains(outFlowClassName));
  if (outFlowElement && outFlowElement.parentElement) {
    const parentPreviousElement = outFlowElement.parentElement.previousElementSibling as HTMLElement;
    fixHeight += getMarinTopNum(parentPreviousElement, outFlowElement.parentElement);
    outFlowElement.parentElement.style.marginTop = `${fixHeight}px`;
    return fixHeight;
  }

  splitElementItems.forEach((splitElement) => {
    splitElement.style.marginTop = `${fixHeight}px`;
  });
  return fixHeight;
}

/**
  * 获取被切割元素数组中最小高度值（如一行有多个元素被切割，则选出距离顶部最小的高度值）
  * @param splitElementItems 当前被切割元素数组
  */
function getSplitItemsMinTop(
  splitElementItems: HTMLElement[]
): number | undefined {
  // 获取元素中最小top值作为基准进行修正
  let minTop: number | undefined;
  let minElement: HTMLElement | undefined;
  splitElementItems.forEach((splitElement) => {
    let top = splitElement.getBoundingClientRect().top;
    if (minTop) {
      minTop = top < minTop ? top : minTop;
      minElement = top < minTop ? splitElement : minElement;
    } else {
      minTop = top;
      minElement = splitElement;
    }
  });

  // 修正当前节点及其前面同层级节点的margin值
  if (minTop && minElement) {
    const previousElement = splitElementItems[splitElementItems.length - 1].previousElementSibling as HTMLElement;
    minTop -= getMarinTopNum(previousElement, minElement);
  }
  return minTop;
}

/**
  * 通过前一个兄弟元素和元素自身的位置确认一个距离顶部高度修正值
  * @param previousElement 前一个兄弟元素
  * @param curElement 当前元素
  */
function getMarinTopNum(previousElement: HTMLElement, curElement: HTMLElement): number {
  let preMarginNum = 0;
  let curMarginNum = 0;
  if (previousElement) {
    // 获取外联样式需要getComputedStyle(), 直接.style时对象的值都为空
    const previousMarginBottom = window.getComputedStyle(previousElement).marginBottom;
    preMarginNum = previousMarginBottom ? Number(previousMarginBottom.replace('px', '')) : 0;
  }
  const marginTop = window.getComputedStyle(curElement).marginTop;
  curMarginNum = marginTop ? Number(marginTop.replace('px', '')) : 0;
  return preMarginNum > curMarginNum ? preMarginNum : curMarginNum;
}

以上纯原创！欢迎加关注、加收藏、点赞、转发、分享（代码闲聊站）~

在线咨询

上一篇：第13天 - 16天搞定前端，CSS的动画效果，酷
下一篇：了解一下iframe页面嵌入使用，轻松实现页面集成

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

整合营销服务商

内卷时代下的前端技术-使用JavaScript在浏览器中生成PDF文档

前端常见导出PDF方法

在浏览器中生成PDF文件

解决中文以及特殊字符导出PDF乱码

您的项目需求