7 行代码实现 Excel 文件导出

梦里梦外; 2021-07-31 22:02 352阅读 0赞

![640?wx\_fmt=png][640_wx_fmt_png]

作 者：犬小哈

来 源：首发自「小哈学Java」

**广而告之：**由于此订阅号换了个皮肤，系统自动取消了读者的公众号置顶。导致用户接受文章不及时。可以打开订阅号，选择置顶（标星）公众号，重磅干货，第一时间送达！

## **目录** ##

*  一、前言
 *  二、Apache poi、jxl 的缺陷
 *  三、阿里出品的 EasyExcel，安利一波
 *  四、EasyExcel 解决了什么
 *  五、快速上手
 *  六、特殊场景支持
 *  七、Web 下载示例代码
 *  八、需要注意的点
 *  九、总结

## **一、前言** ##

关于导出 Excel 文件，可以说是大多数服务中都需要集成的功能。那么，要如何优雅快速地（**偷懒地**）去实现这个功能呢？

你可能第一想法是：这还不简单？用 Apache 开源框架 poi, 或者 jxl 都可以实现啊。面向百度编程，把代码模板 copy 下来，根据自己的业务再改改，能有多难？

嗯.. 的确不难，但是你的代码可能是下面这个熊样子的：

![640?wx\_fmt=png][640_wx_fmt_png 1]

上面这段代码看上去是不是又臭又长呢？今天，小哈将教您如何使用 7 行代码搞定 Excel 文件生成功能！

## **二、Apache poi、jxl 的缺陷** ##

在说如何实现之前，我们先来讨论一下传统 Excel 框架的不足！除了上面说的，Apache poi、jxl 都存在生成 excel 文件不够简单优雅快速外，它们都还存在一个严重的问题，那就是**非常耗内存**，**严重时会导致内存溢出**。

POI 虽然目前来说，是 excel 解析框架中被使用最广泛的，但这个框架并不完美。

为什么这么说呢？

开发者们大部分使用 POI，都是使用其 userModel 模式。而 userModel 的好处是上手容易使用简单，随便拷贝个代码跑一下，剩下就是写业务转换了，虽然转换也要写上百行代码，但是还是可控的。

然而 userModel 模式最大的问题是在于，对内存消耗非常大，一个几兆的文件解析甚至要用掉上百兆的内存。现实情况是，很多应用现在都在采用这种模式，之所以还正常在跑是因为并发不大，并发上来后，一定会OOM或者频繁的 full gc。

## **三、阿里出品的 EasyExcel，安利一波** ##

什么是 EasyExcel? 见名知意，就是让你操作 Excel 异常的酸爽。先来看下 EasyExcel GitHub 官方截图：

![640?wx\_fmt=png][640_wx_fmt_png 2]

截止目前为止已有 5519 Star, 官方对其的简介是：

快速、简单避免OOM的java处理Excel工具！

以下是官方介绍：

![640?wx\_fmt=png][640_wx_fmt_png 3]

## **四、EasyExcel 解决了什么** ##

主要来说，有以下几点：

*  传统 Excel 框架，如 Apache poi、jxl 都存在内存溢出的问题；
 *  传统 excel 开源框架使用复杂、繁琐;
 *  EasyExcel 底层还是使用了 poi, 但是做了很多优化，如修复了并发情况下的一些 bug, 具体修复细节，可阅读官方文档https://github.com/alibaba/easyexcel；

## **五、快速上手** ##

### **5.1 添加依赖** ###

<dependency>	
      <groupId>com.alibaba</groupId>	
      <artifactId>easyexcel</artifactId>	
      <version>1.1.2-beta5</version>	
    </dependency>

### **5.2 七行代码搞定 Excel 生成** ###

![640?wx\_fmt=png][640_wx_fmt_png 4]

上面这段示例代码中，有两个点很重要，小哈已经重点标注标：

*  **①：**WriteModel 这个对象就是要写入 Excel 的数据模型对象，等等，你这好像不行吧？表头 head，以及每个单元格内的数据顺序都没指定，能达到想要的效果么？别急，后面会讨论这块！
 *  **②**：创建需要写入的数据集，当然了，正常业务中，这块都是从数据库中查询出来的。

> PS: 如果说写入的数据量很大，需要做分片查询再写入的处理，否则可能会 OOM（Out of Memory）.

回过头来，我们来看看 `WriteModel` 这个对象内部到底有什么幺蛾子！

