因为项目报告导出pdf断页问题不能得到很好的解决,所以决定导出word。中间踩过的坑,今天聊作记录,分享与复盘。
其中主要用得到的是docxTemplater,docxTemplater是一个通过模板文件生成word的库,它能最大程度的保证最终生成的word的样式的完整和还原。
1、 依赖安装
// 安装 docxtemplater
npm install docxtemplater pizzip --save
// 安装 jszip-utils
npm install jszip-utils --save
// 安装 jszip
npm install jszip --save
// 安装 FileSaver
npm install file-saver --save
// 安装 angular-expressions
npm install angular-expressions --save
// 安装 image-size
npm install image-size --save
// 图片模块,没有图片需求可以不装
npm install docxtemplater-image-module-free
2、创建导出word的js,exportFile.js,目录自定义
import PizZip from 'pizzip'
import docxtemplater from 'docxtemplater'
import JSZipUtils from 'jszip-utils'
import { saveAs } from 'file-saver'
export function getBase64Sync(imgUrl) {
return new Promise(function (resolve, reject) {
// 一定要设置为let,不然图片不显示
let image = new Image();
// 解决跨域问题
image.crossOrigin = "anonymous";
//图片地址
image.src = imgUrl;
// image.onload为异步加载
image.onload = function () {
let canvas = document.createElement("canvas");
canvas.width = image.width;
canvas.height = image.height;
let context = canvas.getContext("2d");
context.drawImage(image, 0, 0, image.width, image.height);
//图片后缀名
let ext = image.src
.substring(image.src.lastIndexOf(".") + 1)
.toLowerCase();
//图片质量
let quality = 0.8;
//转成base64
let dataurl = canvas.toDataURL("image/" + ext, quality);
//返回
resolve(dataurl);
};
});
}
/**
* 将base64格式的数据转为ArrayBuffer
* @param {Object} dataURL base64格式的数据
*/
function base64DataURLToArrayBuffer(dataURL) {
const base64Regex = /^data:image\/(png|jpg|jpeg|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;
}
/**
* 导出word,支持图片
* @param {Object} tempDocxPath 模板文件路径
* @param {Object} wordData 导出数据
* @param {Object} fileName 导出文件名
* @param {Object} imgSize 自定义图片尺寸
*/
export const exportWord = (tempDocxPath, wordData, fileName, imgSize) => {
// 这里要引入处理图片的插件
var ImageModule = require('docxtemplater-image-module-free');
const expressions = require("angular-expressions");
// 读取并获得模板文件的二进制内容
JSZipUtils.getBinaryContent(tempDocxPath, function (error, content) {
console.log('tempDocxPath', tempDocxPath)
if (error) {
throw error;
}
expressions.filters.size = function (input, width, height) {
return {
data: input,
size: [width, height],
};
};
// function angularParser (tag) {
// const expr = expressions.compile(tag.replace(/’/g, "'"));
// return {
// get (scope) {
// return expr(scope);
// },
// };
// }
// 图片处理
let opts = {}
opts = {
// 图像是否居中
centered: false
};
opts.getImage = (chartId) => {
// console.log(chartId);//base64数据
// 将base64的数据转为ArrayBuffer
return base64DataURLToArrayBuffer(chartId);
}
opts.getSize = function (img, tagValue, tagName) {
// console.log(img);//ArrayBuffer数据
// console.log(tagValue);//base64数据
// console.log(tagName);//wordData对象的图像属性名
// 自定义指定图像大小
if (imgSize.hasOwnProperty(tagName)) {
return imgSize[tagName];
} else {
return [150, 150];
}
}
// 创建一个PizZip实例,内容为模板的内容
let zip = new PizZip(content);
// 创建并加载docxtemplater实例对象
let doc = new docxtemplater();
doc.attachModule(new ImageModule(opts));
doc.loadZip(zip);
doc.setData(wordData);
try {
// 用模板变量的值替换所有模板变量
doc.render();
} catch (error) {
// 抛出异常
let e = {
message: error.message,
name: error.name,
stack: error.stack,
properties: error.properties
};
console.log(JSON.stringify({
error: e
}));
throw error;
}
// 生成一个代表docxtemplater对象的zip文件(不是一个真实的文件,而是在内存中的表示)
let out = doc.getZip().generate({
type: "blob",
mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
});
// 将目标文件对象保存为目标类型的文件,并命名
saveAs(out, fileName);
});
}
3、在页面中调用,导出word
- 引入exportWord
// 如果有图片渲染的需求,要调用getBase64Sync 方法
import { exportWord, getBase64Sync } from '@/utils/exportFile.js'
- 数据结构
wordData: {
companyName:'',
enName:'',
wmData:[
title:'',
score:'',
objective:'',
isFull:false,
children:[
{
isFullMark:true,
serialNumber:'',
findDesc:'',
picUrl:[
{
src:'',
}
],
solution:''
}
]
]
},
- 方法中
// wordData是模板需要的数据
// 图片需要转base64才能在word显示
async toWord() {
this.wordData.src = await getBase64Sync(this.url)
exportWord('/template1.docx', this.wordData, '环境工业风险审核报告.docx', imgSize)
}
4、word模板中
-
对于直接显示的字段,用{}表示
-
对于需要判断显示的要用{#isProblem}开始,{/isProblem}结束,isProblem的类型是Boolean,true的时候是显示。如下图,isFull==true的时候,才显示下面这句话
-
对于循环显示的数据,也是{#wdM1}开始,{/wdM1}结束,中间是需要显示的字段
-
对于数据中的多重遍历,例如我是wordData的wmData中的children遍历,需要这样写:{#wmData}{#children}{/children}{/wmData},标签要一一对应,不能写错位置。
- 对于图片的显示,字段要加%
{#imgList} {%src}{/imgList}
5、遇到的问题
-
找不到文件
Can't find end of central directory : is this a zip file ?
这个报错是没有找到模板,如果是vue-cli2版本,要把模板文件放在static目录下,如果是vue-cli3版本,就放在public目录下,并且一定是docx文件,如果不是要另存为docx。如果你的文件直接改名也会报这个错误,一定要另存为才可以 图片不显示
图片要转成base64才能显示word模板中的文字换行,textarea返回的字段,在word模板中没有自动换行,在这里需要处理一下数据
this.wordData.auditResult = this.submitInfo.auditResult.split('\n')
word模板中要这样写
就可以了。
这是biying上搜到的答案,当看到分段成功的那一刻还是很惊喜的,致敬那些无私分享的前辈们!
至此,我这里的项目需求都满足了,开心撒花。