使用POI-tI实现数据导出到word之快速入门

已于 2024-04-10 11:32:53 修改
阅读量473 收藏 6
点赞数 4
文章标签： java word
于 2024-04-01 18:30:02 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_53253335/article/details/137242687
版权

使用POI-tI实现数据导出到word之快速入门

因为POI-ti的不同版本的变动比较明显，所以以下都是使用1.9.1版本，本篇文章只针对快速使用POI-ti实现数据导出功能，而数据导出功能的实现，基本上都是依赖于各种各样的标识符，所以，本片文章旨在搞懂常见标识符的使用。POI-ti的使用总体分为三部分：①自定义文档模板；②编译模板+数据填充；③数据渲染；文档模板中，POI-ti默认的标识符都是以 {{ 开头，并以 }} 结尾的。

注意：以下标签中的var是自定义的，但是必须保证要与数据填充的变量名对应上。

引入依赖
<!--poi-tl-->
<dependency>
    <groupId>com.deepoove</groupId>
    <artifactId>poi-tl</artifactId>
    <version>1.9.1</version>
</dependency>
<!--hutool工具类-->
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.18</version>
</dependency>
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-core</artifactId>
    <version>5.8.18</version>
</dependency>
文本标签

标识符：{{var}}

文档模板（保存为docx文件）

在这里插入图片描述

模板编译

模板编译的操作首先执行，且只能执行一次，是公用的；

