SpringBoot图文教程14—SpringBoot集成EasyExcel「上」

2020 年 3 月 11 日
筆記

有天上飞的概念，就要有落地的实现

概念十遍不如代码一遍，朋友，希望你把文中所有的代码案例都敲一遍

先赞后看，养成习惯

SpringBoot 图文教程系列文章目录

EasyExcel

EasyExcel 是阿里巴巴开源的一个Java操作Excel的技术，和EasyPoi一样是封装Poi的工具类。但是不同的地方在于，在EasyExcel中解决了Poi技术读取大批量数据耗费内存的问题。当然了，也封装了很多常用的Excel操作

最基本的导入导出
图片的导入导出
大批量数据的导入导出
模板的导出

官方地址：https://alibaba-easyexcel.github.io/quickstart/write.html

最基本的导入导出

最基本的导入导出，要导出的数据的实体类如下：

public class Teacher {      /**       * 老师的主键       */      private Integer teacherId;      /**       * 名字       */      private String teacherName;      /**       * 头像图片地址       */      private String teacherImage;      /**       * 老师的状态 0代表正常 1代表删除       */      private Integer teacherStatus;  }

省略get set

1.导入依赖

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

2.给要导出数据实体类加注解

EasyExcel也是注解式开发，常用注解如下

ExcelProperty 指定当前字段对应excel中的那一列
ExcelIgnore 默认所有字段都会和excel去匹配，加了这个注解会忽略该字段
DateTimeFormat 日期转换，用String去接收excel日期格式的数据会调用这个注解。里面的value参照java.text.SimpleDateFormat
NumberFormat 数字转换，用String去接收excel数字格式的数据会调用这个注解。里面的value参照java.text.DecimalFormat

3.直接导入导出

导出代码

   /**       * 基本的导出       */      @Test      public void test1(){  //        准备数据          List<Teacher> teachers = new ArrayList<>();          teachers.add(new Teacher(1,"hhh","hhh.jpg",1));          teachers.add(new Teacher(1,"hhh","hhh.jpg",1));          teachers.add(new Teacher(1,"hhh","hhh.jpg",1));          teachers.add(new Teacher(1,"hhh","hhh.jpg",1));            String fileName =  "/Users/lubingyang/Desktop/hhhh.xlsx";          // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭          // 如果这里想使用03 则 传入excelType参数即可          EasyExcel.write(fileName, Teacher.class).sheet("模板").doWrite(teachers);          }

导入代码

关于EasyExcel的数据读取会稍微麻烦一点，直接通过工具类读取到的数据不能直接处理，需要借助一个中间的类监听器类，大致的流程如下图

监听器的代码如下，有详细的注释

package com.lu.booteasyexcel;    import com.alibaba.excel.context.AnalysisContext;  import com.alibaba.excel.event.AnalysisEventListener;  import com.lu.booteasyexcel.dao.TeacherDao;  import com.lu.booteasyexcel.entity.Teacher;    import java.util.ArrayList;  import java.util.List;    // 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去  public class DemoDataListener extends AnalysisEventListener<Teacher> {      /**       * 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收       */      private static final int BATCH_COUNT = 5;        /**       * 这个集合用于接收 读取Excel文件得到的数据       */      List<Teacher> list = new ArrayList<Teacher>();        /**       * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。       */      private TeacherDao teacherDao;        public DemoDataListener() {        }        /**       *       * 不要使用自动装配       * 在测试类中将dao当参数传进来       */      public DemoDataListener(TeacherDao teacherDao) {          this.teacherDao = teacherDao;      }        /**       * 这个每一条数据解析都会来调用       *       */      @Override      public void invoke(Teacher teacher, AnalysisContext context) {            list.add(teacher);          // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM          if (list.size() >= BATCH_COUNT) {              saveData();              // 存储完成清理 list              list.clear();          }      }        /**       * 所有数据解析完成了 都会来调用       *       */      @Override      public void doAfterAllAnalysed(AnalysisContext context) {          // 这里也要保存数据，确保最后遗留的数据也存储到数据库          saveData();        }        /**       * 加上存储数据库       */      private void saveData() {  //        在这个地方可以调用dao  我们就直接打印数据了          System.out.println(list);      }  }

注意：

监听器这个类不能够被Spring管理，每次使用单独的new出来

导入的代码如下：

 /**       * 添加数据库用到的dao       */      @Autowired      private TeacherDao teacherDao;      /**       * 最简单的读       */      @Test      public void simpleRead() {          String fileName =  "/Users/lubingyang/Desktop/hhhh.xlsx";            // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭          /**           * 参数1 要读取的文件           * 参数2 要读取的数据对应的实体类类对象           * 参数3 监听器对象 可以在创建的时候把dao当做参数传进去           */          EasyExcel.read(fileName, Teacher.class, new DemoDataListener(teacherDao)).sheet().doRead();          }

读取的结果如下：

图片的导出

在EasyExcel中支持多种图片的导入导出，什么意思呢？一般情况下，数据库表中的图片字段存储的是图片路径，读取图片文件导出是支持的，除此之外，还支持网络路径，流，字节数组等方式。我的案例以读取本地图片文件为主。

官方文档地址：https://alibaba-easyexcel.github.io/quickstart/write.html#%E5%9B%BE%E7%89%87%E5%AF%BC%E5%87%BA

实体类改造

导出的代码是【不需要做任何改变】

总结

Tips：最近开始复工了，比较的忙，本文只是EasyExcel的基本使用，下一篇文章，讲解模板导出和百万数据导出

恭喜你完成了本章的学习，为你鼓掌！如果本文对你有帮助，请帮忙点赞，评论，转发，这对作者很重要，谢谢。

让我们再次回顾本文的学习目标

掌握SpringBoot中EasyExcel的基本使用

要掌握SpringBoot更多的用法，请持续关注本系列教程。

求关注，求点赞，求转发

欢迎关注本人公众号：鹿老师的Java笔记，将在长期更新Java技术图文教程和视频教程，Java学习经验，Java面试经验以及Java实战开发经验。