springboot整合EasyExcel

springboot整合EasyExcel

easyexcel是阿里开源的解析excel的工具,可以把它看作对poi的优化版。

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

 

easyexcel核心功能

 

功能描述参考：https://blog.csdn.net/jiangjiandecsd/article/details/81115622 

• 读任意大小的03、07版Excel不会OOM
• 读Excel自动通过注解，把结果映射为java模型
• 读Excel支持多sheet
• 读Excel时候是否对Excel内容做trim()增加容错
• 写小量数据的03版Excel（不要超过2000行）
• 写任意大07版Excel不会OOM
• 写Excel通过注解将表头自动写入Excel
• 写Excel可以自定义Excel样式 如：字体，加粗，表头颜色，数据内容颜色
• 写Excel到多个不同sheet
• 写Excel时一个sheet可以写多个Table
• 写Excel时候自定义是否需要写表头

1、引入依赖

  

     com.alibaba
	 easyexcel
	 1.1.2-beta5

依赖包是目前最新的版本 

2、实体类

package com.xxx.xxxutils.utils;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import lombok.*;


@EqualsAndHashCode(callSuper = true)
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class TableHeaderExcelProperty  extends BaseRowModel{

    /**
     * value: 表头名称
     * index: 列的号, 0表示第一列
     */
    @ExcelProperty(value = "姓名", index = 0)
    private String name;

    @ExcelProperty(value = "年龄",index = 1)
    private int age;

    @ExcelProperty(value = "学校",index = 2)
    private String school;





}

3、excel工具方法

 

package com.xxx.xxxutils.utils;

import com.alibaba.excel.EasyExcelFactory;
import com.alibaba.excel.ExcelReader;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.util.CollectionUtils;
import com.alibaba.excel.util.StringUtils;
import com.xxx.xxxutils.listener.ExcelListener;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.apache.poi.poifs.filesystem.FileMagic;
import java.io.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;


@Slf4j
public class ExcelUtil{

    /**
     * 从Excel中读取文件，读取的文件是一个DTO类，该类必须继承BaseRowModel
     * 导入方法  第一个参数文件输入流，第二个参数实体类，必须继承自BaseRowModel
     * 参考：https://github.com/alibaba/easyexcel
     * 字符流必须支持标记，FileInputStream 不支持标记，可以使用BufferedInputStream 代替
     * BufferedInputStream bis = new BufferedInputStream(new FileInputStream(...));
     */
    public static  List readExcel(final InputStream inputStream, final Class clazz) {
        if (null == inputStream) {
            throw new NullPointerException("the inputStream is null!");
        }
        ExcelListener listener = new ExcelListener<>();
        // ExcelListener，读取大于1000行的数据才需要传入此参数
        ExcelReader reader = new ExcelReader(inputStream,  valueOf(inputStream), null, listener);
        reader.read(new Sheet(1, 1, clazz));

        return listener.getRows();
    }



     /**
     * 从Excel中读取文件，读取的文件是一个DTO类，该类必须继承BaseRowModel
     * 导出方法  第一个参数文件，第二个参数实体类集合，必须继承自BaseRowModel
     */
    public static void writeExcel(final File file, List list) {
        try (OutputStream out = new FileOutputStream(file)) {
            ExcelWriter writer = new ExcelWriter(out, ExcelTypeEnum.XLSX);
            //写第一个sheet,  有模型映射关系
            Class t = list.get(0).getClass();
            Sheet sheet = new Sheet(1, 0, t);
            writer.write(list, sheet);
            writer.finish();
        } catch (IOException e) {
            log.warn("fail to write to excel file: file[{}]", file.getName(), e);
        }
    }


    /**
     * 根据输入流，判断为xls还是xlsx，该方法原本存在于easyexcel 1.1.0 的ExcelTypeEnum中。
     */
    public static ExcelTypeEnum valueOf(InputStream inputStream) {
        try {
            FileMagic fileMagic = FileMagic.valueOf(inputStream);
            if (FileMagic.OLE2.equals(fileMagic)) {
                return ExcelTypeEnum.XLS;
            }
            if (FileMagic.OOXML.equals(fileMagic)) {
                return ExcelTypeEnum.XLSX;
            }
            throw new IllegalArgumentException("excelTypeEnum can not null");

        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }








    /****************************************************************************/


        private static Sheet initSheet;

        static {
            initSheet = new Sheet(1, 0);
            initSheet.setSheetName("sheet");
            //设置自适应宽度
            initSheet.setAutoWidth(Boolean.TRUE);
        }

        /**
         * 导入方法，读取少于1000行数据
         * @param filePath 文件绝对路径
         * @return
         */
        public static List