最近在学习撸一个微服务项目，过程中遇到读写excel的操作，可以通过使用 EasyExcel 来实现。
一、EasyExcel 简介
EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目（阿里巴巴）。在尽可能节约内存的情况下支持读写百M的Excel。
文档地址：https://alibaba-easyexcel.github.io/index.html
github地址：https://github.com/alibaba/easyexcel
二、快速使用
1.引入依赖
使用之前引入依赖：
<dependencies> <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel --> <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.1</version> </dependency> </dependencies>
2. 创建实体类
这个实体类内容要与excel文件里的内容绑定，可以在类的属性上添加注解@ExcelProperty，设置excel表头内容。
package com.pingguo.easyexcel; import com.alibaba.excel.annotation.ExcelProperty; import lombok.Data; @Data public class UserData { @ExcelProperty("用户id") private int uid; @ExcelProperty("用户名称") private String username; }
3. 写操作
就是调用EasyExcel的write方法：
public class TestWrite { public static void main(String[] args) { // 要写到excel数据的list集合 List<UserData> list = new ArrayList<>(); for (int i=0; i<10; i++) { UserData data = new UserData(); data.setUid(i); data.setUsername("tester"+i); list.add(data); } // 设置excel文件路径和文件名称 String fileName = "C:\\testwriteexcel\\01.xlsx"; // 调用方法实现写操作 EasyExcel.write(fileName, UserData.class).sheet("用户信息") .doWrite(list); } }
运行测试下：
打开路径下的文件，查看写入的内容。
4. 读操作
还是以上面的文件内容和实体类为例，对于读操作，需要改动一下注解，里面加上字段在excel列的索引。
@Data public class UserData { @ExcelProperty(value = "用户id", index = 0) private int uid; @ExcelProperty(value = "用户名称", index = 1) private String username; }
监听器
读操作需要写一个监听器，作用就是一行一行的来读取 excel 的内容。
public class ExcelListener extends AnalysisEventListener<UserData> { // 一行一行的读取内容，从第二行开始 @Override public void invoke(UserData userData, AnalysisContext analysisContext) { System.out.println(userData); } // 读取之后会执行的方法 @Override public void doAfterAllAnalysed(AnalysisContext analysisContext) { System.out.println("读取后执行的操作"); } // 读取第一行表头信息 @Override public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) { System.out.println("表头信息："+headMap); } }
这里实现了3个方法是比较常用的：
- invoke: 一行一行的读取内容，从第二行开始
- invokeHeadMap: 读取第一行表头信息
- doAfterAllAnalysed: 读取之后会执行的方法
新建个类测试一下读取：
package com.pingguo.easyexcel; import com.alibaba.excel.EasyExcel; public class TestRead { public static void main(String[] args) { // 读取文件的路径 String fileName = "C:\\testwriteexcel\\01.xlsx"; // 调用方法进行读取 EasyExcel.read(fileName, UserData.class, new ExcelListener()).sheet().doRead(); } }
EasyExcel.read方法里有 3 个参数，分别是：文件、读取内容的类型、监听器。
执行一下 main 方法，应该可以看到监听器里三个方法的不同输出：
学会了读写操作，接下来就可以整合项目，实现导入和导出功能了，下节更新。
