0、前言
0.1 dependency
<dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>3.1.1</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>RELEASE</version> <scope>compile</scope> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>RELEASE</version> </dependency>
1、write
1.1 DemoData
package com.southwind.writeDemo; import com.alibaba.excel.annotation.ExcelIgnore; import com.alibaba.excel.annotation.ExcelProperty; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.Setter; import java.util.Date; @Getter @Setter @EqualsAndHashCode public class writeDemoData { @ExcelProperty("字符串标题") private String string; @ExcelProperty("日期标题") private Date date; @ExcelProperty("数字标题") private Double doubleData; /** * 忽略这个字段 */ @ExcelIgnore private String ignore; }
1.2 simpleWrite
package com.southwind.writeDemo; import com.alibaba.excel.EasyExcel; import com.alibaba.excel.util.ListUtils; import java.util.Date; import java.util.List; public class simpleWrite { public static void main(String[] args) { new simpleWrite().simpleWrite(); } private List<writeDemoData> data() { List<writeDemoData> list = ListUtils.newArrayList(); for (int i = 0; i < 10; i++) { writeDemoData data = new writeDemoData(); data.setString("字符串" + i); data.setDate(new Date()); data.setDoubleData(0.56); list.add(data); } return list; } /** * 最简单的写 * <p> * 1. 创建excel对应的实体对象 参照{@link writeDemoData} * <p> * 2. 直接写即可 */ public void simpleWrite() { // 注意 simpleWrite在数据量不大的情况下可以使用(5000以内,具体也要看实际情况),数据量大参照 重复多次写入 // 写法1 JDK8+ // since: 3.0.0-beta1 String fileName ="C:\\Users\\user\\Desktop\\easyExcel_writeDemo.xlsx"; // 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭 // 如果这里想使用03 则 传入excelType参数即可 EasyExcel.write(fileName, writeDemoData.class) .sheet("模板") .doWrite(data()); // // 写法2 // fileName = TestFileUtil.getPath() + "simpleWrite" + System.currentTimeMillis() + ".xlsx"; // // 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭 // // 如果这里想使用03 则 传入excelType参数即可 // EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data()); // // // 写法3 // fileName = TestFileUtil.getPath() + "simpleWrite" + System.currentTimeMillis() + ".xlsx"; // // 这里 需要指定写用哪个class去写 // try (ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build()) { // WriteSheet writeSheet = EasyExcel.writerSheet("模板").build(); // excelWriter.write(data(), writeSheet); // } } }
2、read
2.1 readDemodata
package com.southwind.readDemo; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.Setter; import java.util.Date; @Getter @Setter @EqualsAndHashCode public class readDemoData { private String string; private Date date; private Double doubleData; }
2.2 DenoDAO
package com.southwind.readDemo; import java.util.List; /** * 假设这个是你的DAO存储。当然还要这个类让spring管理,当然你不用需要存储,也不需要这个类。 **/ public class DemoDAO { public void save(List<readDemoData> list) { // 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入 } }
2.3 DemoDataListener
package com.southwind.readDemo; // 有个很重要的点 DemoDataListener 不能被spring管理,要每次读取excel都要new,然后里面用到spring可以构造方法传进去 import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.read.listener.ReadListener; import com.alibaba.excel.util.ListUtils; import com.alibaba.fastjson.JSON; import lombok.extern.slf4j.Slf4j; import java.util.List; @Slf4j public class DemoDataListener implements ReadListener<readDemoData> { /** * 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收 */ private static final int BATCH_COUNT = 100; /** * 缓存的数据 */ private List<readDemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT); /** * 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。 */ private DemoDAO demoDAO; public DemoDataListener() { // 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数 demoDAO = new DemoDAO(); } /** * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来 * * @param demoDAO */ public DemoDataListener(DemoDAO demoDAO) { this.demoDAO = demoDAO; } /** * 这个每一条数据解析都会来调用 * * @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()} * @param context */ @Override public void invoke(readDemoData data, AnalysisContext context) { System.out.println(JSON.toJSONString(data)); cachedDataList.add(data); // 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM if (cachedDataList.size() >= BATCH_COUNT) { saveData(); // 存储完成清理 list cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT); } } /** * 所有数据解析完成了 都会来调用 * * @param context */ @Override public void doAfterAllAnalysed(AnalysisContext context) { // 这里也要保存数据,确保最后遗留的数据也存储到数据库 saveData(); log.info("所有数据解析完成!"); } /** * 加上存储数据库 */ private void saveData() { log.info("{}条数据,开始存储数据库!", cachedDataList.size()); demoDAO.save(cachedDataList); log.info("存储数据库成功!"); } }
2.4 simpleRead
package com.southwind.readDemo; import com.alibaba.excel.EasyExcel; import com.alibaba.excel.read.listener.PageReadListener; import com.alibaba.fastjson.JSON; public class simpleRead { public static void main(String[] args) { new simpleRead().Read(); } public void Read() { // 写法1:JDK8+ ,不用额外写一个DemoDataListener // since: 3.0.0-beta1 String fileName ="C:\\Users\\user\\Desktop\\easyExcel_writeDemo.xlsx"; // 这里默认每次会读取100条数据 然后返回过来 直接调用使用数据就行 // 具体需要返回多少行可以在`PageReadListener`的构造函数设置 // 读取方法一 // EasyExcel.read(fileName, readDemoData.class, new PageReadListener<readDemoData>(dataList -> { // for (readDemoData demoData : dataList) { // System.out.println(JSON.toJSONString(demoData)); // } // })).sheet().doRead(); // 读取方法二:用自己定义的规则去读取 EasyExcel.read(fileName, readDemoData.class, new DemoDataListener()).sheet().doRead(); } }