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

程序员文章站 2024-01-24 10:31:16

有天上飞的概念，就要有落地的实现概念十遍不如代码一遍，朋友，希望你把文中所有的代码案例都敲一遍先赞后看，养成习惯 SpringBoot 图文教程系列文章目录 1. "SpringBoot图文教程1「概念+案例思维导图」「基础篇上」" 2. "SpringBoot图文教程2—日志的使用「logb ......

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

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

先赞后看，养成习惯

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

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

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的数据读取会稍微麻烦一点，直接通过工具类读取到的数据不能直接处理，需要借助一个中间的类监听器类，大致的流程如下图

SpringBoot图文教程14—SpringBoot集成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();


    }

读取的结果如下：

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