Alibaba工具型技术系列，实战技术针对于项目中常用的Excel操作指南

• Ø ExcelIgnoreUnannotated 默认不加 ExcelProperty 的注解的都会参与读写&＃xff0c;加了不会参与

通用参数

• Ø ReadWorkbook,ReadSheet 都会有的参数&＃xff0c;如果为空&＃xff0c;默认使用上级。

• Ø converter 转换器&＃xff0c;默认加载了很多转换器。也可以自定义。

• Ø readListener 监听器&＃xff0c;在读取数据的过程中会不断的调用监听器。

• Ø headRowNumber 需要读的表格有几行头数据。默认有一行头&＃xff0c;也就是认为第二行开始起为数据。

• Ø head 与 clazz 二选一。读取文件头对应的列表&＃xff0c;会根据列表匹配数据&＃xff0c;建议使用 class。

• Ø clazz 与 head 二选一。读取文件的头对应的 class&＃xff0c;也可以使用注解。如果两个都不指定&＃xff0c;则会读取全部数据。

• Ø autoTrim 字符串、表头等数据自动 trim

• Ø password 读的时候是否需要使用密码

ReadWorkbook&＃xff08;理解成 excel 对象&＃xff09;参数

• Ø excelType 当前 excel 的类型 默认会自动判断

• Ø inputStream 与 file 二选一。读取文件的流&＃xff0c;如果接收到的是流就只用&＃xff0c;不用流建议使用 file 参数。因为使用了 inputStream easyexcel 会帮忙创建临时文件&＃xff0c;最终还是 file

• Ø file 与 inputStream 二选一。读取文件的文件。

• Ø autoCloseStream 自动关闭流。

• Ø readCache 默认小于 5M 用 内存&＃xff0c;超过 5M 会使用 EhCache,这里不建议使用这个参数。

ReadSheet&＃xff08;就是 excel 的一个 Sheet&＃xff09;参数

• Ø sheetNo 需要读取 Sheet 的编码&＃xff0c;建议使用这个来指定读取哪个 Sheet

• Ø sheetName 根据名字去匹配 Sheet,excel 2003 不支持根据名字去匹配

注解

• Ø ExcelProperty index 指定写到第几列&＃xff0c;默认根据成员变量排序。value 指定写入的名称&＃xff0c;默认成员变量的名字&＃xff0c;多个 value 可以参照快速开始中的复杂头

• Ø ExcelIgnore 默认所有字段都会写入 excel&＃xff0c;这个注解会忽略这个字段

• Ø DateTimeFormat 日期转换&＃xff0c;将 Date 写到 excel 会调用这个注解。里面的 value 参照 java.text.SimpleDateFormat

• Ø NumberFormat 数字转换&＃xff0c;用 Number 写 excel 会调用这个注解。里面的 value 参照 java.text.DecimalFormat

• Ø ExcelIgnoreUnannotated 默认不加 ExcelProperty 的注解的都会参与读写&＃xff0c;加了不会参与

参数

通用参数

• Ø WriteWorkbook,WriteSheet ,WriteTable 都会有的参数&＃xff0c;如果为空&＃xff0c;默认使用上级。

• Ø converter 转换器&＃xff0c;默认加载了很多转换器。也可以自定义。

• Ø writeHandler 写的处理器。可以实现 WorkbookWriteHandler,SheetWriteHandler,RowWriteHandler,CellWriteHandler&＃xff0c;在写入 excel 的不同阶段会调用

• Ø relativeHeadRowIndex 距离多少行后开始。也就是开头空几行

• Ø needHead 是否导出头

• Ø head 与 clazz 二选一。写入文件的头列表&＃xff0c;建议使用 class。

• Ø clazz 与 head 二选一。写入文件的头对应的 class&＃xff0c;也可以使用注解。

• Ø autoTrim 字符串、表头等数据自动 trim

WriteWorkbook&＃xff08;理解成 excel 对象&＃xff09;参数