![640?wx\_fmt=png][640_wx_fmt_png 5]

ExayExcel 提供注解的方式, 来方便的定义 Excel 需要的数据模型：

*  **①**：首先，定义的写入模型必须要继承自 `BaseRowModel.java`;
 *  **②**：通过 `@ExcelProperty` 注解来指定每个字段的**列名称**，以及**下标位置**；

同时，上面定义的 `createModelList()` 方法也很简单，通过循环，创建一个写入模型的 List 集合：

![640?wx\_fmt=png][640_wx_fmt_png 6]

废话不多说，这个快速接入的案例也介绍的差不多了，跑一跑单元测试看下实际效果：

![640?wx\_fmt=png][640_wx_fmt_png 7]

怎么样，效果还是挺棒棒的！

## **六、特殊场景支持** ##

在实际的业务中，我们还会有一些特需的需求，比如说下面这些。

### **6.1 动态生成 Excel 内容** ###

上面的例子是基于注解的，也就是说表头 head, 以及内容都是写死的，换句话说，我定义好了一个数据模型，那么，生成的 Excel 文件也就是只能遵循这种模型来了，但是，实际业务中可能会存在动态变化的需求，要怎么做呢？

![640?wx\_fmt=png][640_wx_fmt_png 8]

*  **①**：无注解模式，动态添加表头，也可自由组合复杂表头，代码如下：

![640?wx\_fmt=png][640_wx_fmt_png 9]

*  **②**：创建动态数据，注意这里的数据类型是 `Object`:

![640?wx\_fmt=png][640_wx_fmt_png 10]

跑一下单元测试，看下效果：

![640?wx\_fmt=png][640_wx_fmt_png 11]

### **6.2 自定义表头以及内容样式** ###

我想自定义表头，内容样式，咋办？![640?wx\_fmt=png][640_wx_fmt_png 12]

我们复用了上面的示例代码，并额外添加了设置自定义表格样式的代码, `createTableStytle()`具体内容如下：

![640?wx\_fmt=png][640_wx_fmt_png 13]

我们可以通过 `TableStyle` 这个类来设置表头、表格主题的样式。

### **6.3 合并单元格** ###

我们可以通过 `merge()` 方法来合并单元格：

![640?wx\_fmt=png][640_wx_fmt_png 14]

注意下标是从 0 开始的，也就是说合并了第六行到第七行，其中的第一列到第五列，跑下代码，看下效果：

![640?wx\_fmt=png][640_wx_fmt_png 15]

### **6.4 自定义处理** ###

对于更复杂的处理，EasyExcel 预留了 `WriterHandler` 接口来，允许你自定义处理代码：

![640?wx\_fmt=png][640_wx_fmt_png 16]

接口中定义了三个方法:

*  `sheet()`: 在创建每个 sheet 后自定义业务逻辑处理；
 *  `row()`: 在创建每个 row 后自定义业务逻辑处理；
 *  `cell()`: 在创建每个 cell 后自定义业务逻辑处理；

我们实现了该接口后，编写自定义逻辑处理代码，然后调用 `getWriterWithTempAndHandler()`静态方法获取 `ExcelWriter` 对象时，传入 `WriterHandler` 的实现类即可。

![640?wx\_fmt=png][640_wx_fmt_png 17]

比如下面的示例代码：

ExcelWriter writer = EasyExcelFactory.getWriterWithTempAndHandler(null, out, ExcelTypeEnum.XLSX, true, new MyWriterHandler());

## 七、Web 下载示例代码 ##

public class Down {	
        @GetMapping("/a.htm")	
        public void cooperation(HttpServletRequest request, HttpServletResponse response) {	
            ServletOutputStream out = response.getOutputStream();	
            ExcelWriter writer = new ExcelWriter(out, ExcelTypeEnum.XLSX, true);	
            String fileName = new String(("UserInfo " + new SimpleDateFormat("yyyy-MM-dd").format(new Date()))	
                    .getBytes(), "UTF-8");	
            Sheet sheet1 = new Sheet(1, 0);	
            sheet1.setSheetName("第一个sheet");	
            writer.write0(getListString(), sheet1);	
            writer.finish();	
            response.setContentType("multipart/form-data");	
            response.setCharacterEncoding("utf-8");	
            response.setHeader("Content-disposition", "attachment;filename="+fileName+".xlsx");	
            out.flush();	
            }	
        }

## **八、需要注意的点** ##

### **8.1 写入大数据时，需分片** ###

