springboot整合EasyExcel

拼搏现实的明天。 2023-01-11 03:36 123阅读 0赞

EasyExcel是阿里巴巴开源的一个excel处理框架，以使用简单、节省内存著称。EasyExcel能大大减少占用内存的主要原因是在解析Excel时没有将文件数据一次性全部加载到内存中，而是从磁盘上一行行读取数据，逐个解析。  
EasyExcel采用一行一行的解析模式，并将一行的解析结果以观察者的模式通知处理（AnalysisEventListener）。

**整合EasyExcel写操作**  
首先导入相关依赖

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

**创建实体类**

public class DemoData {
        //设置表头名称
        @ExcelProperty("学生编号")
        private int sno;
        
    	//设置表头名称
        @ExcelProperty("学生姓名")
        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 + '\'' +
                    '}';
        }
    }a

![在这里插入图片描述][2021012519422190.png]  
对应表如上图  
**创建方法循环设置要添加到Excel的数据**

//循环设置要添加的数据，最终封装到list集合中
    private static List<DemoData> data() { 
        List<DemoData> list = new ArrayList<DemoData>();
        for (int i = 0; i < 10; i++) { 
            DemoData data = new DemoData();
            data.setSno(i);
            data.setSname("张三"+i);
            list.add(data);
        }
        return list;
    }

此处是创造上面实体类类型的试例数据

**实现最终将数据读入excel表格**

public static void main(String[] args) throws Exception { 
        // 写法1
        String fileName = "F:\\11.xlsx";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write(fileName, DemoData.class).sheet("写入方法一").doWrite(data());
    }

**最终实现方法二**

public static void main(String[] args) throws Exception { 
        // 写法2，方法二需要手动关闭流
        String fileName = "F:\\112.xlsx";
        // 这里 需要指定写用哪个class去写
        ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build();
        WriteSheet writeSheet = EasyExcel.writerSheet("写入方法二").build();
        excelWriter.write(data(), writeSheet);
        /// 千万别忘记finish 会帮忙关闭流
        excelWriter.finish();
    }

**最终效果图**  
![在这里插入图片描述][20210125200027342.png]  
**EasyExcel读操作**  
首先如果没有引入依赖，必须引入依赖  
**创建实体类**  
首先创建实体类以及对应get set tostring 方法

import com.alibaba.excel.annotation.ExcelProperty;
    public class ReadData { 
        //设置列对应的属性
        @ExcelProperty(index = 0)
        private int sid;//sid代表下图学生编号如0,1，2
        
        //设置列对应的属性
        @ExcelProperty(index = 1)
        private String sname;//sname代表如下图学生姓名如lucy
    
        public int getSid() { 
            return sid;
        }
        public void setSid(int sid) { 
            this.sid = sid;
        }
        public String getSname() { 
            return sname;
        }
        public void setSname(String sname) { 
            this.sname = sname;
        }
        @Override
        public String toString() { 
            return "ReadData{" +
                    "sid=" + sid +
                    ", sname='" + sname + '\'' +
                    '}';
        }
    }

![在这里插入图片描述][20210125200538766.png]  
创建读取操作的监听器

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<ReadData> list = new ArrayList<ReadData>();
    
        //一行一行去读取excle内容,每读取一行会将它封装到user对象中
        @Override
        public void invoke(ReadData user, AnalysisContext analysisContext) { 
           System.out.println("***"+user);
            list.add(user);
        }
    
        //读取excel表头信息
        @Override
        public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) { 
            System.out.println("表头信息："+headMap);
        }
    
        //读取完成后执行
        @Override
        public void doAfterAllAnalysed(AnalysisContext analysisContext) { 
        }
    }

**调用实现最终的读取**

public static void main(String[] args) throws Exception { 
    
            // 写法1：
            String fileName = "F:\\01.xlsx";
            // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
            EasyExcel.read(fileName, ReadData.class, new ExcelListener()).sheet().doRead();
    
            // 写法2：
            InputStream in = new BufferedInputStream(new FileInputStream("F:\\01.xlsx"));
            ExcelReader excelReader = EasyExcel.read(in, ReadData.class, new ExcelListener()).build();
            ReadSheet readSheet = EasyExcel.readSheet(0).build();
            excelReader.read(readSheet);
            // 这里千万别忘记关闭，读的时候会创建临时文件，到时磁盘会崩的
            excelReader.finish();
    }

到此EasyExcel的基本读写就结束了，EasyExcel读写都是特定代码，此文仅为记录方法以便以后copy。方法变化以EasyExcel官方为主，本文仅供参考

[2021012519422190.png]: /images/20221119/c2ed71301dbf408896c2233b7cc5be7b.png
[20210125200027342.png]: /images/20221119/0b255b316c5644dbb9dc8e1c5fde5a53.png
[20210125200538766.png]: /images/20221119/82c667152ed946cdad7d5e664c27ae35.png