diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md
new file mode 100644
index 00000000..fb929a06
--- /dev/null
+++ b/.gitee/ISSUE_TEMPLATE.zh-CN.md
@@ -0,0 +1,9 @@
+**建议先去看文档**
+[快速开始](https://easyexcel.opensource.alibaba.com/docs/current/) 、[常见问题](https://easyexcel.opensource.alibaba.com/qa/)
+**异常代码**
+```java
+ 这里写你的代码
+```
+**异常提示**
+请提供完整的异常提示,记住是全部异常!
+**建议描述**
\ No newline at end of file
diff --git a/README.md b/README.md
index f30c3df0..58b71a12 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,64 @@ 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)
+# 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模式,在上层做了模型转换的封装,让使用者更加简单方便
+
+# github地址
+
+[https://github.com/alibaba/easyexcel](https://github.com/alibaba/easyexcel)
+
+# 官方网站
+
+[https://easyexcel.opensource.alibaba.com/](https://easyexcel.opensource.alibaba.com/)
+
+# 64M内存20秒读取75M(46W行25列)的Excel(3.0.2+版本)
+
+当然还有[极速模式](https://easyexcel.opensource.alibaba.com/qa/read#%E5%BC%80%E5%90%AF%E6%80%A5%E9%80%9F%E6%A8%A1%E5%BC%8F)
+能更快,但是内存占用会在100M多一点
+![img](img/readme/large.png)
+
+# 最新版本
+
+```xml
+
+
1. 创建excel对应的实体对象 参照{@link DemoData} - *
2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link DemoDataListener} - *
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(); + * 最简单的读 + *
1. 创建excel对应的实体对象 参照{@link DemoData} + *
2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link DemoDataListener} + *
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 +## 写Excel + DEMO代码地址:[https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java](https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java) + ```java /** - * 最简单的写 - *
1. 创建excel对应的实体对象 参照{@link com.alibaba.easyexcel.test.demo.write.DemoData} - *
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()); + * 最简单的写 + *
1. 创建excel对应的实体对象 参照{@link com.alibaba.easyexcel.test.demo.write.DemoData} + *
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上传、下载 +## web上传、下载 + DEMO代码地址:[https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/web/WebTest.java](https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/web/WebTest.java) + ```java /** - * 文件下载(失败了会返回一个有部分数据的Excel) - *
- * 1. 创建excel对应的实体对象 参照{@link DownloadData} - *
- * 2. 设置返回的 参数 - *
- * 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()); + * 文件下载(失败了会返回一个有部分数据的Excel) + *
+ * 1. 创建excel对应的实体对象 参照{@link DownloadData} + *
+ * 2. 设置返回的 参数 + *
+ * 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()); } - /** - * 文件上传 - *
1. 创建excel对应的实体对象 参照{@link UploadData} - *
2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link UploadDataListener} - *
3. 直接读即可 - */ - @PostMapping("upload") - @ResponseBody - public String upload(MultipartFile file) throws IOException { - EasyExcel.read(file.getInputStream(), UploadData.class, new UploadDataListener(uploadDAO)).sheet().doRead(); - return "success"; +/** + * 文件上传 + *
1. 创建excel对应的实体对象 参照{@link UploadData} + *
2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link UploadDataListener} + *
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留言。其他技术非技术相关的也欢迎一起探讨。 +``` \ No newline at end of file