【实战分享】:利用EasyPoi快速实现Excel模板导出PDF文件

3,448 阅读5分钟

👨‍🎓作者:bug菌
✏️博客:CSDN掘金infoQ51CTO
🎉简介:CSDN|阿里云|华为云|51CTO等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,掘金 | InfoQ | 51CTO等社区优质创作者,全网粉丝合计15w+ ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。

🏆本文收录于《Spring Boot从入门到精通》,专门攻坚指数提升。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。

小伙伴们在批阅文章的过程中如果觉得文章对您有一丝丝帮助,还请别吝啬您手里的赞呀,大胆的把文章点亮👍吧,您的点赞三连(收藏⭐+关注👨‍🎓+留言📃)就是对bug菌我创作道路上最好的鼓励与支持😘。时光不弃🏃🏻‍♀️,创作不停💕,加油☘️

一、前言🔥

环境说明:Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

       前几期呢,我们主要是讲了如何集成easypoi实现excel的导入导出、word导出功能等,对吧。不知道你们都掌握的如何,如果还对以下任意一篇有疑问,还请大家多多提问,哈哈哈,虽然不是什么大佬,但是我会尽全力相授,一起学习,查缺补漏,方能成长的快。

       其实日常除了以上这些文档操作以外,还有一种场景就是导出以pdf格式的文档,不知道你们在平时开发中是否有遇到过?就是将excel模板直接以pdf文档格式导出,虽然完全可以手动转pdf,但是就是要求开发能实现以excel模板导成pdf。

       其实实现过程上还是挺简单的,毕竟我已经教过大家如何通过easypoi实现excel导出,我们只需要在excel导出的基础上,再把流重新写入到pdf格式文档上就可以了。基本思路就是这样。

       但是别担心,我今天就是来带着大家从零敲一遍,希望大家能提前备好课,届时如果真遇到了这个需求,那你肯定是全场最靓的仔。

       接下来我就开始啦,同学们可得竖起耳朵好好听讲哦~我会带着大家一步一步实现它,至于怎么实现,接着往下看。

二、环境配置

       实现excel模板导出这部分我们还是得依赖于easypoi来做。所以你们只需要在你们的pom.xml依赖中加上如下easypoi的starter依赖包即可,添加过的同学就可以不用再重复导入了。

<!--easypoi依赖,excel导入导出-->
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

       另外,我们还需要引用一个包,专门用于excel转pdf工具。所以我们也要导入一下。但是这个包目前人家是要收费的,远程maven镜像是拉取不到本地的,借此我们需要本地导一下这个包就行。

       如下是我提供一种导入方式,就是指定引用本地jar而不自动去maven源拉取。具体细节就不详说啦,你们按照如下格式即可。

<!--excel转pdf-->
<dependency>
    <groupId>e-iceblue</groupId>
    <artifactId>spire.xls.free</artifactId>
    <version>2.2.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/libs/spire.xls.free-2.2.0.jar</systemPath>
</dependency>

        直接引入本地目录jar就可以,具体请看下方截图:

至于jar包下载,你们就自己下吧哈,原来我是添加了云盘地址,但是显示不出被屏蔽了,所以这个大家需要就自己下载一下吧,给大家提供一个下载地址下载链接

三、多sheet工作表excel导入

1、定义一个excel模板

       由于要进行excel模板的读取,所以我们肯定是要定义好excel模板,然后将模板进行数据渲染即可,所以我们还是老样子,通过fe进行赋值内部循环。

具体请看截图:

2、Controller添加excel导入方法

       我们先来定义一个pdf导出方法,目的是提供一个口子,好方便自己通过浏览器访问进行测试。

/**
 * 导出pdf文件
 */
@GetMapping("/export-for-pdf")
@ApiOperation(value = "导出pdf文件", notes = "导出pdf文件")
public void exportPdfUsers(HttpServletResponse response) {
    userService.exportPdfUsers(response);
}

3、定义导入pdf接口

/**
 * 导出pdf文件
 */
void exportPdfUsers(HttpServletResponse response);

4、实现导入方法(核心)

       如下这个导入实现类就很关键了,我们还是直接使用easypoi提供的ExcelExportUtil工具类的importExcel()方法,然后通过它返回的Workbook,来进一步进行流的写入,最后通过刚导入的spire.xls.free写入pdf导出至指定目录下保存。大致的思路就是这样,具体请看如下的实现代码,如果你有更好的实现方式,请记得que我哦。

具体实现代码如下:

/**
 * 导出pdf文件
 */
