EasyPoi word导出教程

本文介绍了如何在SpringBoot项目中利用Easypoi库,根据Word模板填充数据并导出文件。文章详细阐述了处理图片、设置替换规则、导出流程以及在Linux环境下处理图片的方法。同时,针对Easypoi不支持多图片导出的问题,提出了解决方案和扩展的多图片导出思路。

(不需要copy代码,请专注于理解如何实现,我会详细解释代码!)

一、简要描述
  One day,我参与的项目中,用户提了个新需求。要求:按照给定 word模板,填充数据并导出。

  负责这个需求后,我查阅优快云,虽然也找到了一些文章,依据文章中的顺序,写出了demo。但demo毕竟是demo,在项目实战中,还是让我遇到不少坑。

  由于 easypoi对Word的支持不太友好,不支持多图片导出,因此研究之后,也找到一个办法,后续会展开叙述。

二、项目描述
  主要涉及:SpringBoot + MySQL + Linux

  实际项目会部署在Linux上,图片也是需要从服务器上解析到本地,转成Base64位字节才可以。不过我会提供全部的图片转Base64公共方法。

注意理解:Word支持显示的图片,是图片通过IO流转成的Base64字节

(正式开始 ===> follow me!)

第一步:准备Word模板
在这里插入图片描述

第二步:导入Jar包

		<!-- 集成 easypoi -->
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-base</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-web</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-annotation</artifactId>
            <version>3.3.0</version>
        </dependency>

第三步:Controller层 接口

	@ApiOperation(value = "导出巡查整改通知单")
    @PostMapping("/letter/notice/export")
    @ApiImplicitParams({
    
    @ApiImplicitParam(name = "id", value = "巡查id")})
    public void wordExport(@RequestParam Long id,HttpServletRequest request, HttpServletResponse response) throws IcmsException, IOException {
    
    
    	// 注入Service层
        service.wordExport(id, request, response);
    }

第四步:Service层 业务

	@Override
    public void wordExport(Long id, HttpServletRequest request, HttpServletResponse response) throws IcmsException, IOException {
    
    
        // 1.查询数据
        User user = userDao.selectList(new QueryWrapper<User>().eq("id",id));

        // 2.创建 map
        Map<String,Object> data = new HashMap<>();
        data.put("number",new SimpleDateFormat("yyyyMMddHHmmss").format
要使用 EasyPOI 导出 Word 文档,主要步骤包括:引入相关依赖、准备数据模型、使用模板导出文档。以下是详细实现方法: ### 引入依赖 EasyPOI 需要依赖多个库,包括 `easypoi-base`、`easypoi-web`、`easypoi-annotation` 以及 Apache POI 的 `poi` 和 `poi-ooxml`。如果需要支持模板中的高级功能(如图片循环导出),还需引入 `ooxml-schemas` 依赖。 ```xml <!-- Word 导出方式:EasyPOI --> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId> <version>4.4.0</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-web</artifactId> <version>4.4.0</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-annotation</artifactId> <version>4.4.0</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>4.1.1</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>4.1.1</version> </dependency> <!-- 如果需要支持模板中的高级功能(如图片循环导出) --> <dependency> <groupId>org.apache.poi</groupId> <artifactId>ooxml-schemas</artifactId> <version>1.4</version> </dependency> ``` ### 准备数据模型 在导出 Word 文档之前,需要准备一个数据模型。通常情况下,数据模型可以是一个 `Map` 或者一个带有注解的 Java 对象。如果使用 `Map`,可以将数据以键值对的形式存储。 ```java public void export(HttpServletResponse response) { // 1. 先逻辑处理,查询出需要导出的数据,这里测试先写死 // 2. 将需导出的数据,转为 map 键值方式 Map<String, Object> map = new HashMap<>(); map.put("year", "2024"); map.put("text", "测试导出"); map.put("month", "5"); map.put("list", new ArrayList<>()); // 如果是表格方式导出,用集合 ExportWordUtil.exportWordByModel(response, map, uploadPath + "/template.docx", String.valueOf(System.currentTimeMillis())); } ``` ### 使用模板导出文档 EasyPOI 支持通过模板导出 Word 文档。模板中可以包含文本、表格、图片等元素,并通过占位符(如 `${year}`)来绑定数据。 1. **创建模板文件**:在模板文件中使用占位符来表示数据的位置。例如: - `${year}` 表示年份 - `${text}` 表示文本 - `${list}` 表示表格数据 2. **导出文档**:使用 `ExportWordUtil` 工具类导出文档。`ExportWordUtil.exportWordByModel` 方法会将数据模型中的值绑定到模板中的占位符,并生成最终的 Word 文档。 3. **处理响应**:确保将生成的 Word 文档通过 `HttpServletResponse` 返回给客户端,以便用户可以下载。 ### 注意事项 - **依赖版本**:确保使用的 EasyPOI 版本为 4.3.0 或更高,以支持多图片循环导出等高级功能。 - **模板路径**:确保模板文件的路径正确,并且模板文件中包含的占位符与数据模型中的键一致。 - **性能优化**:对于大数据量的导出,建议进行性能优化,例如分页查询数据或使用异步导出。 ###
评论 17
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值