XWPFTemplate生成word

一、在Java领域中,处理Office文档是一项常见的需求,尤其是对于生成报告、合同或其他结构化文档。Apache POI是一个广泛使用的库,用于读写Microsoft Office格式文件(包括Word、Excel等)。

XWPFTemplate是基于Apache POI封装的一个强大的Word模板引擎,它允许开发人员通过定义特定占位符来创建可复用的Word文档模板,并能方便地将数据模型绑定到这些模板上,从而实现批量或动态生成Word文档的功能。

二、 XWPFTemplate的工作原理

2.1 模板定义

使用XWPFTemplate时,首先需要准备一个Word文档作为模板。在这个模板中,可以通过特定的语法(如${variable})来标识变量位置,这些变量将在运行时被实际的数据替换。此外,还可以支持条件判断、循环遍历等逻辑结构。

2.2 数据绑定与渲染

准备好模板后,开发者可以创建一个数据模型(通常是Java对象或是map),然后调用XWPFTemplate提供的API方法,将数据模型绑定到模板上。引擎会解析模板中的占位符,并根据数据模型的内容进行填充,最终生成一个新的包含实际内容的Word文档。

三、关键代码如下:

复制代码
          <dependency>
               <groupId>com.deepoove</groupId>
            <artifactId>poi-tl</artifactId>
            <version>1.12.1</version>
        </dependency>

 public void preview(HttpServletResponse response, HashMap<String, Object> data) {

        ClassPathResource classPathResource = new ClassPathResource("model/eleReport.docx");
        InputStream is = null;
        try {
            is = classPathResource.getInputStream();
        } catch (IOException e) {
            e.printStackTrace();
        }
        LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();

        
        // 进行编译
        Configure conf = Configure.builder().bind("defectInfo", policy).bind("zzInfo",policy).build();
        XWPFTemplate render = XWPFTemplate.compile(is, conf).render(data);
        try {
            response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
            response.setCharacterEncoding("utf-8");
            render.write(response.getOutputStream());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

data的处理就是组装数据的过程,针对循环的变量需要指定策略policy,组装完数据,调用此方法,页面上即可生成报告了。

四、模板如下:

其他语法可参考:Poi-tl Documentation

相关推荐
彭于晏Yan1 天前
Redisson分布式锁
spring boot·redis·分布式
ywf12151 天前
Spring Boot接收参数的19种方式
java·spring boot·后端
独断万古他化1 天前
【Java 实战项目】多用户网页版聊天室:消息传输模块 —— 基于 WebSocket 实现实时通信
java·spring boot·后端·websocket·ajax·mybatis
Sweet锦1 天前
SpringBoot 3.5 集成 InfluxDB 1.8
spring boot·时序数据库
Java水解1 天前
Spring Boot 消息队列与异步处理
spring boot·后端
深蓝轨迹1 天前
黑马点评--达人探店模块
java·spring boot·redis
菜鸟程序员专写BUG1 天前
SpringBoot 接口返回异常全集|JSON解析失败/响应乱码/状态码错误完美解决
spring boot·后端·json
希望永不加班1 天前
SpringBoot 编写第一个 REST 接口(Get/Post/Put/Delete)
java·spring boot·后端·spring
vx-程序开发1 天前
springboot智慧农业信息服务平台-计算机毕业设计源码65287
spring boot·后端·课程设计
小雷君1 天前
SpringBoot 接口开发5个高频踩坑总结
java·spring boot·后端·面试