Spring Boot 项目优雅实现 Excel 导入与导出功能

本文介绍了如何在 Spring Boot 中使用 EasyExcel 实现 Excel 的导入导出功能,并针对导入进行参数校验。通过自定义 controller 方法参数接收 Excel 文件内容和校验结果,简化了代码并提高了效率。此外,文章还提到已封装的 easyexcel-spring-boot-starter 项目,使得 EasyExcel 的使用更加便捷。
摘要由CSDN通过智能技术生成

Excel 导入与导出是项目中经常用到的功能,在 Java 中常用 poi 实现 Excel 的导入与导出。由于 poi 占用内存较大,在高并发下很容易发生 OOM 或者频繁 fullgc,阿里基于 poi 开源了 EasyExcel 项目。

除了节约内存,EasyExcel 还简化了 API,通过注解映射 Excel 单元格与对象字段之间的关系,简单的几行代码就能搞定复杂的导入导出功能了。

EasyExcel 问题

看似一切美好,不过经常做 Excel 导入与导出就会发现,EasyExcel 还是没那么完美的。

首先,导入与导出 Excel 本质是上将 Excel 文件内容与 Java 对象之间做一个映射,EasyExcel 做的只是在这两者之间转换。如果项目中的 Excel 导入与导出功能比较多,会产生大量的样板式代码,使用体验类似于 JDBC。

另外,导入往往还伴随着校验,这是 EasyExcel 没有支持的功能。如果需要校验,要么写代码手动判断,要么调用Java Validation 规范 定义的 API 判断,这又会产生大量样板式代码。

而且,当前 spring boot 已经成了必备的 Java 开发框架,easyexcel 也没有进行整合。

分析与解决

导入与导出通常发生在 Web 环境,对于 Spring MVC 来说,可以将请求信息转换为任意类型的 contoller 方法参数,将 controller 方法返回值转换为客户端支持的内容。

如果能够使用自定义的 controller 方法参数接收 Excel 文件内容,将 controller 方法返回值转换为 Excel 文件响应,可以直接消除 Excel 导入与导出时的样板式代码。

另外在将请求内容转换为 controller 方法参数时还可以加入自定义的校验逻辑。

由于 Excel 导入与导出样板式代码、校验问题与具体的业务逻辑无关,可以单独抽象出来,我这里在 EasyExcel 的基础上封装了一个 easyexcel-spring-boot-starter 的项目,大大降低了 EasyExcel 上手的门槛,对用户来说只需要使用 EasyExcel 定义的注解提供映射关系就可以了,适用于简单场景的导入导出。

下面就来看看怎样使用吧。

Spring Boot Excel 导入与导出

依赖引入

首先需要引入依赖,坐标如下。

<dependency>
    <groupId>com.zzuhkp</groupId>
    <artifactId>easyexcel-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

不过很不幸的是目前还没传至中央仓库,需要的小伙伴可自行上传到私有仓库或直接把代码嵌入自己的项目。

Excel 导入

首先看下要导入的 Excel 内容吧。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值