SpringBoot集成EasyExcel实现Excel导入

最新推荐文章于 2024-06-23 09:15:00 发布
最新推荐文章于 2024-06-23 09:15:00 发布
阅读量987 收藏 5
点赞数 2
分类专栏： JAVA 文章标签： java spring boot spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45031111/article/details/112299645
版权
本文档介绍了如何在SpringBoot应用中集成EasyExcel实现Excel文件上传和解析。通过添加EasyExcel依赖，创建实体类和监听器，以及设置Controller处理MultipartFile，实现了从前端接收Excel并进行数据读取的功能。同时，展示了EasyExcel的不同Read方法，便于根据不同场景选择合适的方法。文章还提供了测试步骤和代码示例。
摘要由CSDN通过智能技术生成

SSpringBoot集成EasyExcel实现Excel导入

文章目录

第一次正式的写文章进行分享，如果文章中有什么问题，欢迎大家在文末的群内反馈。

一、背景

为什么会用Easyexcel来做Excel上传

平时项目中经常使用EasyExcel从本地读取Excel中的数据，还有一个前端页面对需要处理的数据进行一些配置(如：Excel所在的文件夹，Excel的文件名，以及Sheet列名、处理数据需要的某些参数)，由于每次都是读取的本地的文件，我就在想，如果某一天需要通过前端上传excel给我，让我来进行处理我又应该怎么办呢？我怎么才能在尽量少修改代码的前提下实现这个功能呢(由于公司经常改需求，项目已经重新写了3次了)？后来查了很多资料，发现Excel可以使用InPutStream流来读取Excel，我就突然明白了什么。

阿里巴巴语雀团队对EasyExcel是这样介绍的
Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，
poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压
缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，能够原
本一个3M的excel用POI sax依然需要100M左右内存降低到几M，并且再大的excel不会出现内存溢出，03版依赖
POI的sax模式。在上层做了模型转换的封装，让使用者更加简单方便。
当然还有急速模式能更快，但是内存占用会在100M多一点。

二、集成EasyExcel？

萨达

1、 在pom.xml中添加EasyExcel依赖
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.1.3</version>
        </dependency>
2、创建EasyExcel映射实体类
import com.alibaba.excel.annotation.ExcelProperty;

public class ExcelEntity {
    // ExcelProperty中的参数要对应Excel中的标题
    @ExcelProperty("ID")
    private int ID;

    @ExcelProperty("NAME")
    private String name;

    @ExcelProperty("AGE")
    private int age;

    public ExcelEntity() {
    }

    public ExcelEntity(int ID, String name, int age) {
        this.ID = ID;
        this.name = name;
        this.age = age;
    }

    public int getID() {
        return ID;
    }

    public void setID(int ID) {
        this.ID = ID;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}
3、创建自定义Easyexcel的监听类

  • 这个监听类里面每一个ExcelEntity对象代表一行数据

  • 在这个监听类里面可以对读取到的每一行数据进行单独操作

  • 这里的读取的数据是按照Excel中每一条数据的顺序进行读取的

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import java.util.ArrayList;
import java.util.List;

public class UploadExcelListener extends AnalysisEventListener<ExcelEntity> {

    private static final Logger logger = LoggerFactory.getLogger(LoggerItemController.class);
    public static final List<ExcelEntity> list = new ArrayList<>();

    @Override
    public void invoke(ExcelEntity excelEntity, AnalysisContext context) {
        logger.info(String.valueOf(excelEntity.getID()));
        logger.info(excelEntity.getName());
        logger.info(String.valueOf(excelEntity.getAge()));
        list.add(excelEntity);
    }
4、创建controller
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelReader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

@RestController
@CrossOrigin
@RequestMapping("/loggerItem")
public class LoggerItemController {