比如说，我们需要从数据库中查询出数据量较大时，我们需要在业务层做分片处理，也就是，我们需要分多次查询，再写入，防止内存溢出 OOM.

### **8.2 Excel 最大行数问题** ###

Excel 03, 07 版本均有行数、列数的限制：

<table> 
 <thead> 
  <tr> 
   <th>版本</th> 
   <th>最大行</th> 
   <th>最大列</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Excel 2003</td> 
   <td>65536</td> 
   <td>256</td> 
  </tr> 
  <tr> 
   <td>Excel 2007</td> 
   <td>1048576</td> 
   <td>16384</td> 
  </tr> 
 </tbody> 
</table>

> csv 由于是文本文件，实际上没有最大行数的限制，但是用 Excel 客户端打开还是多了不显示。

也就是说，如果你想写入更多的行数是不行的，强行这么做，程序会报类似如下异常

Invalid row number (1048576) outside allowable range (0..1048575)

**如何解决呢？**

1.  分多个 Excel 文件写入;
2.  同一个 Excel 文件，分多个 Sheet 写入；

## **九、总结** ##

小哈今天主要给小伙伴介绍了 EasyExcel, 为什么要使用它，以及演示了相关示例代码。当然了，EasyExcel 除了写 Excel 文件外，它还有快速读取 Excel 的功能，由于本文主要介绍的是：如何优雅地实现 Excel 文件生成，所以就没有介绍了，有兴趣的小伙伴们，也可以去 GitHub 官网去去查看相关文档。

最后，祝您看完本文后有所收获，下期见！

## **十、GitHub 源码地址** ##

https://github.com/weiwosuoai/spring-boot-tutorial/tree/master/spring-boot-excel

## **十一、参考文献** ##

https://github.com/alibaba/easyexcel

**推****荐****阅****读**

***1.***

***2.  ***

***3.***

***4.***

![640?][640]

[640_wx_fmt_png]: /images/20210731/e174d87ce25c4325b5d4107526a6b130.png?wx_fmt=png
[640_wx_fmt_png 1]: /images/20210731/ca01388551214bbfac301e8e488e5748.png?wx_fmt=png
[640_wx_fmt_png 2]: /images/20210731/7f7ae302afb943c09fbdc6a5ae411443.png?wx_fmt=png
[640_wx_fmt_png 3]: /images/20210731/c8c607da1c4c4e90a70b644f99532adf.png?wx_fmt=png
[640_wx_fmt_png 4]: /images/20210731/706591bceadb464cb474fd41a88385f7.png?wx_fmt=png
[640_wx_fmt_png 5]: /images/20210731/321ace6933e84c65ad7c09d49df93b11.png?wx_fmt=png
[640_wx_fmt_png 6]: /images/20210731/804db6a8059f46fab7b86d24ad9156f8.png?wx_fmt=png
[640_wx_fmt_png 7]: /images/20210731/3ff13829e4e84525ae2fa19c3142fc60.png?wx_fmt=png
[640_wx_fmt_png 8]: /images/20210731/d04b55dec5834345aa2f083cabeb802b.png?wx_fmt=png
[640_wx_fmt_png 9]: /images/20210731/48a5c610397447cabf1ab5f056441df0.png?wx_fmt=png
[640_wx_fmt_png 10]: /images/20210731/3fd922fcf16148e0a235787fe6867cc7.png?wx_fmt=png
[640_wx_fmt_png 11]: /images/20210731/fefd72d37d09447790b955ecf113fb8c.png?wx_fmt=png
[640_wx_fmt_png 12]: /images/20210731/d9a7ba5840b4408c9268005cbbe08308.png?wx_fmt=png
[640_wx_fmt_png 13]: /images/20210731/4653110ac407412a991d71ac32ec2fe2.png?wx_fmt=png
[640_wx_fmt_png 14]: /images/20210731/5d63ab0a292442b7a8b50fa69f45f07a.png?wx_fmt=png
[640_wx_fmt_png 15]: /images/20210731/bc7aa3da8f154f2791e0a9202770a071.png?wx_fmt=png
[640_wx_fmt_png 16]: /images/20210731/87fa6fce27584921800ede032de065a2.png?wx_fmt=png
[640_wx_fmt_png 17]: /images/20210731/d2e34dcd59a7400ea0124e65513ab00e.png?wx_fmt=png
[640]: /images/20210731/2dc9c6121902452f87dada7205866f60.png?