EasyExcel初了解

官网: https://easyexcel.opensource.alibaba.com/

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-M9DR8uSj-1658993899816)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\1658917061315.png)]

什么是EasyExcel

EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。

EasyExcel的作用

简单来说就是既实现把excel的中的数据批量添加(写)到数据库中,也实现了把数据库中的数据导入(读)到excel中

EasyExcel的应用场景

我们通常可以看到很多应用程序有导出功能就是把查询到的数据导出成Excel文件,方便转发查看,同时有时候需要把Excel中的数据通过页面展示出来,就要添加到数据库,便于查询,在页面动态展示出来给用户.这就是EasyExcel这门技术的应用场景

EasyExcel的快速入门

写功能的实现

第一步: 创建一个maven项目导入依赖

<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>2.2.0-beta2</version>
</dependency>
<!--        环境依赖 给实体类使用--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.20</version></dependency>

第二步:创建一个实体类

注意: 实体类中的属性和excel中的表头的字段类型要保持一致,并且实体类中还要包含我们要添加到数据库中的一些需要设置的属性.

@Data    //lombok依赖的应用,省略一些需要重新或者生成的方法
public class DemoData {@ExcelProperty("字符串标题") //表头的名称private String string;@ExcelProperty("日期标题")  private Date date;@ExcelProperty("数字标题")private Double doubleDate;@ExcelIgnore  //不包含在excel中的字段,读出数据后封装额外字段private String igore;   // 之后保存在数据中
}

第三步: 创建一个测试类 , 在测试类中编写一个获得数据集合的方法,模拟从数据库中读出的数据

public class EasyDemo {//生成存放数据的方法 这个方法中定义好表中存放的数据
private List<DemoData> data() {//建立集合存放表中的字段List<DemoData> list = new ArrayList<DemoData>();for (int i = 0; i < 10; i++) {DemoData data = new DemoData();data.setString("字符串" + i);data.setDate(new Date());data.setDoubleDate(0.56);list.add(data);}return list;
}
}

第四步: 在测试类中,编写写数据的代码,其实就一行代码

String  path = "E:\\study\\projection\\easyExcel\\esayexcel_demo";@Testpublic void writeSimple() {String fileName = path + "EasyTest.xlsx";/*** write()方法需要的 第一个参数是指定文件写出的路径.* 第二个参数就是定义的实体类的class文件,也就是要生成的excel的格式* sheet() 方法可以加参数,也可以不加,不加的话是默认的名字0,加的话使用参数的名字* doWrite()方法 参数是往表中添加的数据,参数也可以是lambda表达式,返回值为要添加的数据*/EasyExcel.write(fileName,DemoData.class).sheet("模板").doWrite(data());}

至此,写功能就完成了.可以执行代码,进行测试.

读功能的实现

读的话涉及到监听器,这个监听器类是读功能的核心,其中invoke方法又是监听器的核心

为了防止一下看见一大堆的代码,我第一步只是实现了把excel中的数据打印在控制台.以实现逐步理解

public class DemoDataListener extends AnalysisEventListener<DemoData> {private List<DemoData> list = new ArrayList<DemoData>();//DemoData 使用的格式// AnalysisContext 解析器,解析上下文的@Overridepublic void invoke(DemoData data, AnalysisContext context) {System.out.println("输出：" + JSON.toJSONString(data));list.add(data);}@Overridepublic void doAfterAllAnalysed(AnalysisContext analysisContext) {// 这里也要保存数据，确保最后遗留的数据也存储到数据库}

然后在测试类中添加方法

@Test
public void read() {String fileName = path + "EasyTest.xlsx";// 加上继承了AnalysisEventListener类的监听器DemoDataListener excelListener = new DemoDataListener();EasyExcel.read(fileName,DemoData.class, excelListener).sheet().doRead();
}

这里已经是小小完成了把excel数据在控制台的打印了,后边就是更进一步的扩展了,有前边的小步骤,理解可能就不那么困难了

// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去public class DemoDataListener implements ReadListener<DemoData> {/*** 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收*/
private static final int BATCH_COUNT = 100;
/*** 缓存的数据*/
private List<DemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/*** 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。*/
private DemoDAO demoDAO;public DemoDataListener() {// 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数demoDAO = new DemoDAO();
}/*** 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来 就是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(DemoData data, AnalysisContext context) {//注意这里的data就是每次解析出来的一行数据,封装在我们创建的实体类中cachedDataList.add(data);// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOMif (cachedDataList.size() >= BATCH_COUNT) {//使用方法把数据读到数据库中saveData(); //这里方法一般都写在service层中.完成数据的添加// 存储完成清理 listcachedDataList = 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("存储数据库成功！");
}
}

更多的扩展可以去官网进一步了解: https://easyexcel.opensource.alibaba.com/

初学总结.纯粹学习用,如果有不对的希望,可以有人及时指正 .>>>Thanks♪(･ω･)ﾉ>>>>