@Override
public void exportPdfUsers(HttpServletResponse response) {

    //准备导出数据
    Map<String, Object> mapList = new HashMap<>();
    //准备导出数据
    List<Map<String, Object>> listUsers = new ArrayList<>();

    try {
        //指定excel模板;我这是在项目根目录下创建了一个template文件夹存放excel导出模板文件
        TemplateExportParams params = new TemplateExportParams("./template/导出excel模板.xlsx");

        //从数据库查询到数据
        List<UserEntity> users = this.list();
        //定义一个原子序列
        AtomicInteger atomicInteger = new AtomicInteger(1); 
        users.forEach(user -> {

            Map<String, Object> map = new HashMap<>();
            map.put("id", atomicInteger.getAndIncrement());
            map.put("name", user.getName());
            map.put("age", user.getAge());
            map.put("sex", user.getSex());
            map.put("address", user.getAddress());
            map.put("describes", user.getDescribes());

            //添加到集合中,一个map就是一行
            listUsers.add(map);
        });
        mapList.put("users", listUsers);
        //调用exportExcel()
        Workbook workbook = ExcelExportUtil.exportExcel(params, mapList);

        //定义一个字节输出流
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        //将excel文件写入到新的输出流
        workbook.write(outputStream);

        //将字节数组放置到内存里面
        ByteArrayInputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());

        //导入xls包引用Workbook区分poi提供的Workbook
        com.spire.xls.Workbook wb = new com.spire.xls.Workbook();
        wb.loadFromStream(inputStream);
        //设置字段在一页中显示全
        wb.getConverterSetting().setSheetFitToPage(true);

        //指定并指定目录保存文件
        wb.saveToFile("D:/pdf/学生基本信息表.pdf");
    } catch (Exception e) {
        e.printStackTrace();
    }
}

注意:

  • 第一点:我是将pdf导出指定了目录为本地D:/pdf/学生基本信息表.pdf下,没有pdf文件夹则会自动创建一个。但如果你们是需求开发的话,你们得根据自己的实际开发环境来获取存放目录,我这里只是演示。其实也可以在页面开个口子,由用户进行手动选址,然后再将用户所选择的目录地址作为入参,这样就可以不用考虑用户保存在何位置了。
  • 第二点:与excel模板导出方法一致,后续这个导出方法可进行封装调用。
  • 第三点,如下是我的演示项目存放excel导出模板的目录结构截图,所以我就直接写定了模板的相对位置。

       接下来,交给我们的就只剩下测试了。

5、浏览器测试

      我们打开浏览器,在地址栏,输入我们刚才在Controller暴露出来的接口地址,

比如我的:http://localhost:8080/user/export-for-pdf 。而你就按你的接口地址填写然后回车进行访问即可。

具体浏览器访问截图如下:

       输入地址回车之后,查看一下控制台有无报错,我们再检查一下,指定文件夹是否已经存有该xxx.pdf文件。实际结果可以看到xxx.pdf文件已经存在该pdf文件夹下,证明pdf导出方法没有问题,还是很成功嘛,剩下的就是检查pdf文档数据及排版格式是否都按预定设置的一样?

       打开pdf文档,我是没想到,字段在一页展示不全,竟然分页展示,这样就不是很友好啊,那这肯定得想办法解决啊。不要急, bug菌替大家查阅了相关资料才知道有个属性可以设置不分页展示字段列,.setSheetFitToPage()设置为true即可实现字段列在一页中展示全。

如下是未设置了该属性导出的pdf截图:

       我们把它加上这个属性并设置为true,我们重启项目导出再来看下效果。

//设置字段在一页中显示全
wb.getConverterSetting().setSheetFitToPage(true);

       添加完这个属性之后,具体如下效果截图,相比上面的效果,这很明显是所有字段都归于一页展示了,而没有再分页。

       ... ...

       ok,以上就是我这期的全部内容啦,如果还想学习更多,你可以看看我的往期热文推荐哦,每天积累一个奇淫小知识,日积月累下去,你一定能成为令人敬仰的大佬的。好啦,咱们下期见~

四、热文推荐💭

    为了便于同学快速定位文章学习,熬夜几天终于整理出了【基础篇】【进阶篇】专栏的文章及有效地址,同学们敬请吩咐bug菌吧。

    目前基础篇已完结100篇+,进阶篇已完结70篇+,两专栏都在持续更新中;生命不息,更新不止,加油卷起来吧,同学们。部分文章总结如下:

4.1 Spring Boot【基础篇】

导读:SpringBoot 学习指南(附思维导图)

Spring Boot入门(01):Spring Boot的奋斗成长史

Spring Boot入门(02):快速开发环境搭建和项目启动

Spring Boot入门(03): yaml、properties配置文件介绍及使用

Spring Boot入门(04):多环境切换,实例演示

Spring Boot入门(05):starter基础入门