XWPFTemplate template = null;
//方式1：加载模板文件
File file = new File("C:templates\\poi\\模板.docx");
template = XWPFTemplate.compile(file);
//方式2：加载指定路径对应的文件
template = XWPFTemplate.compile("C:templates\\poi\\模板.docx"");
//方式3：加载IO输入流
InputStream is =ResourceUtil.getResourceObj("模板.docx").getStream();
template = XWPFTemplate.compile(is); //加载IO流文件的方式，是从classpass路径开始找；
数据填充
String：直接赋值
//准备参数（普通参数建议使用map装载）
HashMap<String, Object> map = new HashMap<>();
map.put("name", "张三");
map.put("gender", "男");
map.put("age", 18);
map.put("collect", "信息工程学院");
map.put("major", "计算机应用");
map.put("xl", "本科");
map.put("phone", "17788899900");
TextRenderData：可以指定文本的样式
TextRenderData textRenderData = new TextRenderData();
textRenderData.setText("信息工程学院");
Style style = Style.builder()
    .buildFontFamily("微软雅黑")
    .buildFontSize(10)
    .buildColor("7F7F7F")
.build();
textRenderData.setStyle(style);
map.put("collect", textRenderData);
数据渲染

模板编译的操作最后执行，且只能执行一次，是公用的；

template.render(map);
图片标签

标识符：{{@var}}

文档模板

在这里插入图片描述

数据填充
//方式1：直接传递图片地址
put("photo", "C:\\logo.png"); //绝对地址
put("photo", "https://img.shields.io/badge/jdk-1.6%2B-orange.svg"); //网络地址

//方式2：使用Pictures构建
put("photo", Pictures.ofLocal("C:\\logo.png").size(120, 120).create()); //绝对路径
put("photo", Pictures
    .ofStream(new FileInputStream("C:\\logo.jpeg"), PictureType.JPEG)
  	.size(100, 120)
    .create()
); //IO流
put("photo", Pictures
    .ofUrl("http://deepoove.com/images/icecream.png")
  	.size(100, 100)
    .create()
); //网络地址
表格标签

标识符：{{#var}}

文档模板

在这里插入图片描述

数据填充
方式1：使用工厂 Tables 、 Rows 和 Cells 构建表格模型
//举例：第0行居中且背景为蓝色的表格
RowRenderData row0 = Rows.of("姓名", "学历").textColor("FFFFFF")
      .bgColor("4472C4").center().create();
RowRenderData row1 = Rows.create("李四", "博士");
put("table", Tables.create(row0, row1));
方式2：使用TableRenderData构建

注意：这种方式比较麻烦，在POI-ti1.5的版本时还比较好，使用POI-ti1.9版本时，就变得非常麻烦，这里不做演示

上面三种标签使用的完整代码

注意：这里是将数据输出到word文件并下载的方式

public class Test{
	public void test(HttpServletResponse response) {
        Resource resource = null;
        InputStream is = null;
        ServletOutputStream sos = null;
        XWPFTemplate template = null;
        try {
            //1，获取模板文件
            resource = ResourceUtil.getResourceObj("templates/模板.docx");
            is = resource.getStream();
            //2，编译模板
            template = XWPFTemplate.compile(is);
            //3，准备参数（普通参数建议使用map装载）
            HashMap<String, Object> map = new HashMap<>();
			map.put("name", "张三");
			map.put("gender", "男");
			map.put("age", 18);
			map.put("collect", "信息工程学院");
			map.put("major", "计算机应用");
			map.put("xl", "本科");
			map.put("phone", "17788899900");
            map.put("photo", Pictures.ofUrl("http://deepoove.com/images/icecream.png", PictureType.PNG).size(100, 100).create());
            RowRenderData row0 = Rows.of("姓名", "学历").textColor("FFFFFF")
                    .bgColor("4472C4").center().create();
            RowRenderData row1 = Rows.create("李四", "博士");
            map.put("table", Tables.create(row0, row1));

            //4，数据渲染
            template.render(map);
            //5，设置响应参数
            response.setContentType("application/vnd.ms-word"); //数据类型
            response.setCharacterEncoding("utf-8"); //编码格式
            //如果响应中带有附件，需要设置下面这行参数
            response.setHeader("Content-disposition", "attachment; filename="
                    //ISO-8859-1适用范围比UTF-8更广泛，但自身无法显示中文，需要配合其他编码集使用，如UTF-8
                    + new String(resource.getName().getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1)); //附件名称
            sos = response.getOutputStream();
            //6，输出
            template.writeAndClose(sos); //IO流
//            template.writeToFile(""); //输出到文件
        } catch (IOException e) {
            e.printStackTrace();
        }
}
列表标签

标识符：{{*var}}

文档模板

在这里插入图片描述

数据填充
put("hobby", Numberings.create("唱","跳","rap"));
区块对

标识符：{{?var}} … {{/var}}

两个标签之间是其他标识符，这种方式的实现情况有很多种，常用的就两种：标签内的其他标签值为空或条件为false时，不会填充该标签；标签内的数据可以是一条也可以是集合；

注意：这种方式必须是使用模板类进行填充，不能使用Map；

文档模板

在这里插入图片描述

代码
模板类
public class info {
    private String school;
    private String addr;
    private List<User> users;
    //get和set方法...
}

public class User{
    private string name;
    private Integer age;
    private Character gender;
    //get和set方法...
}
方法实现
Info data = new Info();
public void test(HttpServletResponse response) {
        Resource resource = null;
        InputStream is = null;
        ServletOutputStream sos = null;
        XWPFTemplate template = null;
        try {
            sos = response.getOutputStream();
            //1，获取模板文件
            resource = ResourceUtil.getResourceObj("templates/模板.docx");
            is = resource.getStream();
            //2，编译模板
            template = XWPFTemplate.compile(is);
            //3，准备参数（普通参数建议使用map装载）
            data.setSchool("xx大学");
            TextRenderData renderData = new TextRenderData("xx省。。。");
            Style style = Style.builder().buildFontSize(10).buildColor("7F7F7F").buildFontFamily("微软雅黑").build();
            renderData.setStyle(style);
            data.setAddr(renderData.getText());
            ArrayList<User> list = new ArrayList<>();
            User u1 = new User();
            u1.setName("张三");
            u1.setAge(20);
            u1.setGender('男');
            TextRenderData hobby = new TextRenderData("唱，跳，rap");
            hobby.setStyle(style);
            u1.setHobby(Numberings.of(hobby, hobby, hobby).create());
            User u2 = new User();
            u2.setName("张三");
            u2.setAge(20);
            u2.setGender('男');
            TextRenderData hobby2 = new TextRenderData("唱，跳，rap");
            hobby.setStyle(style);
            u2.setHobby(Numberings.of(hobby2, hobby2, hobby2).create());
            list.add(u1);
            list.add(u2);
            list.add(u1);
            list.add(u2);
            data.setUsers(list);
            //4，数据渲染
            template.render(data);
            //5，设置响应参数
            response.setContentType("application/vnd.ms-word"); //数据类型
            response.setCharacterEncoding("utf-8"); //编码格式
            //如果响应中带有附件，需要设置下面这行参数
            response.setHeader("Content-disposition", "attachment; filename="
                    //ISO-8859-1适用范围比UTF-8更广泛，但自身无法显示中文，需要配合其他编码集使用，如UTF-8
                    + new String(resource.getName().getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1)); //附件名称

            //6，输出并关闭
            template.writeAndClose(sos); //IO流
//            template.writeToFile(""); //输出到文件
        }
嵌套标签

标识符：{{+var}}

注意：这种标签必须要有两个文档模板，一个是用于数据展示的主模板；一个是数据填充的子模板；

文档模板
主模板

在这里插入图片描述

子模板

在这里插入图片描述

代码
public void test(HttpServletResponse response) {
        Resource resource = null;
        InputStream is = null;
        ServletOutputStream sos = null;
        XWPFTemplate template = null;
        try {
            sos = response.getOutputStream();
            //1，获取模板文件
            resource = ResourceUtil.getResourceObj("templates/father.docx");
            is = resource.getStream();
            //2，编译模板
            template = XWPFTemplate.compile(is);
            //3，准备参数（普通参数建议使用map装载）
            Map<String,Object> map=new HashMap<>();
            map.put("school","xx大学");
            map.put("addr","xx省。。。");
            ArrayList<User> list = new ArrayList<>();
            User u1 = new User();
            u1.setName("张三");
            u1.setAge(20);
            u1.setGender('男');
            User u2 = new User();
            u2.setName("张三");
            u2.setAge(20);
            u2.setGender('男');
            list.add(u1);
            list.add(u2);
            list.add(u1);
            list.add(u2);
            InputStream stream = ResourceUtil.getResourceObj("templates/sub.docx").getStream();
            map.put("users",Includes.ofStream(stream).setRenderModel(list).create());
            //4，数据渲染
            template.render(map);
            //5，设置响应参数
            response.setContentType("application/vnd.ms-word"); //数据类型
            response.setCharacterEncoding("utf-8"); //编码格式
            //如果响应中带有附件，需要设置下面这行参数
            response.setHeader("Content-disposition", "attachment; filename="
                    //ISO-8859-1适用范围比UTF-8更广泛，但自身无法显示中文，需要配合其他编码集使用，如UTF-8
                    + new String(resource.getName().getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1)); //附件名称

            //6，输出并关闭
            template.writeAndClose(sos); //IO流
//            template.writeToFile(""); //输出到文件
        }

至此，使用POI-ti导出数据到word的快速入门就结束了。。。

橘五
关注
  • 4
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java使用Word的模板引擎 Poi-tl操控导出word文件
洛阳泰山的博客
07-27 7295
poi-tl是一个基于Apache POI的Java库，用于操作Microsoft Office文档，包括Word文档（.docx）、Excel电子表格（.xlsx）和PowerPoint演示文稿（.pptx）。它提供了一组简单易用的API，使开发人员能够轻松地创建、读取和修改Office文档。poi-tl的主要特点如下：简单易用：poi-tl提供了一组简单易用的API，使开发人员能够快速上手并进行Office文档的操作。它提供了丰富的方法和属性，以满足不同的需求。
POI-TL合并多个Word文档
06-27
POI-TL合并多个Word文档
Java 采用Poi-Tl实现word导出示例
青春勿完美的博客
07-06 3795
Java采用 Poi-TlWord模板引擎导出word表格示例 官方poi-tl的教程地址 : poi-tl 准备一个word模板templete.docx，放在resource文件夹下。具体路径在代码中有体现。 模板中插入表格格式2列4行就行。 编写插件类 TableRenderPolicy.java package com.example.demo.poitl...
Java中使用poi+poi-tl实现根据模板导出word文档
BADAO_LIUMANG_QIZHI的博客
03-01 2482
上面讲的是Excel的导出，如果是需要根据word文档的模板，比如根据数据库中数据或者其它数据源循环根据模板填充数据，可填充文字、图片、表格、图表等数据。
Poi-tl使用HttpServletResponse导出Word乱码问题
攻城狮Chova的博客
06-15 1524
Poi-tl使用HttpServletResponse导出Word乱码问题问题原因解决办法总结 问题 Poi-tl中HttpServletResponse导出Word乱码问题: 文件名使用中文,中文名乱码 导出的文件下载后乱码 原因 文件名中文乱码: 没有设置文件名的编码规则 文件下载乱码: 在RESTful中的Controller层错误地使用了PostMapping 解决办法 文件名乱码: String attachName = new String(("Xxx.docx")
Word-1:使用poi-tl引擎导出word文档
浪浪的博客
08-12 2473
开头语 要能重新选择，我一定不做马云 ————马云 需求分析 之前一直在做导出excel表的功能，导出word也实现过但是并没有什么亮点，最近接触到了poi-tl。 来看下官网的介绍： poi-tl（poi template language）是Word模板引擎，使用Word模板和数据创建很棒的Word文档。 在文档的任何地方做任何事情（Do Anything Anywhere）是poi-tl的星辰大海。 瞅瞅这话说的，忍不住体验一下 主要技术栈：poi-tl官网路径 本文的示例代码按照官方提供的a
【Java】poi-tl实现导出Word模板并动态渲染数据
分享记录开发中的问题，欢迎一起探讨！
09-02 6540
最近做项目的时候会遇到要求要导出以docx格式结尾的报告文件，于是我就在思考有没有一个比较好用的第三方类库能解决在word上渲染数据的问题。之前也尝试用过poi,感觉不大好用，代码比较复杂且没有什么特别好的支持。于是乎在网上搜索了很久，找到了一个第三方组件库还挺好用的，那就是poi-tl。poi-tl是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，你可以非常方便的加入到你的项目中，并且拥有着让人喜悦的特性。
SpringBoot+Vue项目使用poi-tl来实现导出word文档
小鹏要逆袭的博客
05-22 4926
项目需求：需要将数据导出成word文档，但是必须是按照一定的格式。这里使用了一个小插件，是基于poi的再次封装：https://github.com/Sayi/poi-tl/ 1.maven引入包 <!-- poi Excel、Word操作--> <dependency> <groupId>com.deepoove...
java使用poi-tl导出word及转换PDF后的合并导出pdf
weixin_45753444的博客
03-22 5927
通过poi-tl导出word再转换PDF的方式，比直接导出PDF更加灵活，兼容性也更高，同时也实现了PDF的内容查找与合并
Java使用poi-tl生成word文档
振宇要低调
10-08 2730
Java使用poi-tl生成word文档，可以对模板文件进行文本替换，图片、表格、超链接添加、图表处理等。大概的说明都在代码注释里，只有一个地方需要注意，就是图表的替换，占位符{{barChart}}的设定比较特殊，见下图。
POI-tl导出Word文档表格并且带图片+浏览器导出
sh513023410的博客
05-30 4402
这个放入图片的方法是一种比较笨的方法，但是能达到实现效果，我也查了很多博客，文档，但是没有看到循环表格时加入图片的，其他人如果有好的方法发出来，大家一起学习。
POI-将数据导出到Word的实例
06-20
POI-将数据导出到Word的实例
POI使用word模板文件循环输出行并导出word
08-12
一个使用Apache的poi使用word模板循环输出表格行并导出的例子
利用Poi-tl将富文本Html转换为Word文件
01-08
poi-tl相关的请参考：http://deepoove.com/poi-tl/ ...另外这种方法不会保存富文本的一些样式，...想要具体的Demo请看：https://gitee.com/xuwangcheng/poi-tl-html-to-word 有疑问请加QQ群：468324085 作者：白卡pala
JAVAEE之多线程进阶（2）_ CAS概念、实现原理、ABA问题及解决方案
最新发布
2301_80653026的博客
05-29 1376
CAS全称Compare and swap，字面意思:”比较并交换“，它是一条 CPU 并发原语，用于判断内存中某个值是否为预期值，如果是则更改为新的值，这个过程是原子的。全称 Compare and swap, 即 “比较并交换”. 相当于通过一个原子的操作, 同时完成 “读取内存, 比较是否相等, 修改内存” 这三个步骤. 本质上需要 CPU 指令的支撑。
Spring Bean Map之舞
m0_51176516的博客
05-23 782
在Spring框架中，Bean的生命周期管理是其核心功能之一。当Spring容器启动时，它会根据配置信息（如XML配置文件、注解等）来创建和管理Bean实例。这些Bean实例默认会被放置在一个Map数据结构中，以便容器能够快速地根据Bean的名称（或ID）来查找和访问它们。 在Spring的源码中，Bean实例的存储和管理主要依赖于DefaultSingletonBeanRegistry类。这个类内部使用了一个名为singletonObjects的Map来存储单例Bea...
java学习和项目总结
2301_79390585的博客
05-24 911
JRE：JRE是Java 运行时环境，主要包括了两个运行需要的组件：JVM 和 Java 核心类库，如果不进行java开发只想运行就可以只下载JRE。而Java语言，它的代码会先通过javac编译成字节码，再通过jvm将字节码转换成机器码（0和1）执行，即解释运行和编译运行配合使用，所以是混合型。在程序运行之前，通过编译器将源程序编译成机器码可运行的二进制，以后执行这个程序时，就不用再进行编译了。JVM：JVM是java进行编译的虚拟机，是Java 能够跨平台运行的核心。特点：执行速度慢、效率低；
springboot poi-tl 使用模板导出word表格合并列并下载
07-15
在Spring Boot中使用poi-tl库来导出带有合并列的Word表格并下载，您可以按照以下步骤操作： 1. 首先，确保您的Spring Boot项目中已经添加了poi-tl的依赖。您可以在pom.xml文件中添加以下依赖： ```xml <dependency> <groupId>com.deepoove</groupId> <artifactId>poi-tl</artifactId> <version>1.6.0</version> </dependency> ``` 2. 创建一个Controller来处理导出请求。例如，创建一个名为WordExportController的类，并添加一个处理导出请求的方法。 ```java import com.deepoove.poi.XWPFTemplate; import com.deepoove.poi.data.*; import com.deepoove.poi.util.BytePictureUtils; import org.apache.poi.xwpf.usermodel.XWPFTable; import org.apache.poi.xwpf.usermodel.XWPFTableRow; import org.springframework.core.io.InputStreamResource; import org.springframework.http.HttpHeaders; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.GetMapping; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.util.ArrayList; import java.util.List; @Controller public class WordExportController { @GetMapping("/export") public ResponseEntity<InputStreamResource> exportWord() throws IOException { // 创建一个数据模型 List<List<String>> tableData = new ArrayList<>(); tableData.add(createRow("Merged Cells", "Cell 3")); tableData.add(createRow("Cell 4", "Cell 6")); // 使用poi-tl的XWPFTemplate来生成Word文档 XWPFTemplate template = XWPFTemplate.compile("templates/template.docx").render( new DataTable(tableData) .setHeader(createRow("Header 1", "Header 2")) .setCellWidth(2000) // 设置单元格宽度 .setHeaderCellStyle(new CellStyle().setBold(true).setColor("FFFFFF").setBgColor("336699")) .setOddRowCellStyle(new CellStyle().setColor("FFFFFF").setBgColor("99CCFF")) .setEvenRowCellStyle(new CellStyle().setColor("FFFFFF").setBgColor("CCEEFF")) ); // 将生成的Word文档转换为字节数组 ByteArrayOutputStream out = new ByteArrayOutputStream(); template.write(out); byte[] documentBytes = out.toByteArray(); // 设置下载响应的头信息 HttpHeaders headers = new HttpHeaders(); headers.setContentDispositionFormData("attachment", "merged_table.docx"); headers.setContentType(MediaType.APPLICATION_OCTET_STREAM); // 创建一个包含Word文档字节数组的InputStreamResource InputStreamResource resource = new InputStreamResource(new ByteArrayInputStream(documentBytes)); // 返回响应实体 return ResponseEntity.ok() .headers(headers) .body(resource); } private List<String> createRow(String cell1, String cell2) { List<String> row = new ArrayList<>(); row.add(cell1); row.add(cell2); return row; } } ``` 3. 在resources目录下创建一个名为template.docx的Word模板文件。在模板文件中，您可以根据自己的需求设置表格样式和内容。 4. 启动您的Spring Boot应用程序，并访问导出请求的URL（例如：http://localhost:8080/export）。将会自动下载名为merged_table.docx的Word文档，其中包含合并列的表格。 请确保按照您的需求修改代码，并根据模板文件的位置进行相应的调整。 希望对您有所帮助！如果您有任何其他问题，请随时提问。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值