Java使用EasyExcel操作读写excel

开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第28天，点击查看活动详情

easyExcel操作读写excel

easyExcel写

特点:阿里巴巴开源的工具,代码简化,占用内存少,优化OOM(内存溢出异常)

1 pom引入依赖

由于pom底层也是使用的poi进行处理,为了避免冲突,我们把pom引入的pom注释掉

 <!--easyExcel依赖-->

<dependency>

    <groupId>com.alibaba</groupId>

    <artifactId>easyexcel</artifactId>

    <version>2.2.0-beta2</version>

</dependency>





 <!--导入依赖jar包-->

 <!--xls(03)-->

 <!--<dependency>-->

 <!--<groupId>org.apache.poi</groupId>-->

 <!--<artifactId>poi</artifactId>-->

 <!--<version>3.9</version>-->

 <!--</dependency>-->



 <!-- xlsx(07) -->

 <!--<dependency>-->

 <!--<groupId>org.apache.poi</groupId>-->

 <!--<artifactId>poi-ooxml</artifactId>-->

 <!--<version>3.9</version>-->

 <!--</dependency>-->

2 准备一个实体类 因为easyexcel根据实体类自动生成的表 效率非常的高

package com.wyh.entity;



import com.alibaba.excel.annotation.ExcelIgnore;

import com.alibaba.excel.annotation.ExcelProperty;

import lombok.Data;



import java.util.Date;



 /**

 *  @program:  JavaExecl

 *  @description:  easyExcel实体类 可以用它生成excel

 *  @author:  魏一鹤

 *  @createDate:  2021-12-18 23:03

 **/

@Data

public class DemoData {

    @ExcelProperty( "字符串标题" )

    private String string;

    @ExcelProperty( "日期标题" )

    private Date date;

    @ExcelProperty( "数字标题" )

    private Double doubleData;

    /**

 * 忽略这个字段

 */

 @ExcelIgnore

    private String ignore;

}

它对应生成的就是这样

3 写一个基本的写入操作

  

 //根据list写入excel

@Test

public void simpleWrite() {

    // 写法1 JDK8+

 // since: 3.0.0-beta1

 //生成的文件名和文件所在位置

 String fileName =path+ "easyExcel.xlsx" ;

    //开始写入 这里说下几个参数

 //1 fileName 是一个io流 自动生成excel

 //2 DemoData.class根据哪个类的规则去生成excel

 //3 sheetName 生成的表的名字

 //4 进行写出,写入到规则就是我们上面定义的方法循环

 EasyExcel.write(fileName,DemoData.class).sheet( "模板" ).doWrite(data());

}

完整的代码

package com.wyh.Test;



import com.alibaba.excel.EasyExcel;

import com.alibaba.excel.ExcelWriter;

import com.alibaba.excel.write.metadata.WriteSheet;

import com.wyh.entity.DemoData;

import org.apache.commons.collections4.ListUtils;

import org.junit.Test;



import java.util.ArrayList;

import java.util.Date;

import java.util.List;



 /**

 *  @program:  JavaExecl

 *  @description:  easyExcel写操作

 *  @author:  魏一鹤

 *  @createDate:  2021-12-18 23:08

 **/



public class EasyExcelWrite {

    //全局路径,供我们操作使用方便

  static String path= "D:\Tools\JavaWorkSpace\JavaExecl\" ;

    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.setDoubleData(0.56);

            list.add(data);

        }

        return list;

    }

    //根据list写入excel

 @Test

    public void simpleWrite() {

        // 写法1 JDK8+

 // since: 3.0.0-beta1

 //生成的文件名和文件所在位置

 String fileName =path+ "easyExcel.xlsx" ;

        //开始写入 这里说下几个参数

 //1 fileName 是一个io流 自动生成excel

 //2 DemoData.class根据哪个类的规则去生成excel

 //3 sheetName 生成的表的名字

 //4 进行写出,写入到规则就是我们上面定义的方法循环

 EasyExcel.write(fileName,DemoData.class).sheet( "模板" ).doWrite(data());

    }

}

运行完毕之后发现已经生成了,而且和我们想要的数据格式是一样的

