Alibaba 表格开源工具 easyexcel 快速使用教程_alibaba easyexcel

目录

Easyexcel 表格工具概述

Easyexcel 常用 API

Easyexcel 读 Excel

Easyexcel 写 Excel

Easyexcel  上传、下载

解决下载文件名称乱码

---

Easyexcel 表格工具概述

1、工作中使用 excel 表格处理数据是很常见的操作，经常会使用 excel 文件来导入数据或者导出数据。

2、Java 解析、生成 Excel 比较有名的框架有 Apache poi、jxl，但他们都存在一个严重的问题就是非常的耗内存，poi 有一套 SAX 模式的 API 可以一定程度的解决一些内存溢出的问题，但仍有一些缺陷，比如版本兼容、代码臃肿等。

3、easyexcel 是 Alibaba 的 开源的一款快速、简单、可避免 OOM 的 java 处理 Excel 工具。easyexcel 重写了 poi 对 07 版 Excel 的解析，对原本一个 3M 的 excel 用 POI sax 需要 100M 左右的内存降低到几 M，并且再大的 excel 也不会出现内存溢出。

4、github 开源地址：https://github.com/alibaba/easyexcel，源码中提供了丰富的示例，推荐参考。

Excel2003(xls) 最多 65536行，256 列，超过就会报错。

Excel2007(xlsx) 最多1048576 行，16384列（采取的是xml存储）超过就会报错，不过已经完全够用了。

Easyexcel 依赖

1、本文环境：Spring boot 2.1.4 + Java JDK 1.8 + easyexcel 2.2.6，新建一个 Spring boot web 应用，然后 pom.xml 文件导入 easyexcel 依赖如下。

        <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.2.6</version>
        </dependency>

2、easyexcel 内部依赖项如下（easyexcel 是对 poi 的改写，同时使用了 ehcache 做缓存，提升效率）：

Easyexcel 常用 API

1、EasyExcel 类是个空类，也是整个框架的核心类，方法全部继承于 EasyExcelFactory，目的是编码起来名称更加简短直观，与整个框架的名称一致，常用方法如下：

2、ExcelWriterBuilder 是 excel 写构建器，用于设置写入操作：

3、ExcelReaderBuilder 是 excel 读构建器，用于设置读取操作:

4、常用注解：

5、AnalysisEventListener - excel 读取事件监听器：

Easyexcel 读 Excel

实际生产中使用上面的上传、下载多一些，本节是对读 excel 文件的更深入的介绍与汇总。

1、本节演示的源码地址：src/main/java/com/wmx/excel/test/ExcelReadTest.java · 汪少棠/h2Smil - Gitee.com

2、本节演示的 excel 文件：https://gitee.com/wangmx1993/h2-smil/tree/master/src/main/resources/excelTemplates

3、本文的 demo 是在 easyExcel 官方 demo 的基础上修改而来，本节源码中加入了更详细的注释，更多内容建议参考官网。

Easyexcel 写 Excel

实际生产中使用上面的上传、下载多一些，本节是对写 excel 文件的更深入的介绍与汇总。

1、本节演示的源码地址：src/main/java/com/wmx/excel/test/ExcelWriteTest.java · 汪少棠/h2Smil - Gitee.com

2、本节演示的 excel 文件：https://gitee.com/wangmx1993/h2-smil/tree/master/src/main/resources/excelTemplates

3、本文的 demo 是在 easyExcel 官方 demo 的基础上修改而来，本节源码中加入了更详细的注释，更多内容建议参考官网。

Easyexcel  上传、下载

实际生产中使用上传、下载多一些，对于读/写操作更多的介绍可以参考下面的 "读 Excel "、"写 Excel "章节。

1、本节演示的源码地址：https://gitee.com/wangmx1993/h2-smil/tree/master/src/main/java/com/wmx/excel/web

2、本节演示的 excel 文件：https://gitee.com/wangmx1993/h2-smil/tree/master/src/main/resources/excelTemplates

3、本文的 demo 是在 easyExcel 官方 demo 的基础上修改而来，本节源码中加入了更详细的注释，更多内容建议参考官网。

解决下载文件名称乱码

1、某些系统或者浏览器在下载文件的时候，可能出现文件名称乱码的现象，如下所示。

 2、解决方案的核心代码如下，就是修改返回的头信息。

	public static void returnErrorExlForColumn(Map<String, String> progressData, List<Map<String, Object>> errorData,
			List<UiRunColumn> uvColumnList, UiRunView uvView, HttpServletRequest request, HttpServletResponse response) throws IOException {
		OutputStream os = null;
		// 工作薄
		Workbook wb = null;
		try {
			wb = FWExcelCreateUtil.expExcelDataByPt(errorData, uvView, uvColumnList);
			if (wb != null) {
				//动态决定导出文件的后缀名
				String suffix = ".xlsx";
				if(wb instanceof HSSFWorkbook) {
					suffix = ".xls";
				}
				//判断客户端是否为 IE浏览器
				boolean isMSIE = isMSBrowser(request);
				//文件名称
				String fileName = uvView.getName() + "(错误信息)";
				response.setContentType("application/vnd.ms-excel");
				if (isMSIE) {
					//解决IE浏览器文件名称乱码
					fileName = new String(fileName.getBytes("gb2312"), "iso8859-1");
					response.setHeader("Content-Disposition", "inline; filename=" + fileName + suffix);
				} else {
					//万能文件名称乱码问题解决
					fileName = new String(fileName.getBytes("UTF-8"), "ISO-8859-1");
					response.setHeader("Content-disposition", "attachment;filename=" + fileName + suffix);
				}
				os = response.getOutputStream();
				wb.write(os);
			}
		} catch (Exception ex) {
			log.error(ExceptionUtils.getStackTrace(ex));
		} finally {
			os.flush();
			os.close();
			if (errorData.size() > 999){
				//清除缓存数据
				((SXSSFWorkbook)wb).dispose();
			}
		}
	}
 
	/**
	 * 判断客户端是否为 IE浏览器
	 * @param request ：客户端请求
	 * @return
	 */
	public static boolean isMSBrowser(HttpServletRequest request) {
		String userAgent = request.getHeader("User-Agent");
		String[] IEBrowserSignals = {"MSIE", "Trident", "Edge"};
		for (String signal : IEBrowserSignals) {
			if (StringUtils.contains(userAgent, signal)) {
				return true;
			}
		}
		return false;
	}