2020-04-24

好用的EasyExcel工具类(1.1.2-beta5版本)

写在前面

EasyExcel是阿里推出的一款高性能的开源excel读写框架,具体的框架介绍这里就不再提了,有兴趣的同学点击下面的地址链接去github上看。笔者发现目前网上很多介绍easyexcel博客或文章都是基于1.1.2-beta5版本进行讲解的,故笔者整理了一个适用于该版本的工具类,方便自己使用。实际主要是懒得记对应的API,并且匹配自己平时的编程习惯。有需要的小伙伴自取。

easyexcel开源地址:https://github.com/alibaba/easyexcel

引入依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>1.1.2-beta5</version>
</dependency> 

工具类

import com.alibaba.excel.EasyExcelFactory;
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.metadata.Table;
import com.alibaba.excel.support.ExcelTypeEnum;
import lombok.extern.slf4j.Slf4j;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;

/**
*  EasyExcel工具类
 * @author jwhappy
 * @date 2020/4/21
 */
@Slf4j
public class EasyExcelUtil
{
    /**
     * 无模板读取(从sheet1的第1行开始读)
     * @param inputStream
     * @return List<List<String>>
     */
    public static List<Object> read(InputStream inputStream){
        return EasyExcelFactory.read(inputStream, new Sheet(1, 0));
    }

    /**
     * 无模板读取(自己指定从sheet1的哪一行开始读)
     * @param inputStream
     * @param headLineMun 表头占的行数,从0开始
     * @return List<List<String>>
     */
    public static List<Object> read(InputStream inputStream, Integer headLineMun){
        return EasyExcelFactory.read(inputStream, new Sheet(1, headLineMun));
    }

    /**
     * 无模板读取(自己指定sheet和开始的行)
     * 返回 List<List<String>>
     * @param inputStream
     * @param sheetNo sheet页号,从1开始
     * @param headLineMun 表头占的行数,从0开始
     * @return List<List<String>>
     */
    public static List<Object> read(InputStream inputStream, Integer sheetNo, Integer headLineMun){
        return EasyExcelFactory.read(inputStream, new Sheet(sheetNo, headLineMun));
    }

    /**
     * 按模板读取(从sheet1的第2行开始读取)
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @return List<Object>, Object对应具体的clazz类
     */
    public static List<Object> read(InputStream inputStream, final Class<? extends BaseRowModel> clazz){
        return EasyExcelFactory.read(inputStream, new Sheet(1, 1, clazz));
    }

    /**
     * 按模板读取(从指定sheet的第2行开始读)
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param sheetNo sheet页号,从1开始
     * @return List<Object>, Object对应具体的clazz类
     */
    public static List<Object> read(InputStream inputStream, final Class<? extends BaseRowModel> clazz, Integer sheetNo){
        return EasyExcelFactory.read(inputStream, new Sheet(sheetNo, 1, clazz));
    }

    /**
     * 按模板读取(自定义sheet和表头行数)
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param sheetNo sheet页号,从1开始
     * @param headLineMun 表头占的行数,从0开始
     * @return List<Object>, Object对应具体的clazz类
     */
    public static List<Object> read(InputStream inputStream, final Class<? extends BaseRowModel> clazz, Integer sheetNo, Integer headLineMun){
        return EasyExcelFactory.read(inputStream, new Sheet(sheetNo, headLineMun, clazz));
    }

    /**
     * 按模板读取(从sheet1的第2行开始读取)
     * 1000行以上的数据建议用这个读取
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param <T> 模板类泛型
     * @return List<T>
     */
    public static <T extends BaseRowModel> List<T> readModel(InputStream inputStream, final Class<? extends BaseRowModel> clazz){
        ExcelListener excelListener = new ExcelListener();
        EasyExcelFactory.readBySax(inputStream, new Sheet(1, 1, clazz), excelListener);
        return excelListener.getRows();
    }

    /**
     * 按模板读取(从指定sheet的第2行开始读)
     * 1000行以上的数据建议用这个读取
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param sheetNo sheet页号,从1开始
     * @param <T> 模板类泛型
     * @return List<T>
     */
    public static <T extends BaseRowModel> List<T> readModel(InputStream inputStream, final Class<? extends BaseRowModel> clazz, Integer sheetNo){
        ExcelListener excelListener = new ExcelListener();
        EasyExcelFactory.readBySax(inputStream, new Sheet(sheetNo, 1, clazz), excelListener);
        return excelListener.getRows();
    }

