README.md 6.0 KB
Newer Older
庄家钜's avatar
庄家钜 已提交
1
EasyExcel
2 3 4 5
======================
[![Build Status](https://travis-ci.org/alibaba/easyexcel.svg?branch=master)](https://travis-ci.org/alibaba/easyexcel)
[![Maven central](https://maven-badges.herokuapp.com/maven-central/com.alibaba/easyexcel/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.alibaba/easyexcel)
[![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
Z
zhuangjiaju 已提交
6

庄家钜's avatar
庄家钜 已提交
7 8
[QQ1群(已满): 662022184](https://jq.qq.com/?_wv=1027&k=1T21jJxh)
[QQ2群: 1097936804](https://jq.qq.com/?_wv=1027&k=j5zEy6Xl)
庄家钜's avatar
庄家钜 已提交
9
[钉钉1群(已满): 21960511](https://qr.dingtalk.com/action/joingroup?code=v1,k1,cchz6k12ci9B08NNqhNRFGXocNVHrZtW0kaOtTKg/Rk=&_dt_no_comment=1&origin=11)
庄家钜's avatar
庄家钜 已提交
10 11
[钉钉2群(已满): 32796397](https://qr.dingtalk.com/action/joingroup?code=v1,k1,jyU9GtEuNU5S0QTyklqYcYJ8qDZtUuTPMM7uPZTS8Hs=&_dt_no_comment=1&origin=11)
[钉钉3群: 33797247](https://qr.dingtalk.com/action/joingroup?code=v1,k1,3UGlEScTGQaHpW2cIRo+gkxJ9EVZ5fz26M6nW3uFP30=&_dt_no_comment=1&origin=11)
庄家钜's avatar
庄家钜 已提交
12 13 14 15

[官方网站: https://yuque.com/easyexcel](https://www.yuque.com/easyexcel/doc/easyexcel)

[常见问题](https://www.yuque.com/easyexcel/faq)
16
#### 因为公司不方便用QQ,所以建议加钉钉群
Z
zhuangjiaju 已提交
17

庄家钜's avatar
庄家钜 已提交
18
# JAVA解析Excel工具EasyExcel
Z
zhuangjiaju 已提交
19
Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,能够原本一个3M的excel用POI sax依然需要100M左右内存降低到几M,并且再大的excel不会出现内存溢出,03版依赖POI的sax模式。在上层做了模型转换的封装,让使用者更加简单方便
庄家钜's avatar
庄家钜 已提交
20 21 22 23 24

## 64M内存1分钟内读取75M(46W行25列)的Excel
当然还有急速模式能更快,但是内存占用会在100M多一点
![img](img/readme/large.png)

25
## 相关文档
庄家钜's avatar
庄家钜 已提交
26
* [快速开始](https://www.yuque.com/easyexcel/doc/easyexcel)
Z
zhuangjiaju 已提交
27
* [关于软件](/abouteasyexcel.md)
J
update  
jipengfei.jpf 已提交
28
* [更新记事](/update.md)
庄家钜's avatar
庄家钜 已提交
29
* [贡献代码](https://www.yuque.com/easyexcel/doc/contribute)
30

31
## 维护者
J
jipengfei-jpf 已提交
32
玉霄、庄家钜、怀宇
33 34
## 快速开始
### 读Excel
Z
zhuangjiaju 已提交
35 36 37 38 39
DEMO代码地址:[https://github.com/alibaba/easyexcel/blob/master/src/test/java/com/alibaba/easyexcel/demo/read/ReadTest.java](/src/test/java/com/alibaba/easyexcel/test/demo/read/ReadTest.java)

```java
    /**
     * 最简单的读
罗成 已提交
40
     * <p>1. 创建excel对应的实体对象 参照{@link DemoData}
庄家钜's avatar
庄家钜 已提交
41
     * <p>2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link DemoDataListener}
罗成 已提交
42
     * <p>3. 直接读即可
Z
zhuangjiaju 已提交
43 44 45 46
     */
    @Test
    public void simpleRead() {
        String fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
Z
zhuangjiaju 已提交
47 48
        // 这里 需要指定读用哪个class去读,然后读取第一个sheet 文件流会自动关闭
        EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
Z
zhuangjiaju 已提交
49
    }
50 51
```

52
### 写Excel
Z
zhuangjiaju 已提交
53 54 55 56
DEMO代码地址:[https://github.com/alibaba/easyexcel/blob/master/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java](/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java)
```java
    /**
     * 最简单的写
罗成 已提交
57 58
     * <p>1. 创建excel对应的实体对象 参照{@link com.alibaba.easyexcel.test.demo.write.DemoData}
     * <p>2. 直接写即可
Z
zhuangjiaju 已提交
59 60 61
     */
    @Test
    public void simpleWrite() {
Z
zhuangjiaju 已提交
62 63
        String fileName = TestFileUtil.getPath() + "write" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去读,然后写到第一个sheet,名字为模板 然后文件流会自动关闭
Z
zhuangjiaju 已提交
64
        // 如果这里想使用03 则 传入excelType参数即可
Z
zhuangjiaju 已提交
65
        EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());
Z
zhuangjiaju 已提交
66
    }
67 68
```

Z
zhuangjiaju 已提交
69 70 71
### web上传、下载
DEMO代码地址:[https://github.com/alibaba/easyexcel/blob/master/src/test/java/com/alibaba/easyexcel/test/demo/web/WebTest.java](/src/test/java/com/alibaba/easyexcel/test/demo/web/WebTest.java)
```java
72
   /**
73
     * 文件下载(失败了会返回一个有部分数据的Excel)
74 75 76 77 78 79
     * <p>
     * 1. 创建excel对应的实体对象 参照{@link DownloadData}
     * <p>
     * 2. 设置返回的 参数
     * <p>
     * 3. 直接写,这里注意,finish的时候会自动关闭OutputStream,当然你外面再关闭流问题不大
Z
zhuangjiaju 已提交
80 81 82
     */
    @GetMapping("download")
    public void download(HttpServletResponse response) throws IOException {
83
        // 这里注意 有同学反应使用swagger 会导致各种问题,请直接用浏览器或者用postman
Z
zhuangjiaju 已提交
84
        response.setContentType("application/vnd.ms-excel");
J
jipengfei-jpf 已提交
85
        response.setCharacterEncoding("utf-8");
86
        // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
87 88
        String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
Z
zhuangjiaju 已提交
89
        EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());
Z
zhuangjiaju 已提交
90 91 92 93
    }

    /**
     * 文件上传
罗成 已提交
94
     * <p>1. 创建excel对应的实体对象 参照{@link UploadData}
庄家钜's avatar
庄家钜 已提交
95
     * <p>2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link UploadDataListener}
罗成 已提交
96
     * <p>3. 直接读即可
Z
zhuangjiaju 已提交
97 98 99 100
     */
    @PostMapping("upload")
    @ResponseBody
    public String upload(MultipartFile file) throws IOException {
101
        EasyExcel.read(file.getInputStream(), UploadData.class, new UploadDataListener(uploadDAO)).sheet().doRead();
Z
zhuangjiaju 已提交
102
        return "success";
J
jipengfei-jpf 已提交
103
    }
104 105
```
### 联系我们
J
jipengfei-jpf 已提交
106
有问题阿里同事可以通过钉钉找到我,阿里外同学可以通过git留言。其他技术非技术相关的也欢迎一起探讨。
J
jipengfei.jpf 已提交
107
### 招聘&交流
J
jipengfei-jpf 已提交
108
阿里巴巴新零售事业部--诚招JAVA资深开发、技术专家。有意向可以微信联系,简历可以发我邮箱jipengfei.jpf@alibaba-inc.com