docxtemplater 根据数据导出word

下载对应插件

npm i docxtemplater;
npm i pizzip;
npm i file-saver
npm i jszip-utils

创建js文件并引入
import JSZipUtils from "jszip-utils";
import docxtemplater from "docxtemplater";
import { saveAs } from "file-saver";
import PizZip from "pizzip";

export const exportWordDocx = (demoUrl, docxData, fileName) => {
    // 读取并获得模板文件的二进制内容
    console.log(docxData)
    JSZipUtils.getBinaryContent(
        demoUrl,
        function (error, content) {
            // 抛出异常
            if (error) {
                throw error;
            }

            // 创建一个PizZip实例,内容为模板的内容
            let zip = new PizZip(content);
            // 创建并加载docxtemplater实例对象
            let doc = new docxtemplater().loadZip(zip);
            // 去除未定义值所显示的undefined
            doc.setOptions({
                nullGetter: function () {
                    return "";
                }
            }); // 设置角度解析器
            // 设置模板变量的值,对象的键需要和模板上的变量名一致,值就是你要放在模板上的值

            doc.setData({
                ...docxData
            });
            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);
        }
    );
}

指定html文件中引入js
import { xxx } from './xxx'

具体使用
let person = {
  xxx: 'xx'
}
xxx('test.docx', person, 'lst')
(参数1为导入的模板word) (参数2为定义的具体数据) (参数3为导出的文件名称)
test.docx 在vue中放在public目录下面. 名称自己定义要匹配上

word文档使用说明数据对比
指定对象比如 
js数据为 name: '张三'
wodr中
{name}  即可

循环list 列表数据
js数据为  list: [
  { name: '张三', number: 33 },
  { name: '张四', number: 34 },
  { name: '张五', number: 35 },
]
word中
{#list}{name}{number}{/}
以#开始.申明数组名称 具体对应每一项 从name开始 list不占位 结束要/

---------------------------------------------------------------------------
如果需要图片. 图片必须为64格式. 建议配合后端. 避免安全问题

import Docxtemplater from 'docxtemplater'
import ImageModule from 'docxtemplater-image-module-free' //需要图片就导入
import PizZip from 'pizzip'
import JSZipUtils from 'jszip-utils'
import { saveAs } from 'file-saver'

export function exportWordAndImage(report) {
	var templateChose = '测试.docx' //模板推荐放在public文件夹下
	JSZipUtils.getBinaryContent(templateChose, function(error, content) {
	 if (error) {
	   console.error(error)
	   return
	 }
	 var opts = {}
	 opts.centered = false
	 opts.getImage = function(tagValue) {
	   return new Promise(function(resolve, reject) {
	     JSZipUtils.getBinaryContent(tagValue, function(error, content) {
	       if (error) {
	         return reject(error)
	       }
	       return resolve(content)
	     })
	   })
	 }
	 // 图片有关代码,没有图片的可以删除
	 opts.getSize = function(img, tagValue, tagName) {
	   // return [200, 200] // 图片大小 (固定的)如果你的图片大小要固定,请使用这行代码,将下面return new Promise的那部分注销掉
	   // 非固定(这里是设置宽度最大为300px的图片)
	   let wid = 300
	   return new Promise(function(resolve, reject) {
	     var image = new Image()
	     image.src = tagValue
	     let imgWidth, imgHeight, scale
	     image.onload = function() {
	       imgWidth = image.width
	       imgHeight = image.height
	       scale = 0
	       if (imgWidth > wid) {
	         scale = wid / imgWidth
	         imgWidth = wid
	         imgHeight = imgHeight * scale
	       }
	       resolve([imgWidth, imgHeight])
	     }
	     image.onerror = function(e) {
	       console.log('img, tagName, tagValue : ', img, tagName, tagValue)
	       reject(e)
	     }
	   })
	 }
	 var imageModule = new ImageModule(opts)
	
	 var zip = new PizZip(content)
	 var doc = new Docxtemplater()
	   .loadZip(zip)
	   .setOptions({ linebreaks: true }) // 换行确认,如果你有的文本中有换行符的话,可以选择她导入到word起不起作用
	   .attachModule(imageModule)
	   .compile()
	 doc
	   .resolveData(
	     {
	     	// 这是你导入的数据,这个数据体中的属性或对象一定要和word模板中的插值一样
	       ...report
	     }
	   )
	   .then(function() {
	     console.log('Export...')
	     doc.render()
	     var out = doc.getZip().generate({
	       type: 'blob',
	       mimeType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
	     })
	     // 输出文档,可以自定义自己的文档名
	     saveAs(out, 'Temporary, you need to sync as.docx')
	   })
	})
}

图片word中写法格式 
{#person}
{%docpic}
{/person}

### 如何在后端使用 `docxtemplater` 生成和导出 Word 文档 #### 后端环境准备 为了能够在后端环境中利用 `docxtemplater` 来生成和导出 Word 文件,首先需要安装必要的依赖库。通常情况下,在 Node.js 环境中操作较为便捷。 ```bash npm install docxtemplater jszip express body-parser ``` 这些包的作用分别是: - **docxtemplater**: 主要用于处理模板替换逻辑。 - **jszip**: 提供 ZIP 压缩/解压功能支持,因为 DOCX 实际上是一个压缩文件夹。 - **express**: 构建 HTTP 服务器框架以便接收请求。 - **body-parser**: 解析传入的请求体数据。 #### 创建 Express 应用程序 建立一个简单的 Express Web Server 接收客户端发送过来的数据,并据此构建新的 Word 文档返回给用户。 ```javascript const express = require('express'); const bodyParser = require('body-parser'); const fs = require('fs'); const path = require('path'); const Docxtemplater = require('docxtemplater'); const JSZipUtils = require('jszip-utils'); const fileSaver = require('file-saver'); // 初始化Express应用实例 let app = express(); app.use(bodyParser.json()); // 设置静态资源目录(如果有的话) app.use(express.static(path.join(__dirname, 'public'))); // POST /export-word 路由处理器函数定义如下: app.post('/export-word', async (req, res) => { try { let templatePath = path.resolve(__dirname, './templates/template.docx'); // 模板路径 await JSZipUtils.getBinaryContent(templatePath, function(error, content) { if (error) throw error; var zip = new window.JSZip(content); var doc = new Docxtemplater(zip); // 渲染模板中的占位符变量 doc.render(req.body.data); // 获取渲染后的二进制流形式的结果 var buffer = doc.getZip().generate({ type: "nodebuffer" }); // 返回下载响应头设置 res.setHeader('Content-Type', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'); res.setHeader('Content-Disposition', `attachment;filename=${req.body.fileName || 'document'}.docx`); // 发送文件至浏览器触发下载行为 return res.send(buffer); }); } catch (err) { console.error(err.stack); res.status(500).send(`Server Error`); } }); // 监听指定端口启动服务 const PORT = process.env.PORT || 3000; app.listen(PORT, () => console.log(`Server running on port ${PORT}`)); ``` 这段代码展示了如何配置一个基本的服务端应用程序来接受来自前端或其他系统的 JSON 请求,基于预设好的 `.docx` 模板填充实际内容之后再将其转换成可被下载的新文档[^1]。 此过程涉及到了几个关键技术点: - 利用了 `JSZipUtils.getBinaryContent()` 方法读取本地存储的 .docx 模板文件; - 使用 `DocxTemplater` 对象执行具体的模板解析工作; - 经过 `render()` 函数完成文本替换动作; - 最终借助于 `getZip().generate({...})` 输出最终产物——即已编译完毕待分发出去的新版 Microsoft Office Document (.docx)[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值