easyexcel

Project Url: alibaba/easyexcel
Introduction: 快速、简单避免 OOM 的 java 处理 Excel 工具
More: Author   ReportBugs   
Tags:

Build Status Maven central License

维护公告

尊敬的 EasyExcel 用户们:

首先,我们想表达最深的谢意,感谢您长期以来对 EasyExcel 的信任与支持。在这段旅程中,EasyExcel 有幸陪伴众多开发者和企业共同成长,见证了无数数据处理任务的高效完成。

近期,我们注意到市场上出现了更多优秀的数据处理工具和解决方案,为用户提供了更丰富的选择。为了确保每位用户都能享受到最佳的体验和服务,我们决定采取一项重要措施:EasyExcel 将逐步进入维护模式,并给予用户充足的时间评估并迁移到其他产品。同时,我们也欢迎并乐于见到社区内外分享关于同类优秀产品的使用心得和迁移经验,共同促进技术生态的健康发展。

请放心,即使进入维护模式,我们仍会确保 EasyExcel 的基本功能稳定运行,会进行 Bug 修复,但不再主动新增功能。我们相信,通过大家的共同努力,每一段代码、每一个项目都将继续在各自的领域发光发热,服务于更广泛的用户群体。 再次感谢您对 EasyExcel 的支持与理解!期待在技术的广阔天地里,我们能以新的形式再度携手,共创辉煌。

祝您在未来的工作与学习中一切顺利!

阿里巴巴 EasyExcel 团队敬上

新手必读

JAVA 解析 Excel 工具

Java 解析、生成 Excel 比较有名的框架有 Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi 有一套 SAX 模式的 API 可以一定程度的解决一些内存溢出的问题,但 POI 还是有一些缺陷,比如 07 版 Excel 解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。
easyexcel 重写了 poi 对 07 版 Excel 的解析,一个 3M 的 excel 用 POI sax 解析依然需要 100M 左右内存,改用 easyexcel 可以降低到几 M,并且再大的 excel 也不会出现内存溢出;03 版依赖 POI 的 sax 模式,在上层做了模型转换的封装,让使用者更加简单方便

16M 内存 23 秒读取 75M(46W 行 25 列)的 Excel(3.2.1+版本)

当然还有极速模式 能更快,但是内存占用会在 100M 多一点 img

最新版本


<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>4.0.3</version>
</dependency>

帮忙点个⭐Star

开源不易,如果觉得 EasyExcel 对您的工作还是有帮助的话,请帮忙在github star 的右上角点个⭐Star,您的支持是使 EasyExcel 变得更好最大的动力。

如何获取帮助

优先建议自己通过文档来解决问题

其次建议通过issues来解决解决问题

可以尝试在以下 2 个链接搜索问题,如果不存在可以尝试创建issue

通过 issues 解决问题,可以给后面遇到相同问题的同学查看,所以比较推荐这种方式。
不管githubgitee都会定期有人回答您的问题,比较紧急可以在提完issue以后在钉钉群艾特群主并发送issue地址帮忙解决。
QQ 公司不让用,有时候也会去看,但是核心肯定还是在钉钉。

也可以加入钉钉&QQ 群来解决问题

加入钉钉或 QQ 群,看完公告可以获得帮助 。
比较推荐钉钉群,QQ 公司不让用,当然 QQ 群也会有热心网友帮忙解决。
QQ1 群(已满): 662022184
QQ2 群(已满): 1097936804
QQ3 群(已满): 453928496
QQ4 群(已满): 496594404
QQ5 群(已满): 451925680
QQ6 群(已满): 784741035
QQ7 群(已满): 667889383
QQ8 群: 113968681
钉钉 1 群(已满): 21960511
钉钉 2 群(已满): 32796397
钉钉 3 群(已满): 33797247
钉钉 4 群(已满): 33491624
钉钉 5 群(已满): 32134498
钉钉 6 群(已满): 34707941
钉钉 7 群(已满): 35235427
钉钉 8 群(已满): 44752220
钉钉 9 群(已满): 11045002277
钉钉 10 群(已满): 27360019755
钉钉 11 群(已满):24330026964
钉钉 12 群(已满):27210038956
钉钉 13 群:83695000992

维护者

姬朋飞(玉霄)、庄家钜

快速开始

读 Excel

demo 代码地址:https://raw.githubusercontent.com/alibaba/easyexcel/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/read/ReadTest.java
详细文档地址:https://easyexcel.opensource.alibaba.com/docs/current/quickstart/read

    /**
    * 最简单的读
    * <p>1. 创建 excel 对应的实体对象 参照{@link DemoData}
    * <p>2. 由于默认一行行的读取 excel,所以需要创建 excel 一行一行的回调监听器,参照{@link DemoDataListener}
    * <p>3. 直接读即可
    */
    @Test
    public void simpleRead() {
        String fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
        // 这里 需要指定读用哪个 class 去读,然后读取第一个 sheet 文件流会自动关闭
        EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
    }

写 Excel

demo 代码地址:https://raw.githubusercontent.com/alibaba/easyexcel/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java
详细文档地址:https://easyexcel.opensource.alibaba.com/docs/current/quickstart/write

    /**
     * 最简单的写
     * <p>1. 创建 excel 对应的实体对象 参照{@link com.alibaba.easyexcel.test.demo.write.DemoData}
     * <p>2. 直接写即可
     */
    @Test
    public void simpleWrite() {
        String fileName=TestFileUtil.getPath()+"write"+System.currentTimeMillis()+".xlsx";
        // 这里 需要指定写用哪个 class 去读,然后写到第一个 sheet,名字为模板 然后文件流会自动关闭
        // 如果这里想使用 03 则 传入 excelType 参数即可
        EasyExcel.write(fileName,DemoData.class).sheet("模板").doWrite(data());
    }

web 上传、下载

demo 代码地址:https://raw.githubusercontent.com/alibaba/easyexcel/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/web/WebTest.java

    /**
    * 文件下载(失败了会返回一个有部分数据的 Excel)
    * <p>
    * 1. 创建 excel 对应的实体对象 参照{@link DownloadData}
    * <p>
    * 2. 设置返回的 参数
    * <p>
    * 3. 直接写,这里注意,finish 的时候会自动关闭 OutputStream,当然你外面再关闭流问题不大
    */
    @GetMapping("download")
    public void download(HttpServletResponse response) throws IOException {
        // 这里注意 有同学反应使用 swagger 会导致各种问题,请直接用浏览器或者用 postman
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        // 这里 URLEncoder.encode 可以防止中文乱码 当然和 easyexcel 没有关系
        String fileName=URLEncoder.encode("测试","UTF-8").replaceAll("\\+","%20");
        response.setHeader("Content-disposition","attachment;filename*=utf-8''"+fileName+".xlsx");
        EasyExcel.write(response.getOutputStream(),DownloadData.class).sheet("模板").doWrite(data());
    }

    /**
     * 文件上传
     * <p>1. 创建 excel 对应的实体对象 参照{@link UploadData}
     * <p>2. 由于默认一行行的读取 excel,所以需要创建 excel 一行一行的回调监听器,参照{@link UploadDataListener}
     * <p>3. 直接读即可
     */
    @PostMapping("upload")
    @ResponseBody
    public String upload(MultipartFile file)throws IOException{
        EasyExcel.read(file.getInputStream(),UploadData.class,new UploadDataListener(uploadDAO)).sheet().doRead();
        return"success";
    }
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools