1、docxtemplater
介绍
docxtemplater是一种邮件合并工具,它以编程方式使用,处理条件、循环,并且可以扩展为表格、HTML、图像等。
用到的API
- new window.docxtemplater:创建docxtemplater实例对象,返回一个新的docxtemplater对象
- loadZip(zip):docxtemplater对象加载zip实例注意:必须从jszip的2.x版本向该方法传递一个zip实例
- setData(Tags):设置模板变量的值
- render():此函数用模板变量的值替换所有模板变量
- getZip():此函数返回代表docxtemplater对象的zip
2、jszip-utils
介绍
jszip-utils是与jszip一起使用的跨浏览器的工具库
用到的API
- getBinaryContent():读取并获得模板文件的二进制内容
3、jszip
介绍
jszip是一个用于创建、读取和编辑.zip文件的JavaScript库,且API的使用也很简单。
用到的API
- new JSZip():创建一个JSZip实例
- generate():此函数可以生成一个zip文件(不是一个真实的文件,而是在内存中的表示)
4、FileSaver
介绍
FileSaver.js 是在客户端保存文件的解决方案,非常适合需要生成文件,或者保存不应该发送到外部服务器的敏感信息的应用。
用到的API
- saveAs(blob, "1.docx"):将目标文件对象保存为目标类型的文件,并命名。
二. 操作步骤
接下来就是安装以上组件工具,安装命令如下
-- 安装 docxtemplater
npm install docxtemplater pizzip --save
-- 安装 jszip-utils
npm install jszip-utils --save
-- 安装 jszip
npm install jszip --save
-- 安装 FileSaver
npm install file-saver --save
-- 安装 docxtemplater-image-module-free
npm install docxtemplater-image-module-free --save
在需要用到的组件中引入以上工具
注:若引入docxtemplater-image-module-free 报错时,可尝试使用require方法引入。
import docxtemplater from 'docxtemplater'
import PizZip from 'pizzip'
import JSZipUtils from 'jszip-utils'
import ImageModule from 'docxtemplater-image-module-free'
import {saveAs} from 'file-saver'
创建模板文件
定义demo数据
const form = {
custName: "杰斯", // 客户姓名
phoneNumber: "13835543884", // 联系方式
projectRequirement: "为了更美好的明天而战", // 项目要求
totalPrice: 140, // 合计报价
remark: "QEWARAEQAAAAAAAAA", // 备注
checkReason: '同意', // 审核备注
}
const tableData = [{
number: 1, // 序号
name: "设备1", // 设备名称
num: 1, // 数量
salePrice: 10, // 销售单价
saleTotal: 10, // 销售合计
remark: "备注1" // 备注
},
{
number: 2, // 序号
name: "设备2", // 设备名称
num: 2, // 数量
salePrice: 20, // 销售单价
saleTotal: 40, // 销售合计
remark: "备注2" // 备注
},
{
number: 3, // 序号
name: "设备3", // 设备名称
num: 3, // 数量
salePrice: 30, // 销售单价
saleTotal: 90, // 销售合计
remark: "备注3" // 备注
}
];
实现方法
function creatWord() {
let ImageModule = require('docxtemplater-image-module-free');
// 读取并获得模板文件的二进制内容
JSZipUtils.getBinaryContent("资产管理.docx", function (error, content) {
// input.docx是模板。我们在导出的时候,会根据此模板来导出对应的数据
// 抛出异常
if (error) {
throw error;
}
// 创建并加载docxtemplater实例对象
let doc = new docxtemplater();
// 创建一个JSZip实例,内容为模板的内容
let zip = new PizZip(content);
doc.loadZip(zip);
// 图片处理
let opts = {}
opts.centered = true; // 图片居中,在word模板中定义方式为{%src} 看73行src 如果改img 那么模板中就改成{%img}
opts.fileType = "docx";
opts.getImage = function (chartId) {
return base64DataURLToArrayBuffer(chartId)
}
opts.getSize = function () {
return [200, 200]
}
let imageModule = new ImageModule(opts);
doc.attachModule(imageModule);
const dataUrl = [];
// 图片地址是在静态文件夹下的图片,不然找不到
UrlToBase64(logo, (imgUrl) => {
console.log(imgUrl);
dataUrl.push({
src: imgUrl
})
})
setTimeout(() => {
doc.setData({
...form,
table: tableData,
// image:dataUrl[0].src,//单张图片是用image
images: dataUrl, //批量图片 模板里复杂一些 {#images} {%image} {/images}
});
try {
// 用模板变量的值替换所有模板变量
doc.render();
} catch (error) {
// 抛出异常
let e = {
message: error.message,
name: error.name,
stack: error.stack,
properties: error.properties
};
console.log(JSON.stringify(e));
throw error;
}
// 生成一个代表docxtemplater对象的zip文件(不是一个真实的文件,而是在内存中的表示)
let out = doc.getZip().generate({
type: "blob",
mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
});
// 将目标文件对象保存为目标类型的文件,并命名
saveAs(out, "报价单.docx");
}, 1000)
// 设置模板变量的值
})
};
图片转base64地址
//带回调的办法
function UrlToBase64(url, callback) {
let image = new Image();
//解决跨域问题
image.setAttribute('crossOrigin', 'anonymous');
image.src = url
console.log(image);
image.onload = () => {
var canvas = document.createElement("canvas");
canvas.width = image.width;
canvas.height = image.height;
var context = canvas.getContext('2d');
context.drawImage(image, 0, 0, image.width, image.height);
var quality = 0.8;
//这里的dataurl就是base64类型
var dataURL = canvas.toDataURL("image/png", quality);
callback ? callback(dataURL) : null; //调用回调函数
}
}
官网提供处理图片的方法(为什么这么做不清楚)
function base64DataURLToArrayBuffer(dataURL) {
const base64Regex = /^data:image\/(png|jpg|svg|svg\+xml);base64,/;
if (!base64Regex.test(dataURL)) {
return false;
}
const stringBase64 = dataURL.replace(base64Regex, "");
let binaryString;
if (typeof window !== "undefined") {
binaryString = window.atob(stringBase64);
} else {
binaryString = new Buffer(stringBase64, "base64").toString("binary");
}
const len = binaryString.length;
const bytes = new Uint8Array(len);
for (let i = 0; i < len; i++) {
const ascii = binaryString.charCodeAt(i);
bytes[i] = ascii;
}
return bytes.buffer;
}
如果不用本地的图片,而是需要把Echarts转成图片导出,使用 Echarts提供的方法导出图表图片,返回一个 base64 的 URL,可以设置为Image的src。替换掉setData中images的值
doc.setData({
...form,
table: tableData,
images: myChart.getDataURL({
pixelRatio: 2,
backgroundColor: '#fff'
}),
});