likes
comments
collection
share

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

作者站长头像
站长
· 阅读数 92

       嗨，家人们，我是bug菌呀，我又来啦。今天我们来聊点什么咧，OK，接着为大家更《springboot零基础入门教学》系列文章吧。希望能帮助更多的初学者们快速入门！

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

一、前言🔥

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

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

       但是日常，除了导出excel，还很大几率需要接触到word的导入导出、pdf导出等其他格式的文档导出导出业务，比如把数据导出到word文档中且本地下载，最常见的一个应用场景：用户个人档案导出。

       场景：就是先定一个word模板，然后将个人数据进行自动填充到模板上，最后导出成word文档，代替人工手填的一个过程。这个需求我以前在开发人事OA系统的时候摸过，还是挺有意思的，所以今天我就打算带着大家从零摸索，实现一个单word模板导出多页数据的功能 ，可以吧？

       接下来我就开始讲啦，同学们可得竖起耳朵好好听讲哦~

二、引入pom依赖

       由于EasyPoi可以很方便的通过一个word模板，然后通过填充模板的方式生成我们想要的word文档。所以我们今天依旧是基于easypoi来实现word文档导出。

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

三、实现word导出

1、先定义一个word模板文件

       我还是以用户类进行导出吧，所以我就在word中创建一个表格， 表格输出某个用户或者所有用户的详细信息。所以我指定的word模板文件如下：

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

2、确定模板取值命名

       你在进行模板自动填值的过程中，就得通过唯一命名来进行赋值了，所以你需要在你word模板中进行取值，而取值就是直接{{name}},其中name就是你所给该位置需要取值的字段名。

简言之采用的写法就是{{}}代表表达式，然后根据表达式里面的数据取值。

比如如下：

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

3、Controller添加word导出方法

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

/**
 * word文档导出
 */
@GetMapping("export-word")
@ApiOperation(value = "word文档导出", notes = "word文档导出")
public void exportUsersToWord(HttpServletResponse response) throws Exception {
    userService.exportUsersToWord(response);
}

       不需要任何返回值及参数，你只需要携带你调用接口时的请求HttpServletResponse 即可

4、定义导入接口

/**
 * word文档导出
 */
void exportUsersToWord(HttpServletResponse response) throws Exception;

5、实现导出方法(核心)

       如下这个导出实现类就很关键了，我们就可以直接使用easypoi提供的exportWord07()方法，该方法就可以将你的数据进行赋值转化到指定的word模板中。详细使用请参考我写的：

代码具体设置如下：

/**
 * word文档导出
 */
@Override
public void exportUsersToWord(HttpServletResponse response) throws Exception {
    //准备导出数据
    List<Map<String, Object>> listUsers = new ArrayList<>();

    //查询所有用户数据
    List<UserEntity> users = this.list();

    users.forEach(user -> {
        //一个map就对应一个模板
        Map<String, Object> map = new HashMap<>();
        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());
        //添加
        listUsers.add(map);
    });

    //导出word并指定word导出模板
    XWPFDocument doc = WordExportUtil.exportWord07("./template/用户导出模板.docx", listUsers);

    //设置编码格式
    response.setCharacterEncoding(StandardCharsets.UTF_8.name());
    //设置内容类型
    response.setContentType("application/octet-stream");
    //设置头及文件命名。
    response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode("学生基本信息表.docx", StandardCharsets.UTF_8.name()));

    //写入
    doc.write(response.getOutputStream());
}

       其中，第一点你们需要注意的就是，一般word文档是放于指定服务器位置上的或者放于项目中，我是直接在项目根目录下创建了一个名为：template的文件夹，专门用于存放指定模板类的文件，否则直接引用本地绝对位置文件，换台电脑或者其他同事本地跑就不是很方便。

       如下是我项目template 文件夹位置实际截图:

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

       第二点就是，指定下载文件名及指定response的请求类型，意味着告诉浏览器你是在干一件什么类型的事，所以设置response.setContentType("application/octet-stream").

       接下来word导出方法我们就已经写完了，剩下的就是进行对应的测试啦。

6、浏览器测试接口

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

比如我的：http://localhost:8080//user/export-word  你按你的接口地址进行访问即可。

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

       输入完直接回车，可以看到有一个文件正在被下载，剩下的就看内容是否被回填了。

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

       如上图所示，看到数据填写的正是数据库的一条数据，这就说明导出word模板方法是没有问题的。

       下载完打开一看，很nice所有的用户信息都获取到了，一个map对应的就是一个word模板文档，总共查询到了9个用户，但是这里总共分了10页，最后一页是空白页，啥内容也没有，不知道究竟是什么？如果有知道的小伙伴，欢迎交流啊，互相学习~

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

       但是一般情况下我们是不会全部都进行word写出的，一般都是携带用户唯一id查询数据然后再进行导出，这样用户信息就只有一条！这就看需求啦，有的可能是导出所有内容，就看针对的用户需求是什么，不过这肯定很好调整啊，也可以更贴近用户想法，导出多少条，由用户自己来控制就好了，有的是按页导出，有的是按条导出等。

       当然，还有就是对于一个模板导出所有数据的实现功能，我将在下期进行讲解。

       ... ...

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

四、往期热门推荐

文末🔥

       如果还想要学习更多，小伙伴们可关注bug菌专门为大家创建的专栏《springboot零基础入门教学》，从无到有，从零到一！希望能帮助到更多小伙伴们。

我是bug菌，一名想走👣出大山改变命运的程序猿。接下来的路还很长，都等待着我们去突破、去挑战。来吧，小伙伴们，我们一起加油！未来皆可期，fighting！

Springboot系列(十六):集成easypoi实现单word模板导出多页功能(实战篇一)

感谢认真读完我博客的铁子萌，在这里呢送给大家一句话，不管你是在职还是在读，绝对终身受用。 时刻警醒自己： 抱怨没有用，一切靠自己； 想要过更好的生活，那就要逼着自己变的更强，生活加油！！！

转载自:https://juejin.cn/post/7065866450057232397
评论
请登录