• Ø excelType 当前 excel 的类型 默认 xlsx

• Ø outputStream 与 file 二选一。写入文件的流

• Ø file 与 outputStream 二选一。写入的文件

• Ø templateInputStream 模板的文件流

• Ø templateFile 模板文件

• Ø autoCloseStream 自动关闭流。

• Ø password 写的时候是否需要使用密码

• Ø useDefaultStyle 写的时候是否是使用默认头

WriteSheet&＃xff08;就是 excel 的一个 Sheet&＃xff09;参数

• Ø sheetNo 需要写入的编码。默认 0

• Ø sheetName 需要些的 Sheet 名称&＃xff0c;默认同 sheetNo

WriteTable&＃xff08;就把 excel 的一个 Sheet,一块区域看一个 table&＃xff09;参数

• Ø tableNo 需要写入的编码。默认 0

EasyExcel 用法指南

简单的读取 excel 文件

public void read() { String fileName &＃61; "demo.xlsx"; // 这里 需要指定读用哪个class去读&＃xff0c;然后读取第一个sheet 文件流会自动关闭 // 参数一&＃xff1a;读取的excel文件路径 // 参数二&＃xff1a;读取sheet的一行&＃xff0c;将参数封装在DemoData实体类中 // 参数三&＃xff1a;读取每一行的时候会执行DemoDataListener监听器 EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();&＃96;&＃96;}

简单的写入 excel 文件

&＃64;Test&＃96;&＃96;public void simpleWrite() { String fileName &＃61; "demo.xlsx"; // 这里 需要指定写用哪个class去读&＃xff0c;然后写到第一个sheet&＃xff0c;名字为模板 然后文件流会自动关闭 // 如果这里想使用03 则 传入excelType参数即可 // 参数一&＃xff1a;写入excel文件路径 // 参数二&＃xff1a;写入的数据类型是DemoData // data()方法是写入的数据&＃xff0c;结果是List集合 EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());&＃96;&＃96;}

Web 上传与下载

/** excel文件的下载&＃96;&＃96;*/&＃96;&＃96;&＃64;GetMapping("download")&＃96;&＃96;public void download(HttpServletResponse response) throws IOException { response.setContentType("application/vnd.ms-excel"); response.setCharacterEncoding("utf-8"); response.setHeader("Content-disposition", "attachment;filename&＃61;demo.xlsx"); EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());&＃96;&＃96;}

/** excel文件的上传&＃96;&＃96;*/&＃96;&＃96;&＃64;PostMapping("upload")&＃96;&＃96;&＃64;ResponseBody&＃96;&＃96;public String upload(MultipartFile file) throws IOException { EasyExcel.read(file.getInputStream(), DemoData.class, new DemoDataListener()).sheet().doRead(); return "success";&＃96;&＃96;}

详解读取 Excel

对象模型

// 如果没有特殊说明&＃xff0c;下面的案例将默认使用这个实体类&＃96;&＃96;public class DemoData { /** * 强制读取第三个 这里不建议 index 和 name 同时用&＃xff0c;要么一个对象只用index&＃xff0c;要么一个对象只用name去匹配 */ &＃64;ExcelProperty(index &＃61; 2) //我想接收百分比的数字 &＃64;NumberFormat("#.##%") &＃64;ExcelProperty(value&＃61;"浮点数标题", converter &＃61; CustomStringConverter.class) private Double doubleData; /** * 用名字去匹配&＃xff0c;这里需要注意&＃xff0c;如果名字重复&＃xff0c;会导致只有一个字段读取到数据 */ &＃64;ExcelProperty(value&＃61;"字符串标题", converter &＃61; CustomStringConverter.class) // converter属性定义自己的字符串转换器 private String string; &＃64;DateTimeFormat("yyyy年MM月dd日 HH时mm分ss秒") &＃64;ExcelProperty("日期标题") //这里用string 去接日期才能格式化 private Date date;&＃96;&＃96;}

监听器

// 如果没有特殊说明&＃xff0c;下面的案例将默认使用这个监听器&＃96;&＃96;public class DemoDataListener extends AnalysisEventListener {

List list &＃61; new ArrayList(); /** * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来 */ public DemoDataListener() {} /** * 这个每一条数据解析都会来调用 * * &＃64;param data * &＃64;param context */ &＃64;Override public void invoke(DemoData data, AnalysisContext context) { System.out.println("解析到一条数据:{}", JSON.toJSONString(data)); list.add(data); }

/** * 所有数据解析完成了 都会来调用 * * &＃64;param context */ &＃64;Override public void doAfterAllAnalysed(AnalysisContext context) { System.out.println(JSON.toJSONString(list)); }&＃96;&＃96;}