    //  MultipartFile 这个类一般是用来接受前台传过来的文件
    @PostMapping("/upload")
    public List<ExcelEntity> upload(@RequestParam(value = "multipartFile") MultipartFile multipartFile){
        if (multipartFile == null){
            return null;
        }

        InputStream in = null;
        try {
            // 从multipartFile获取InputStream流
            in = multipartFile.getInputStream();

            /*
             *  EasyExcel 有多个不同的read方法，适用于多种需求
             *  这里调用EasyExcel中通过InputStream流方式读取Excel的Read方法
             *  他会返回一个ExcelReaderBuilder类型的返回值
             *  ExcelReaderBuilder中有一个doReadAll方法，会读取所有的Sheet
             */
            EasyExcel.read(in,ExcelEntity.class,new UploadExcelListener())
                    .sheet("Sheet1")
                    .doRead();

            //  每次EasyExcel的read方法读取完之后都会关闭流，我这里为了试验doReadAll方法，所以重新获取了一次
            in = multipartFile.getInputStream();
            /*
             * ExcelReaderBuilder中的Sheet方法，需要添加读取的Sheet名作为参数
             * 并且不要忘记在后面再调用一下doReadAll方法，否则不会进行读取操作
             */

            EasyExcel.read(in,ExcelEntity.class,new UploadExcelListener()).doReadAll();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return UploadExcelListener.list;
    }
}
5、application.yml配置
server:
  # 指定端口号
  port: 8080
spring:
  servlet:
    multipart:
      # 配置单个上传文件大小
      file-size-threshold: 100M
      # 配置总上传大小
      max-request-size: 300M
6、测试

我们先搞一个简单的Excel，用来测试

在这里插入图片描述

然后通过Postman模拟发送请求

  • 选择Post请求并输入请求地址
  • 在下面选择Body
  • Key的框中输入controller中的请求的方法中的参数，后面的下拉框中选择File
  • VALUE框中有一个Select File ，点击后选择自己刚才创建的测试的Excel
  • 最后点击Send发送请求

在这里插入图片描述

返回值如下：

由于我读了两次都放在同一个List中返回，所以返回值中有8个对象。

[
    {
        "name": "小黑",
        "age": 25,
        "id": 1
    },
    {
        "name": "小白",
        "age": 22,
        "id": 2
    },
    {
        "name": "小黄",
        "age": 22,
        "id": 3
    },
    {
        "name": "小绿",
        "age": 23,
        "id": 4
    },
    {
        "name": "小黑",
        "age": 25,
        "id": 1
    },
    {
        "name": "小白",
        "age": 22,
        "id": 2
    },
    {
        "name": "小黄",
        "age": 22,
        "id": 3
    },
    {
        "name": "小绿",
        "age": 23,
        "id": 4
    }
]

三、EasyExcel中的Read方法汇总

/**
     * Build excel the read
     *
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read() {
        return new ExcelReaderBuilder();
    }

    /**
     * Build excel the read
     *
     * @param file
     *            File to read.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(File file) {
        return read(file, null, null);
    }

    /**
     * Build excel the read
     *
     * @param file
     *            File to read.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(File file, ReadListener readListener) {
        return read(file, null, readListener);
    }

    /**
     * Build excel the read
     *
     * @param file
     *            File to read.
     * @param head
     *            Annotate the class for configuration information.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) {
        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
        excelReaderBuilder.file(file);
        if (head != null) {
            excelReaderBuilder.head(head);
        }
        if (readListener != null) {
            excelReaderBuilder.registerReadListener(readListener);
        }
        return excelReaderBuilder;
    }

    /**
     * Build excel the read
     *
     * @param pathName
     *            File path to read.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(String pathName) {
        return read(pathName, null, null);
    }

    /**
     * Build excel the read
     *
     * @param pathName
     *            File path to read.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(String pathName, ReadListener readListener) {
        return read(pathName, null, readListener);
    }

    /**
     * Build excel the read
     *
     * @param pathName
     *            File path to read.
     * @param head
     *            Annotate the class for configuration information.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) {
        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
        excelReaderBuilder.file(pathName);
        if (head != null) {
            excelReaderBuilder.head(head);
        }
        if (readListener != null) {
            excelReaderBuilder.registerReadListener(readListener);
        }
        return excelReaderBuilder;
    }

    /**
     * Build excel the read
     *
     * @param inputStream
     *            Input stream to read.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(InputStream inputStream) {
        return read(inputStream, null, null);
    }

    /**
     * Build excel the read
     *
     * @param inputStream
     *            Input stream to read.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener) {
        return read(inputStream, null, readListener);
    }

    /**
     * Build excel the read
     *
     * @param inputStream
     *            Input stream to read.
     * @param head
     *            Annotate the class for configuration information.
     * @param readListener
     *            Read listener.
     * @return Excel reader builder.
     */
    public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) {
        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
        excelReaderBuilder.file(inputStream);
        if (head != null) {
            excelReaderBuilder.head(head);
        }
        if (readListener != null) {
            excelReaderBuilder.registerReadListener(readListener);
        }
        return excelReaderBuilder;
    }

所有的方法都在这儿了，其实如果看不懂到底应该调用哪一个read方法的话，可以以根据自己所能得到的参数来判断。

四、扩展

