You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jiaju Zhuang d5a2755775 修改文档描述 3 years ago
.github 新增多版本测试 3 years ago
.mvn/wrapper 修改mvn的版本 3 years ago
docs 优化读取全部sheet方案 5 years ago
easyexcel 修改javadoc 无法生成 3 years ago
easyexcel-core * 读写支持`try-with-resources`语法糖 3 years ago
easyexcel-support 修改javadoc 无法生成 3 years ago
easyexcel-test * 读写支持`try-with-resources`语法糖 3 years ago
img 优化读写性能 3 years ago
src/test/java/com/alibaba/easyexcel/test/demo 修改文档描述 3 years ago
style 1. 加入mvnw 统一mvn 版本 5 years ago
.editorconfig 1. 加入mvnw 统一mvn 版本 5 years ago
.gitignore 修改目录结构 3 years ago
CONTRIBUTING.md 修改合并异常 3 years ago
LICENSE Initial commit 7 years ago
README.md 修改文档描述 3 years ago
README_EN.md Create README_EN.md 3 years ago
abouteasyexcel.md 支持通过模板填充数据 5 years ago
easyexcel_en.md update 7 years ago
lombok.config 修改完成部分图片等导入 4 years ago
mvnw 修改mvn的版本 3 years ago
mvnw.cmd 修改mvn的版本 3 years ago
pom.xml 修改作者继承 3 years ago
quickstart.md 优化读取全部sheet方案 5 years ago
update.md * 读写支持`try-with-resources`语法糖 3 years ago

README.md

EasyExcel

Build Status Maven central License

QQ1群(已满): 662022184
QQ2群(已满): 1097936804
QQ3群(已满): 453928496
QQ4群: 496594404
钉钉1群(已满): 21960511
钉钉2群(已满): 32796397
钉钉3群(已满): 33797247
钉钉4群(已满): 33491624
钉钉5群(已满): 32134498
钉钉6群(已满): 34707941
钉钉7群: 35235427
官方网站: https://yuque.com/easyexcel

常见问题

因为公司不方便用QQ,所以建议加钉钉群

JAVA解析Excel工具EasyExcel

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模式,在上层做了模型转换的封装,让使用者更加简单方便

64M内存20秒读取75M(46W行25列)的Excel(3.0.2+版本)

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

关于版本选择

如果项目中没有使用过poi,且jdk版本在8-17之间,直接使用最新版本,别犹豫。以下表格适用于不满足以上2个情况的。

版本 poi依赖版本 (支持范围) jdk版本支持范围 备注
3.1.0+ 4.1.2 (4.1.2 - 5.2.2) jkd8 - jdk17 推荐使用,会更新的版本
3.0.0-beta1 - 3.0.5 4.1.2 (4.1.2 - 5.2.2) jkd8 - jdk11 不推荐项目新引入此版本,除非超级严重bug,否则不再更新
2.0.0-beta1-2.2.11 3.17 (3.17 - 4.1.2) jdk6 - jdk11 不推荐项目新引入此版本,除非是jdk6否则不推荐使用,除非超级严重bug,否则不再更新
1+版本 3.17 (3.17 - 4.1.2) jdk6 - jdk11 不推荐项目新引入此版本,超级严重bug,也不再更新

注意: 3+版本的的easyexcel,使用poi 5+版本时,需要手动排除:poi-ooxml-schemas,例如:

 <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.1.0</version>
            <exclusions>
                <exclusion>
                    <artifactId>poi-ooxml-schemas</artifactId>
                    <groupId>org.apache.poi</groupId>
                </exclusion>
            </exclusions>
</dependency>

关于版本升级

  • 不建议跨大版本升级 尤其跨2个大版本
  • 2+ 升级到 3+ 一些不兼容的地方
    • 使用了自定义拦截器去修改样式的会出问题(不会编译报错)
    • 读的时候invoke里面抛出异常,不会再额外封装一层ExcelAnalysisException (不会编译报错)
    • 样式等注解涉及到 boolean or 一些枚举 值的 有变动,新增默认值(会编译报错,注解改就行)
  • 大版本升级后建议相关内容重新测试下

最新版本

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

easyexcel人员招募

由于工作较忙,有意愿做开源的同学可以报名,主要负责群里回答&issue处理,当然也可以做一些PR.
由于开源没有任何物质回报,然后现在的维护同学也是课余时间维护的,所以想加入的同学需要持之以恒,而不是一时兴起.
要求如下:

  • 有一定java编码能力 & 良好的编码习惯
  • 了解easyexcel 读&写的原理
  • 热爱开源项目
  • 能长期坚持的去做
  • 相对工作没那么忙

相关文档

维护者

姬朋飞(玉霄)、庄家钜、怀宇

快速开始

读Excel

DEMO代码地址:https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/read/ReadTest.java

    /**
     * 最简单的读
     * <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://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java

    /**
     * 最简单的写
     * <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://github.com/alibaba/easyexcel/blob/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";
    }

联系我们

有问题阿里同事可以通过钉钉找到我,阿里外同学可以通过git留言。其他技术非技术相关的也欢迎一起探讨。