    /**
     * 按模板读取(自定义sheet和表头行)
     * 1000行以上的数据建议用这个读取
     * @param inputStream
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param sheetNo sheet页号,从1开始
     * @param headLineMun 表头占的行数,从0开始
     * @param <T> 模板类泛型
     * @return List<T>
     */
    public static <T extends BaseRowModel> List<T> readModel(InputStream inputStream, final Class<? extends BaseRowModel> clazz, Integer sheetNo, Integer headLineMun){
        ExcelListener excelListener = new ExcelListener();
        EasyExcelFactory.readBySax(inputStream, new Sheet(sheetNo, headLineMun, clazz), excelListener);
        return excelListener.getRows();
    }

    /**
     * 按模板写入(写入sheet1,表头占第一行)
     * @param outputStream
     * @param data 写入的数据(模板对象List)
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     */
    public static void writeModel(OutputStream outputStream, List<? extends BaseRowModel> data, final Class<? extends BaseRowModel> clazz){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(1, 1, clazz);
        excelWriter.write(data, sheet);
        excelWriter.finish();
    }

    /**
     * 按模板写入(指定sheet,表头占第一行)
     * @param outputStream
     * @param data 写入的数据(模板对象List)
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param sheetNo sheet页号,从1开始
     */
    public static void writeModel(OutputStream outputStream, List<? extends BaseRowModel> data, final Class<? extends BaseRowModel> clazz, Integer sheetNo){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(sheetNo, 1, clazz);
        excelWriter.write(data, sheet);
        excelWriter.finish();
    }

    /**
     * 按模板写入(指定sheet页和sheet名称,指定表头行数)
     * @param outputStream
     * @param data 写入的数据(模板对象List)
     * @param clazz 模板类,需要继承BaseRowModel类,字段用@ExcelProperty注解
     * @param headLineMun 表头占的行数,从0开始
     * @param sheetNo sheet页号,从1开始
     * @param sheetName sheet名称
     */
    public static void writeModel(OutputStream outputStream, List<? extends BaseRowModel> data, final Class<? extends BaseRowModel> clazz, Integer headLineMun, Integer sheetNo, String sheetName){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(sheetNo, headLineMun, clazz);
        sheet.setSheetName(sheetName);
        excelWriter.write(data, sheet);
        excelWriter.finish();
    }

    /**
     * 无模板写入(写入sheet1,表头占第一行)
     * @param outputStream
     * @param data 写入的数据(List<List<Object>>)
     * @param table 表设置,可以设置表头字段,以及表的样式设置
     */
    public static void write(OutputStream outputStream, List<List<Object>> data, Table table){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(1, 0);
        excelWriter.write1(data, sheet, table);
        excelWriter.finish();
    }

    /**
     * 无模板写入(指定sheet,表头占第一行)
     * @param outputStream
     * @param data 写入的数据(List<List<Object>>)
     * @param table 表设置,可以设置表头字段,以及表的样式设置
     * @param sheetNo sheet页号,从1开始
     */
    public static void write(OutputStream outputStream, List<List<Object>> data, Table table, Integer sheetNo){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(sheetNo, 0);
        excelWriter.write1(data, sheet, table);
        excelWriter.finish();
    }

    /**
     * 无模板写入(指定sheet页和sheet名称,指定表头行数)
     * @param outputStream
     * @param data 写入的数据(List<List<Object>>)
     * @param table 表设置,可以设置表头字段,以及表的样式设置
     * @param headLineMun 表头占的行数,从0开始
     * @param sheetNo sheet页号,从1开始
     * @param sheetName sheet名称
     */
    public static void write(OutputStream outputStream, List<List<Object>> data, Table table, Integer headLineMun, Integer sheetNo, String sheetName){
        ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(sheetNo, headLineMun);
        sheet.setSheetName(sheetName);
        excelWriter.write1(data, sheet, table);
        excelWriter.finish();
    }