代码

&＃64;Test&＃96;&＃96;public void simpleRead() { // 写法1&＃xff1a; String fileName &＃61; "demo.xlsx"; // 这里 需要指定读用哪个class去读&＃xff0c;然后读取第一个sheet 文件流会自动关闭 EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead(); // 写法2&＃xff1a; fileName &＃61; "demo.xlsx"; ExcelReader excelReader &＃61; EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).build(); ReadSheet readSheet &＃61; EasyExcel.readSheet(0).build(); excelReader.read(readSheet); // 这里千万别忘记关闭&＃xff0c;读的时候会创建临时文件&＃xff0c;到时磁盘会崩的 excelReader.finish();&＃96;&＃96;}

读取多个 sheet

&＃64;Test&＃96;&＃96;public void repeatedRead() { String fileName &＃61; "demo.xlsx"; // 读取全部sheet // 这里需要注意 DemoDataListener的doAfterAllAnalysed 会在每个sheet读取完毕后调用一次。然后所有sheet都会往同一个DemoDataListener里面写 EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).doReadAll(); // 读取部分sheet fileName &＃61; "demo.xlsx"; ExcelReader excelReader &＃61; EasyExcel.read(fileName).build(); // 这里为了简单 所以注册了 同样的head 和Listener 自己使用功能必须不同的Listener // readSheet参数设置读取sheet的序号 ReadSheet readSheet1 &＃61; EasyExcel.readSheet(0).head(DemoData.class).registerReadListener(new DemoDataListener()).build(); ReadSheet readSheet2 &＃61; EasyExcel.readSheet(1).head(DemoData.class).registerReadListener(new DemoDataListener()).build(); // 这里注意 一定要把sheet1 sheet2 一起传进去&＃xff0c;不然有个问题就是03版的excel 会读取多次&＃xff0c;浪费性能 excelReader.read(readSheet1, readSheet2); // 这里千万别忘记关闭&＃xff0c;读的时候会创建临时文件&＃xff0c;到时磁盘会崩的 excelReader.finish();&＃96;&＃96;}

自定义格式转换

public class CustomStringStringConverter implements Converter { &＃64;Override public Class supportJavaTypeKey() { return String.class; }

&＃64;Override public CellDataTypeEnum supportExcelTypeKey() { return CellDataTypeEnum.STRING; }

/** * 这里读的时候会调用 * * &＃64;param cellData * NotNull * &＃64;param contentProperty * Nullable * &＃64;param globalConfiguration * NotNull * &＃64;return */ &＃64;Override public String convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) { return "自定义&＃xff1a;" &＃43; cellData.getStringValue(); }

/** * 这里是写的时候会调用 不用管 * * &＃64;param value * NotNull * &＃64;param contentProperty * Nullable * &＃64;param globalConfiguration * NotNull * &＃64;return */ &＃64;Override public CellData convertToExcelData(String value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) { return new CellData(value); }&＃96;&＃96;}

多行头

&＃64;Test&＃96;&＃96;public void complexHeaderRead() { String fileName &＃61; "demo.xlsx"; // 这里 需要指定读用哪个class去读&＃xff0c;然后读取第一个sheet&＃96;&＃96; EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet() // 这里可以设置1&＃xff0c;因为头就是一行。如果多行头&＃xff0c;可以设置其他值。不传入默认1行 .headRowNumber(1).doRead();&＃96;&＃96;}

读取表头数据

覆盖监听器 invokeHeadMap 方法

/** * 这里会一行行的返回头 * 监听器只需要重写这个方法就可以读取到头信息 * &＃64;param headMap * &＃64;param context */&＃96;&＃96;&＃64;Override&＃96;&＃96;public void invokeHeadMap(Map headMap, AnalysisContext context) { LOGGER.info("解析到一条头数据:{}", JSON.toJSONString(headMap));&＃96;&＃96;}

异常处理

覆盖监听器 onException 方法

/**&＃96;&＃96;* 监听器实现这个方法就可以在读取数据的时候获取到异常信息&＃96;&＃96;*/&＃96;&＃96;&＃64;Override&＃96;&＃96;public void onException(Exception exception, AnalysisContext context) { LOGGER.error("解析失败&＃xff0c;但是继续解析下一行:{}", exception.getMessage()); // 如果是某一个单元格的转换异常 能获取到具体行号 // 如果要获取头的信息 配合invokeHeadMap使用 if (exception instanceof ExcelDataConvertException) { ExcelDataConvertException excelDataConvertException &＃61; (ExcelDataConvertException)exception; LOGGER.error("第{}行&＃xff0c;第{}列解析异常", excelDataConvertException.getRowIndex(), excelDataConvertException.getColumnIndex()); }&＃96;&＃96;}

导出指定的列

&＃64;Test&＃96;&＃96;public void excludeOrIncludeWrite() { String fileName &＃61; "excludeOrIncludeWrite" &＃43; System.currentTimeMillis() &＃43; ".xlsx"; // 忽略 date 不导出 Set excludeColumnFiledNames &＃61; new HashSet(); excludeColumnFiledNames.add("date"); // 这里 需要指定写用哪个class去写&＃xff0c;然后写到第一个sheet&＃xff0c;名字为模板 然后文件流会自动关闭 EasyExcel.write(fileName, DemoData.class).excludeColumnFiledNames(excludeColumnFiledNames).sheet("忽略date") .doWrite(data()); fileName &＃61; "excludeOrIncludeWrite" &＃43; System.currentTimeMillis() &＃43; ".xlsx"; // 根据用户传入字段 假设我们只要导出 date Set includeColumnFiledNames &＃61; new HashSet(); includeColumnFiledNames.add("date"); // 这里 需要指定写用哪个class去写&＃xff0c;然后写到第一个sheet&＃xff0c;名字为模板 然后文件流会自动关闭 EasyExcel.write(fileName, DemoData.class).includeColumnFiledNames(includeColumnFiledNames).sheet("导出date") .doWrite(data());&＃96;&＃96;}

调整指定列顺序

public class IndexData { /** * 导出的excel第二列和第四列将空置 */ &＃64;ExcelProperty(value &＃61; "字符串标题", index &＃61; 0) private String string; &＃96;&＃64;ExcelProperty(value &＃61; “日期标题”, index

&＃61; 2) private Date date; &＃64;ExcelProperty(value &＃61; “浮点数标题”, index &＃61; 4) private Double doubleData;&＃96;&＃96;}&＃96;

复杂头写入

public class ComplexHeadData { /** * 主标题 将整合为一个单元格效果如下&＃xff1a; * ————————————————————————— * | 主标题 | * ————————————————————————— * |字符串标题|日期标题|数字标题| * ————————————————————————— */ &＃64;ExcelProperty({"主标题", "字符串标题"}) private String string; &＃64;ExcelProperty({"主标题", "日期标题"}) private Date date; &＃64;ExcelProperty({"主标题", "数字标题"}) private Double doubleData;&＃96;&＃96;}

前面属于主标题&＃xff0c;后面属于副标题

图片导出

&＃64;Data&＃96;&＃96;&＃64;ContentRowHeight(200)&＃96;&＃96;&＃64;ColumnWidth(200 / 8)&＃96;&＃96;public class ImageData { // 图片导出方式有5种 private File file; private InputStream inputStream; /** * 如果string类型 必须指定转换器&＃xff0c;string默认转换成string&＃xff0c;该转换器是官方支持的 */ &＃64;ExcelProperty(converter &＃61; StringImageConverter.class) private String string; private byte[] byteArray; /** * 根据url导出 版本2.1.1才支持该种模式 */ private URL url;&＃96;&＃96;}

&＃64;Test&＃96;&＃96;public void imageWrite() throws Exception { String fileName &＃61; "imageWrite" &＃43; System.currentTimeMillis() &＃43; ".xlsx"; // 如果使用流 记得关闭 InputStream inputStream &＃61; null; try { List list &＃61; new ArrayList(); ImageData imageData &＃61; new ImageData(); list.add(imageData); String imagePath &＃61; "converter" &＃43; File.separator &＃43; "img.jpg"; // 放入五种类型的图片 根据实际使用只要选一种即可 imageData.setByteArray(FileUtils.readFileToByteArray(new File(imagePath))); imageData.setFile(new File(imagePath)); imageData.setString(imagePath); inputStream &＃61; FileUtils.openInputStream(new File(imagePath)); imageData.setInputStream(inputStream); imageData.setUrl(new URL( "https://raw.githubusercontent.com/alibaba/easyexcel/master/src/test/resources/converter/img.jpg")); EasyExcel.write(fileName, ImageData.class).sheet().doWrite(list); } finally { if (inputStream !&＃61; null) { inputStream.close(); } }&＃96;&＃96;}

列宽、行高

&＃64;Data&＃64;ContentRowHeight(10)&＃64;HeadRowHeight(20)&＃64;ColumnWidth(25)public class WidthAndHeightData { &＃64;ExcelProperty(“字符串标题”) private String string; &＃64;ExcelProperty(“日期标题”) private Date date; /** * 宽度为50,覆盖上面的宽度25 */ &＃64;ColumnWidth(50) &＃64;ExcelProperty(“数字标题”) private Double doubleData;&＃96;&＃96;}

• &＃64;HeadRowHeight(value &＃61; 35) // 表头行高

• &＃64;ContentRowHeight(value &＃61; 25) // 内容行高

• &＃64;ColumnWidth(value &＃61; 50) // 列宽

此外还有&＃xff0c;自适应宽度&＃xff0c;但是这个不是特别精确

&＃64;Test&＃96;&＃96;void contextLoads() { EasyExcel.write("自适应.xlsx", Student.class) .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()) .sheet() .doWrite(getData());&＃96;&＃96;}

动态表头

&＃64;Test&＃96;&＃96;public void dynamicHeadWrite() { String fileName &＃61; "dynamicHeadWrite" &＃43; System.currentTimeMillis() &＃43; ".xlsx"; EasyExcel.write(fileName) // 这里放入动态头 .head(head()).sheet("模板") // 当然这里数据也可以用 List> 去传入 .doWrite(data());&＃96;&＃96;}&＃96;&＃96;// 动态表头的数据格式List>&＃96;&＃96;private List> head() { List> list &＃61; new ArrayList>(); List head0 &＃61; new ArrayList(); head0.add("字符串" &＃43; System.currentTimeMillis()); List head1 &＃61; new ArrayList(); head1.add("数字" &＃43; System.currentTimeMillis()); List head2 &＃61; new ArrayList(); head2.add("日期" &＃43; System.currentTimeMillis()); list.add(head0); list.add(head1); list.add(head2); return list;&＃96;&＃96;}

合并单元格

&＃64;Test public void mergeWrite() { String fileName &＃61; "mergeWrite" &＃43; System.currentTimeMillis() &＃43; ".xlsx"; LoopMergeStrategy loopMergeStrategy &＃61; new LoopMergeStrategy(2, 0); EasyExcel.write(fileName, DemoData.class).registerWriteHandler(loopMergeStrategy).sheet("合并单元格") .doWrite(data()); }

• 每隔 2 行会合并 把 eachColumn 设置成 3 也就是我们数据的长度&＃xff0c;所以就第一列会合并。当然其他合并策略也可以自己写

• 这里 需要指定写用哪个 class 去写&＃xff0c;然后写到第一个 sheet&＃xff0c;名字为模板 然后文件流会自动关闭

web 数据写出

&＃64;GetMapping("download")&＃96;&＃96;public void download(HttpServletResponse response) throws IOException { response.setContentType("application/vnd.ms-excel"); response.setCharacterEncoding("utf-8"); // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系 String fileName &＃61; URLEncoder.encode("数据写出", "UTF-8"); response.setHeader("Content-disposition", "attachment;filename&＃61;" &＃43; fileName &＃43; ".xlsx"); EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());&＃96;&＃96;}

模板格式导出

如果需要横向填充只需要模板设置好就可以。

简单的 Excel 模板

public class FillData { private String name; private double number; // getting setting&＃96;&＃96;}

实现模板填充

&＃64;Test&＃96;&＃96;public void simpleFill() { String templateFileName &＃61; "simple.xlsx";

// 方案1 根据对象填充 String fileName &＃61; System.currentTimeMillis() &＃43; ".xlsx"; // 这里 会填充到第一个sheet&＃xff0c; 然后文件流会自动关闭 FillData fillData &＃61; new FillData(); fillData.setName("知春秋"); fillData.setNumber(25); EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(fillData);

// 方案2 根据Map填充 fileName &＃61; System.currentTimeMillis() &＃43; ".xlsx"; // 这里 会填充到第一个sheet&＃xff0c; 然后文件流会自动关闭 Map map &＃61; new HashMap(); map.put("name", "知春秋"); map.put("number", 25); EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(map);&＃96;&＃96;}

• 模板注意 用{} 来表示你要用的变量 如果本来就有"{“,”}" 特殊字符 用"{“,”}"代替

复杂的填充

使用 List 集合的方法批量写入数据&＃xff0c;点表示该参数是集合

&＃64;Test&＃96;&＃96;public void complexFill() { String templateFileName &＃61; "complex.xlsx"; String fileName &＃61; System.currentTimeMillis() &＃43; ".xlsx"; ExcelWriter excelWriter &＃61; EasyExcel.write(fileName).withTemplate(templateFileName).build(); WriteSheet writeSheet &＃61; EasyExcel.writerSheet().build(); // 如果数据量大 list不是最后一行 参照下一个 FillConfig fillConfig &＃61; FillConfig.builder().forceNewRow(Boolean.TRUE).build(); excelWriter.fill(data(), fillConfig, writeSheet); excelWriter.fill(data(), fillConfig, writeSheet); // 其他参数可以使用Map封装 Map map &＃61; new HashMap(); excelWriter.fill(map, writeSheet); excelWriter.finish();&＃96;&＃96;}

.xlsx"; String fileName &＃61; System.currentTimeMillis() &＃43; “.xlsx”; ExcelWriter excelWriter &＃61; EasyExcel.write(fileName).withTemplate(templateFileName).build(); WriteSheet writeSheet &＃61; EasyExcel.writerSheet().build(); // 如果数据量大 list不是最后一行 参照下一个 FillConfig fillConfig &＃61; FillConfig.builder().forceNewRow(Boolean.TRUE).build(); excelWriter.fill(data(), fillConfig, writeSheet); excelWriter.fill(data(), fillConfig, writeSheet); // 其他参数可以使用Map封装 Map map &＃61; new HashMap(); excelWriter.fill(map, writeSheet); excelWriter.finish();&＃96;&＃96;}&＃96;