Spring Boot入门(06):Spring Boot常用注解大全

Spring Boot入门(07):整合 MySQL 和 Druid数据源(两万字教学)

Spring Boot入门(08):整合Mybatis访问MySQL实现增删改查

Spring Boot入门(09):使用MyBatis的XML配置方式访问MySQL实现增删改查

Spring Boot入门(10): mybatis之xml映射文件>、<=等特殊符号写法

Spring Boot入门(11):Spring Boot 整合 JPA

Spring Boot入门(12):整合Mybatis-Plus mybatis-plus实现接口增删改查

Spring Boot入门(13): Mybatis-Plus之条件构造器使用手册

Spring Boot入门(14): mybatis-plus之如何自定义sql

Spring Boot入门(15):Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码

Spring Boot入门(16):Spring Boot整合Swagger-UI实现在线API文档

Spring Boot入门(17):Spring Boot整合Knife4j,美化强化丑陋的Swagger

Spring Boot入门(18):Spring Boot静态资源映射

Spring Boot入门(19):Spring Boot 整合 Thymeleaf 模板引擎,开发Web页面

Spring Boot入门(20):实现多数据源配置,开箱即用

Spring Boot入门(21):整合Log4j2以及配置详解

Spring Boot入门(22):整合LogBack 实现日志文件本地保存

Spring Boot入门(23):Spring Boot基于AOP拦截日志

Spring Boot入门(24):Spring Boot事务

Spring Boot入门(25):过滤器、拦截器、监听器对比及使用场景

Spring Boot入门(26):实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等

Spring Boot入门(27):war包部

Spring Boot入门(28):jar包部署

Spring Boot入门(29):如何实现热部署

Spring Boot入门(30):Windows安装Redis客户端?你玩过么

... ...

若想学习更多,这边请👉👉👉《滚雪球学Spring Boot》👈👈👈

4.2 Spring Boot【进阶篇】

Spring Boot进阶(01):Spring Boot 集成 Redis,实现缓存自由

Spring Boot进阶(02):使用Validation进行参数校验

Spring Boot进阶(03):如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04):如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05):Spring Boot 整合RabbitMq,实现消息队列服务

Spring Boot进阶(06):Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07):集成EasyPoi,实现Excel/Word的导入导出

Spring Boot进阶(08):集成EasyPoi,实现Excel/Word携带图片导出

Spring Boot进阶(09):集成EasyPoi,实现Excel文件多sheet导入导出

Spring Boot进阶(10):集成EasyPoi,实现Excel模板导出成PDF文件

Spring Boot进阶(11):Spring Boot 如何实现纯文本转成.csv格式文件?

Spring Boot进阶(12):Spring Boot 如何获取Excel sheet页的数量?

Spring Boot进阶(13):Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值?

Spring Boot进阶(14):Spring Boot 如何手动连接库并获取指定表结构?一文教会你

Spring Boot进阶(15):根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16):Spring Boot 如何通过Redis实现手机号验证码功能?

Spring Boot进阶(17):Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18):SpringBoot如何使用@Scheduled创建定时任务?

Spring Boot进阶(19):Spring Boot 整合ElasticSearch

Spring Boot进阶(20):配置Jetty容器

Spring Boot进阶(21):配置Undertow容器

Spring Boot进阶(22):Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23):实现文件上传

Spring Boot进阶(24):如何快速实现多文件上传?

Spring Boot进阶(25):文件上传的单元测试怎么写?

Spring Boot进阶(26):Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27):Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28):Jar包Linux后台启动部署及滚动日志查看,日志输出至实体文件保存

Spring Boot进阶(29):如何正确使用@PathVariable,@RequestParam、@RequestBody等注解?不会我教你,结合Postman演示

Spring Boot进阶(30):@RestController和@Controller 注解使用区别,实战演示

... ...

若想学习更多,这边请👉👉👉《SpringBoot 进阶实战》 👈👈👈

若想系统完整的从0到1的学习,可以参考这篇专栏总结《2023最新首发,全网最全 Spring Boot 学习宝典(附思维导图)》本专栏致力打造最硬核 Spring Boot 进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中。欢迎大家订阅持续学习。

在入门及进阶之途,我必助你一臂之力,系统性学习,从入门到精通,带你不走弯路,直奔终点;投资自己,永远性价比最高,都这么说了,你还不赶紧来学??

本文涉及所有源代码,均已上传至github开源,供同学们一对一参考 GitHub传送门

同时,原创开源不易,欢迎给个star🌟,想体验下被🌟的感jio,非常感谢❗

五. 文末💭

我是bug菌,CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,掘金 | InfoQ | 51CTO等社区优质创作者,全网粉丝合计15w+ ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。