    /**
     * 多个sheet页的数据链式写入
     * ExcelUtil.writeWithSheets(outputStream)
     *                  .writeModel( Collections.singletonList(excelModel), ExcelModel.class, "sheet1Name")
     *                  .write(data,table,"sheet2Name")
     *                  .finish();
     * @param outputStream
     * @return
     */
    public static EasyExcelWriterFactory writeWithSheets(OutputStream outputStream){
        EasyExcelWriterFactory excelWriter = new EasyExcelWriterFactory(outputStream, ExcelTypeEnum.XLSX);
        return excelWriter;
    }

    /**
     * 多个sheet页的数据链式写入
     * ExcelUtil.writeWithSheets(response, exportFileName)
     *                  .writeModel( Collections.singletonList(excelModel), ExcelModel.class, "sheet1Name")
     *                  .write(data,table,"sheet2Name")
     *                  .finish();
     * @param response
     * @param exportFileName 导出文件名
     * @return
     */
    public static EasyExcelWriterFactory writeWithSheetsWeb(HttpServletResponse response, String exportFileName) throws IOException
    {
        //添加响应头信息
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 这里URLEncoder.encode可以防止中文乱码
        String fileName = URLEncoder.encode(exportFileName, "UTF-8");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
        EasyExcelWriterFactory excelWriter = new EasyExcelWriterFactory(response.getOutputStream(), ExcelTypeEnum.XLSX);
        return excelWriter;
    }
}

@Slf4j
class ExcelListener<T extends BaseRowModel> extends AnalysisEventListener<T>
{
    private final List<T> rows = new ArrayList<>();

    @Override
    public void invoke(T object, AnalysisContext context) {
        rows.add(object);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        log.info("read {} rows", rows.size());
    }

    public List<T> getRows() {
        return rows;
    }
}
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import com.alibaba.excel.metadata.Table;
import com.alibaba.excel.support.ExcelTypeEnum;

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

/**
 * 自定义EasyExcel写工厂
 */
public class EasyExcelWriterFactory extends ExcelWriter
{
    private OutputStream outputStream;
    private int sheetNo = 1;

    public EasyExcelWriterFactory(OutputStream outputStream, ExcelTypeEnum typeEnum) {
        super(outputStream, typeEnum);
        this.outputStream = outputStream;
    }

    /**
     * 链式按模板写入
     * @param data
     * @param clazz
     * @param sheetName
     * @return
     */
    public EasyExcelWriterFactory writeModel(List<? extends BaseRowModel> data, final Class<? extends BaseRowModel> clazz, String sheetName){
        Sheet sheet = new Sheet(this.sheetNo++, 0, clazz);
        sheet.setSheetName(sheetName);
        this.write(data, sheet);
        return this;
    }

    /**
     * 链式无模板写入
     * @param data
     * @param table
     * @param sheetName
     * @return
     */
    public EasyExcelWriterFactory write(List<List<Object>> data, Table table, String sheetName){
        Sheet sheet = new Sheet(this.sheetNo++, 0);
        sheet.setSheetName(sheetName);
        this.write1(data, sheet, table);
        return this;
    }

    @Override
    public void finish() {
        super.finish();
        try {
            outputStream.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,539评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,594评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,871评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,963评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,984评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,763评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,468评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,850评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,002评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,144评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,823评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,483评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,026评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,150评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,415评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,092评论 2 355

推荐阅读更多精彩内容

  • 好用的EasyExcel工具类(2.1.6版本) 写在前面 EasyExcel是阿里推出的一款高性能的开源exce...
    小马_24e0阅读 209评论 0 0
  • 1.java常见的名词 英文名中文名含义EJB(Enterprise java bean)Enterprise j...
    金布拉阅读 433评论 0 3
  • 盘点市场上的传奇类游戏,手游类传奇频出,私服目前还是最火? 自从2002年9月意大利传奇版本泄露后,传奇感觉新开了...
    lllwCc阅读 129评论 0 0
  • 太极拳大师杨澄甫PK“死神”方便:跨越时空大较量 作者:李通国 看到太极拳大师杨澄甫PK“死神”方便这个题目,许多...
    浦阳江阅读 545评论 0 2
  • 叶是普通城镇的一个普通的女孩,像这个城镇其他的女孩一样,因为她是家中的老大,因为她是一个女孩,所以在她下面还有一个...
    Phyllis西阅读 755评论 1 2