easyExcel读

1 需要一个实体,我们已经有了,可以直接用上面的DemoData

package com.wyh.entity;



import com.alibaba.excel.annotation.ExcelIgnore;

import com.alibaba.excel.annotation.ExcelProperty;

import lombok.Data;



import java.util.Date;



 /**

 *  @program:  JavaExecl

 *  @description:  easyExcel实体类 可以用它生成excel

 *  @author:  魏一鹤

 *  @createDate:  2021-12-18 23:03

 **/

@Data

public class DemoData {

    @ExcelProperty( "字符串标题" )

    private String string;

    @ExcelProperty( "日期标题" )

    private Date date;

    @ExcelProperty( "数字标题" )

    private Double doubleData;

    /**

 * 忽略这个字段

 */

 @ExcelIgnore

    private String ignore;

}

2 需要一个监听器

package com.wyh.Test;



import com.alibaba.excel.context.AnalysisContext;

import com.alibaba.excel.event.AnalysisEventListener;

import com.alibaba.excel.metadata.CellData;

import com.alibaba.excel.metadata.CellExtra;

import com.alibaba.excel.read.listener.ReadListener;

import com.alibaba.fastjson.JSON;

import com.wyh.entity.DemoData;

import lombok.extern.slf4j.Slf4j;

import org.apache.commons.collections4.ListUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;



import java.util.ArrayList;

import java.util.List;

import java.util.Map;



 /**

 *  @program:  JavaExecl

 *  @description:  easyExcel监听器

 *  @author:  魏一鹤

 *  @createDate:  2021-12-18 23:30

 **/

 // 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去

public class DemoDataListener extends AnalysisEventListener<DemoData> {



    private static final Logger LOGGER = LoggerFactory.getLogger(DemoDataListener.class);

    /**

 * 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收

 */

  private static final int BATCH_COUNT = 5;

    List<DemoData> list = new ArrayList<DemoData>();

    /**

 * 假设这个是一个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(DemoData data, AnalysisContext context) {

        System.out.println(JSON.toJSONString(data));

        list.add(data);

        System.out.println(list);

        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM

  if (list.size() >= BATCH_COUNT) {

            saveData();

            // 存储完成清理 list

  list.clear();

        }

    }

    /**

 * 所有数据解析完成了 都会来调用

 *

 *  @param context

 */

 @Override

    public void doAfterAllAnalysed(AnalysisContext context) {

        // 这里也要保存数据，确保最后遗留的数据也存储到数据库

 saveData();

        LOGGER.info( "所有数据解析完成！" );

    }

    /**

 * 加上存储数据库

 */

  private void saveData() {

        demoDAO.save(list);

    }

}

3 然后写一个基本的读操作

package com.wyh.Test;



import com.alibaba.excel.EasyExcel;

import com.alibaba.excel.ExcelReader;

import com.alibaba.excel.context.AnalysisContext;

import com.alibaba.excel.read.listener.ReadListener;

import com.alibaba.excel.read.metadata.ReadSheet;

import com.alibaba.fastjson.JSON;

import com.wyh.entity.DemoData;

import org.apache.commons.collections4.ListUtils;

import org.junit.Test;



import java.io.File;

import java.util.List;



 /**

 *  @program:  JavaExecl

 *  @description:  excel读数据

 *  @author:  魏一鹤

 *  @createDate:  2021-12-18 23:38

 **/



public class EasyExcelRead {



    //全局路径,供我们操作使用方便

  static String path= "D:\Tools\JavaWorkSpace\JavaExecl\" ;

    @Test

    public void simpleRead() {

        //文件路径

 String fileName = path + "easyExcel.xlsx" ;

        //重点注意监听器读取的逻辑

 //fileName 文件

 //DemoData 类规则

 //DemoDataListener 监听器

 //sheet().doRead() 表的读取

 EasyExcel.read(fileName,DemoData.class,new DemoDataListener()).sheet().doRead();





    }



}

启动发现全部数据被正常读取到

4 总结下easyExcel的步骤

1 写入 根据固定的类格式进行写入

2 读取 根据监听器设置规则进行读取