  • 读取本地Excel

    public static void main(String[] args) {
    EasyExcel.read("C:/Users/Lonely Programmer/Desktop/新建 Microsoft Excel 工作表.xlsx"
                   ,ExcelEntity.class
                   ,new UploadExcelListener())
        .doReadAll();
}

    读取本地的Excel和通过InPutStream流读取的方式是一样的，只是参数变了，原本传的是InPutStream流，现在传的是文件的绝对路径。我这里监听类和映射实体类都没有变，和上传用的是同一个，大家也可以根据需求来设定自己的监听类与实体类

  • MultipartFile文档

    MultipartFile文档地址：https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/multipart/MultipartFile.html

    翻译是通过Google Chrome自带翻译插件进行翻译的，建议大家使用Google Chrome打开，自带翻译功能
    在这里插入图片描述

最后欢迎大家进群交流：251199521

平时上班比较忙，所以一般更新也不会很快，操作过程中如果遇到什么问题，可以群内提问，我看到了的话，有时间基本上都会回复的。

其实百度才是最好的老师。

CodeBirdHao
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
专栏目录
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
05-03
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
SpringBoot分片上传Excel大文件，支持断点续传，EasyExcel处理百万级数据
07-05
前端Excel大文件file slice分片，md5校验文件完整性并作文件标识记录写入数据库，支持断点续传。文件上传完毕后，使用EasyExcel读取文件流，处理Excel数据写入数据库中，可处理百万级数据。项目完整，连接数据库即可运行。
Spring Boot通过EasyExcel异步多线程实现大数据量Excel导入,百万数据30秒
最新发布
学IT，找陈寒
06-23 1352
通过本文的介绍，我们了解了如何利用Spring Boot和EasyExcel实现高效的大数据量Excel导入功能。通过异步多线程处理，可以在短时间内完成对百万级数据的导入操作，显著提升了系统的性能和用户体验。在实际应用中，可以根据具体需求进一步优化和扩展，以满足不同场景下的数据处理需求。希望本文能够帮助到正在寻找Excel导入解决方案的开发者，也希望读者能够在实际项目中成功应用这些技术，提升自身的开发效率和项目的稳定性。😊🙏Java面试技巧Java面试八股文 - 掌握面试必备知识（目录篇）
SpringBoot 实现 Excel 导入导出，百万数据量，性能爆表！
芋艿V
02-15 1522
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 10:33更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络应用框架 Netty 源码解析消息中间件 RocketMQ 源码解析数据库中间件 Sharding-JDBC 和 MyCAT 源码解析作业调度中间件 E...
使用spring boot整合EasyExcel实现excel表格的导入、导出功能
2301_78646673的博客
12-05 2897
基于spring boot的自动装配原理，可以帮助我们快速的整合一些其他技术。本次使用spring boot整合EasyExcel来实现excel表格的导入和导出。
springboot整合easyExcel实现简单Excel文件的导入
weixin_46009301的博客
04-12 740
springboot整合easyexcel实现excel表格导入数据库与数据库导出到excel表格
springboot easyexcel实现数据导出成excel表格功能
10-26
Java使用springboot、easyexcel实现数据导出成excel表格功能，适用于刚入门的Java程序员或想提高知识面的朋友，该功能常用于项目数据导出，此demo通俗易懂，可以简单修改后在项目中直接使用。
springboot结合Easyexcel的使用（详细介绍Easyexcel）小白入门到精通
12-21
三、SpringBoot集成EasyExcel的步骤： 1. 创建SpringBoot项目：使用IDEA创建一个新的SpringBoot项目，配置pom.xml文件，引入EasyExcel的依赖。例如： ```xml <groupId>org.springframework.boot <artifactId>...
案例实战-SpringBoot整合EasyExcel实现列表导出功能
06-03
在本案例实战中，我们将探讨如何使用...同时，EasyExcel还支持读取Excel数据，可以方便地进行数据导入功能的实现。通过深入理解和实践，你可以更好地掌握这两个强大工具的协同工作，提升你的Web应用的用户体验。
spring boot导入导出excel,集成EasyExcel
weixin_41463944的博客
11-01 1104
spring boot导入导出excel,集成EasyExcel
多线程导出Excel(百万级别)_Java版优化.zip
09-10
用开源 Apache POI 技术导出Excel，解决导出大数据出现OOM、栈溢出问题，此资源可实现百万级数据多线程分批导出Excel文件，不会内存溢出，生产环境已很稳定的使用者，所以用到的技术很核心、值得参考
SpringBoot中使用Easyexcel实现Excel导入导出功能（一）
热门推荐
凡夫编程
12-08 2万+
excel表格的导入与导出，可以说是业务系统里比较常见的功能了，早些时候相信很多人都是使用POI实现excel的导入与导出功能，后来出现了easyexcel，从我自己的使用感受来说，我更喜欢使用easyexcel，除了封装的比较好外，最重要的是对超级大excel导入有了更好的方案，与POI相比，速度更快，占用内存更少。
springboot整合阿里easyexcel2.x实现海量数据excel导入导出demo
竹林幽深
04-03 1145
EasyExcel.write(response.getOutputStream(), ConfigFilterImport.class).sheet("模板").doWrite(list);logger.error("执行出错{}",e.getMessage());logger.error("执行出错{}",e.getMessage());logger.info("用时：" + (endTime - startTime));logger.error("执行出错{}",e.getMessage());
项目中Excel导出大数据量记录解决方案及实战(POI,Hutools,EasyExcel)
一颗浑身披带雪花的松树---[雪松]
08-25 4877
目录 1、使用场景 2、代码实现 2.1 引入的jar maven配置 2.2使用POI高级版功能(SXSSFWorkbook)V3.8版本以上 2.3使用国内开源工具包Hutools实现 2.4使用EasyExcel进行测试代码 3、成果展现 4、总结 5、参考文章 1、使用场景 因为最近项目需要，有一个培训系统之中，培训任务下有3000多用户；以前开发这个导出方式使用POI,基础功能创建的导出功能函数。最后导致这个导出功能导出3000多条记录需要耗时26s(...
SpringBoot 实现 Excel 导入导出，百万数据量，不在话下！
weixin_44421461的博客
09-05 582
????这是一个或许对你有用的社群????一对一交流/面试小册/简历优化/求职解惑，欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料：《项目实战（视频）》：从书中学，往事中“练”《互联网高频面试题》：面朝简历学习，春暖花开《架构 x 系统设计》：摧枯拉朽，掌控面试高频场景题《精进 Java 学习指南》：系统学习，互联网主流技术栈《必读 Java 源码专栏》：知其然，知其所以然????这是一个或许...
springboot集成easyexcel的导入
09-07
要在Spring Boot中集成easyexcel进行导入，您需要进行以下步骤： 1. 首先，您需要在您的项目中添加easyexcel的相关依赖。在您的pom.xml文件中添加以下依赖： ``` <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.4</version> </dependency> ``` 2. 您需要创建一个控制器类来处理导入请求。在该类中，您可以使用`@PostMapping`注解来处理导入请求，并将上传的文件作为`MultipartFile`参数。在该方法中，您可以调用相应的服务类来处理导入逻辑。以下是一个示例控制器类的代码： ```java @RestController @RequestMapping("/excel") public class ExcelController { @Autowired private ExcelService excelService; @PostMapping("/user/excelImport") public String excelImport(@RequestParam("file") MultipartFile file) throws IOException { excelService.excelImport(file); return "success"; } } ``` 3. 您还需要创建一个服务类来处理导入逻辑。在该类中，您可以使用easyexcel提供的API来读取并处理Excel文件。以下是一个示例服务类的代码： ```java @Service public class ExcelService { public void excelImport(MultipartFile file) throws IOException { // 使用easyexcel API读取并处理Excel文件 InputStream inputStream = file.getInputStream(); EasyExcel.read(inputStream, YourDataClass.class, new YourDataListener()).sheet().doRead(); } } ``` 4. 最后，您还需要创建一个数据监听器类来处理导入的Excel数据。您可以在此类中实现`AnalysisEventListener`接口，并重写对应的方法来处理每一行的数据。以下是一个示例数据监听器类的代码： ```java public class YourDataListener extends AnalysisEventListener<YourDataClass> { @Override public void invoke(YourDataClass data, AnalysisContext context) { // 处理每一行的数据 } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 所有数据解析完成后的操作 } } ``` 以上就是在Spring Boot中集成easyexcel进行导入的基本步骤。您可以根据您的具体需求进行相应的调整和扩展。<span class="em">1</span><span class="em">2</span><span class="em">3</span><span class="em">4</span>
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值