EasyExcel的使用

古城微笑少年丶 2024-03-26 10:57 10阅读 0赞

## EasyExcel的使用 ##

### 简介 ###

简介：  
EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。  
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。

这里有一篇POI的文章，EasyExcel是基于POI的[POI][]

操作官网：在官网有着很详细的操作，下面只是给这个官网中涉及的两个功能进行讲解。[EasyExcel][]

*  依赖

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>3.0.5</version>
            </dependency>

### 快速入门 ###

#### 写操作的演示 ####

##### pom.xml #####

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>org.example</groupId>
        <artifactId>POIStudy</artifactId>
        <version>1.0-SNAPSHOT</version>
        <dependencies>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>easyexcel</artifactId>
                <version>2.1.7</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.12</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.62</version>
            </dependency>
            
            
            
            
            
            
    
            
            <dependency>
                <groupId>joda-time</groupId>
                <artifactId>joda-time</artifactId>
                <version>2.10.1</version>
            </dependency>
    
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
            </dependency>
            
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>1.7.21</version>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
        </dependencies>
    
    </project>

![在这里插入图片描述][586c5dda55e34114beae4897a1cf888f.png]

##### DemoData.java #####

首先创建文件

文件结构  
![在这里插入图片描述][37ee7d6c6b0d42ca921bacc01c2c8b1e.png]

@Data
    public class DemoData {
        
        @ExcelProperty("字符串标题")
        private String string;
        @ExcelProperty("日期标题")
        private Date date;
        @ExcelProperty("数字标题")
        private Double doubleData;
    
        /*
        * 忽略这个字段
        * */
        @ExcelIgnore
        private String ignore;
    }

![在这里插入图片描述][f41e9512b0be4c7481e327b5e7687ad8.png]  
通用数据生成  
![在这里插入图片描述][13c11b92e82e4d52b86068e6e4ec6005.png]

写Excel的案例代码  
![在这里插入图片描述][7b7a11301715476391d8b49643d0da30.png]

##### EasyTest.java #####

public class EasyTest {
        
        String path = "D:\\系统默认\\桌面\\博客素材\\POIDemo\\";
    
        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;
        }
        /**
         * 最简单的写
         * <p>2. 直接写即可
         */
        @org.junit.Test
        public void simpleWrite() {
        
            String fileName = path + "EasyTest.xlsx";
            EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());
        }
    }

**运行结果**  
![在这里插入图片描述][8278c17acf14412d899e3e3da5fe5f8f.png]  
![在这里插入图片描述][9595dd434dcf444f8506d292328eee37.png]

#### 读操作的演示 ####

读操作，可以看操作文档的这个地方，这里有很详细的解释。  
![在这里插入图片描述][cd2b0987eadc44b5b15842bc0460858b.png]  
文件结构  
![在这里插入图片描述][115fd4957911432586c1a54cc13db1ba.png]

*  DemoDao

package org.example.easy;
    
    import java.util.List;
    
    /**
     * 假设这个是你的DAO存储。当然还要这个类让spring管理，当然你不用需要存储，也不需要这个类。
     **/
    public class DemoDAO {
        
        public void save(List<DemoData> list) {
        
            // 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
        }
    }

*  DemoDatailListener

package org.example.easy;
    
    import com.alibaba.excel.context.AnalysisContext;
    import com.alibaba.excel.event.AnalysisEventListener;
    import com.alibaba.fastjson.JSON;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    import java.util.ArrayList;
    import java.util.List;
    
    // 有个很重要的点 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
         *
         * @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);
        }
    }

测试程序

@org.junit.Test
    
        public void simpleRead() {
        
            String fileName = path+"EasyTest.xlsx";
            // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
            EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
        }

**运行结果**  
所有的数据都被读出来了。

![在这里插入图片描述][768feb0849f24a86b02cfaa4c3960fd3.png]

[POI]: https://blog.csdn.net/qq_51447496/article/details/129085675
[EasyExcel]: https://easyexcel.opensource.alibaba.com/docs/current/quickstart/read
[586c5dda55e34114beae4897a1cf888f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d39f0f28d26d411fbef7ba2f9f283d3e.png
[37ee7d6c6b0d42ca921bacc01c2c8b1e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d0397111246947e2a521b1be08df1028.png
[f41e9512b0be4c7481e327b5e7687ad8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/415b9b84637847428647c66ec187c10f.png
[13c11b92e82e4d52b86068e6e4ec6005.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/028091b5219a4b00a4677939e09f710b.png
[7b7a11301715476391d8b49643d0da30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/23043335583d464fa08ce2b8479cd1a7.png
[8278c17acf14412d899e3e3da5fe5f8f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d10ec5cfccef4d71949bb194f29651c4.png
[9595dd434dcf444f8506d292328eee37.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1c2420d3a30d408fbc5eaa0e8a2c1746.png
[cd2b0987eadc44b5b15842bc0460858b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/3b2b172726734c839bff627c78d0b09a.png
[115fd4957911432586c1a54cc13db1ba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d87c41d3a706445dab41e13a291147fd.png
[768feb0849f24a86b02cfaa4c3960fd3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0877e793c5f8413192a15215cf0f309a.png