【EasyExcel】之读写实战

古城微笑少年丶 2022-11-25 13:16 171阅读 0赞

## 一、EasyExcel 简介 ##

--------------------

### 1、Excel导入导出的应用场景 ###

*  数据导入：减轻录入工作量
 *  数据导出：统计信息归档
 *  数据传输：异构系统之间数据传输

### 2、EasyExcel 特点 ###

*  Java领域解析、生成Excel比较有名的框架有Apache poi、jxl等。但他们都存在一个严重的问题就是非常的耗内存。如果你的系统并发量不大的话可能还行，但是一旦并发上来后一定会OOM或者JVM频繁的full gc。
 *  EasyExcel是阿里巴巴开源的一个excel处理框架，**以使用简单、节省内存著称**。EasyExcel能大大减少占用内存的主要原因是在解析Excel时没有将文件数据一次性全部加载到内存中，而是从磁盘上一行行读取数据，逐个解析。
 *  EasyExcel采用一行一行的解析模式，并将一行的解析结果以观察者的模式通知处理（AnalysisEventListener）。

## 二、EasyExcel 实战 ##

--------------------

### 实现EasyExcel对Excel写操作 ###

#### 1、创建 maven 项目，同时 pom 中引入依赖 ####

<dependencies>
        
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.1.1</version>
        </dependency>
    </dependencies>

#### 2、创建 Excel 对应的实体类 ####

**设置表头和添加的数据字段**

import com.alibaba.excel.annotation.ExcelProperty;
    
    //设置表头和添加的数据字段
    public class DemoData { 
        //设置excel第一列表头名称
        @ExcelProperty(value = "学生编号", index = 0)
        private int sno;
        
    	//设置excel第二列表头名称
        @ExcelProperty(value = "学生姓名", index = 1)
        private String sname;
    
        public int getSno() { 
            return sno;
        }
    
        public void setSno(int sno) { 
            this.sno = sno;
        }
    
        public String getSname() { 
            return sname;
        }
    
        public void setSname(String sname) { 
            this.sname = sname;
        }
    
        @Override
        public String toString() { 
            return "DemoData{" +
                    "sno=" + sno +
                    ", sname='" + sname + '\'' +
                    '}';
        }
    }

### 3、实现写操作 ###

public class EasyExcelDemo { 
        
        public static void main(String[] args) throws Exception { 
            // 指定要写入的excel文件名，如果不存在则创建
            String fileName = "D:\\demo.xlsx";
            
            // 调用write，传入文件名和Excel应对的实体类，通知指定sheet名称
            EasyExcel.write(fileName, DemoData.class).sheet("学生列表").doWrite(getData());
        }
    
        // 获取需要写入Excel的数据
        private static List<DemoData> getData() { 
            List<DemoData> list = new ArrayList<>();
            for (int i = 0; i < 10; i++) { 
                DemoData data = new DemoData();
                data.setSno(i);
                data.setSname("Andy" + i);
                list.add(data);
            }
            return list;
        }
    }

上面的写操作中，文件流会自动关闭，除此之外，还可以使用第二种方式，手动关闭流：

// 方法二：需要手动关闭流
    public static void main(String[] args) throws Exception { 
         // 指定要写入的excel文件名，如果不存在则创建
        String fileName = "D:\\demo.xlsx";
    
        // 分步骤构建
        ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build();
        WriteSheet writeSheet = EasyExcel.writerSheet("学生列表").build();
        excelWriter.write(getData(), writeSheet);
        
        /// 调用 finish() 手动关闭流
        excelWriter.finish();
    }

### 实现 EasyExcel 对 Excel 读操作 ###

--------------------

和写相比，对 Excel 读操作除了要创建对应的 Excel 实体类之外，还要创建读取操作的监听器，用于处理读取的操作过程。

#### 1、创建读取操作的监听器 ####

import com.alibaba.excel.context.AnalysisContext;
    import com.alibaba.excel.event.AnalysisEventListener;
    import com.alibaba.excel.exception.ExcelDataConvertException;
    import com.sun.scenario.effect.impl.sw.sse.SSEBlend_SRC_OUTPeer;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Map;
    
    //创建读取excel监听器
    public class ExcelListener extends AnalysisEventListener<ReadData> { 
    
        //创建list集合封装最终的数据
        List<DemoData> list = new ArrayList<>();
    
        //一行一行去读取excle内容
        @Override
        public void invoke(DemoData data, AnalysisContext analysisContext) { 
           System.out.println(data);
           list.add(data);
        }
    
        //读取excel表头信息
        @Override
        public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) { 
            System.out.println("表头信息：" + headMap);
        }
    
        //读取完成后执行
        @Override
        public void doAfterAllAnalysed(AnalysisContext analysisContext) { 
            System.out.println("----- 读取完成 -----");
        }
    }

#### 2、实现读操作 ####

public static void main(String[] args) throws Exception { 
        // 写法1：会自动关闭文件流
        String fileName = "D:\\demo.xlsx";
        EasyExcel.read(fileName, ReadData.class, new ExcelListener()).sheet().doRead();
    
        // 写法2：需要手动调用 finish() 关闭流
        InputStream in = new BufferedInputStream(new FileInputStream("D:\\demo.xlsx"));
        ExcelReader excelReader = EasyExcel.read(in, DemoData.class, new ExcelListener()).build();
        ReadSheet readSheet = EasyExcel.readSheet(0).build();
        excelReader.read(readSheet);
        excelReader.finish();
    }