【excel】easyexcel流式导出大批量数据

Apache POI提供了HSSF、XSSF以及SXSSF三种方式操作Excel。他们的区别如下:

  • HSSF:是操作Excel97-2003版本,扩展名为.xls,一个sheet最大行数65536,最大列数256。
  • XSSF:是操作Excel2007版本开始,扩展名为.xlsx,一个sheet最大行数1048576,最大列数16384。
  • SXSSF:是在XSSF基础上,POI3.8版本开始提供的一种支持低内存占用的操作方式,扩展名为.xlsx。

SXSSF操作可以实现海量数据处理,而EasyExcel作为三方包来封装了SXSSF操作。

引入依赖:

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

注解实现

实体类添加注解:


@Data
@HeadRowHeight(30)  //表头行高
@ContentRowHeight(15)  //内容行高
@ColumnWidth(18)  //列宽
@ContentFontStyle(fontHeightInPoints = (short) 12) //字体大小
@ApiModel(value = "ExportEntity", description = "ExportEntity")
public class ExportEntity {
 
  /** id */
  @ApiModelProperty(value = "id")
  @ExcelProperty("id")
  private Long id;
  /** 名称 */
  @ApiModelProperty(value = "名称")
  @ExcelProperty("名称")
  private String name;
  /** 年龄 */
  @ApiModelProperty(value = "年龄")
  @ExcelProperty("年龄")
  private Integer age;
  /** 性别 */
  @ApiModelProperty(value = "性别")
  @ExcelIgnore
  private String sex;
  • 默认所有字段都会和excel去匹配,使用@ExcelIgnore注解会忽略该字段。

  • @ExcelProperty:指定当前字段对应 excel 中的那一列。可以根据名字或者Index去匹配,默认第一个字段就是index=0,以此类推。⚠️要么全部不写,要么全部用index,要么全部用名字去匹配,切勿混合使用。

导出方法:

大批量文件下载到本地,此时也是逐步的追加数据。

public void export() {
        // 生成excel初始文件
        String filePath = "/tmp/" + UUID.randomUUID().toString().replace("-", "") + ".xlsx";
        ExcelWriterBuilder writeBuilder =
                EasyExcel.write(filePath).excelType(ExcelTypeEnum.XLSX).head(OrderExportVO.class).autoCloseStream(true);
        ExcelWriter writer = writeBuilder.build();
        WriteSheet sheet = EasyExcel.writerSheet().build();

        // 分页写入所有数据到EXCEL
        try {
            long cursorId = 0L;
            while (true) {
                //分页查询
                LambdaQueryWrapper<OrderTestPO> queryWrapper = new LambdaQueryWrapper<OrderTestPO>()
                        .gt(OrderTestPO::getOrderId, cursorId)
                        .orderByAsc(OrderTestPO::getOrderId)
                        .last(" LIMIT 1000 ");
                List<OrderTestPO> rows = orderTestMapper.selectList(queryWrapper);
                List<OrderExportVO> voList = OrderExportVO.from(rows);
                if (CollectionUtils.isEmpty(voList)) {
                    break;
                }
                //流式追加
                writer.write(voList, sheet);
                cursorId = rows.get(rows.size() - 1).getOrderId();
            }
        } finally {
            writer.finish();
        }
    }

下载到response对象:


  @Override
  public void export(HttpServletResponse response) {
      List<Export> list = new ArrayList<>();
        for (int i = 1; i <= 3; i++) {
            Export export = new Export(i,"张三","20");
            list.add(export);
        }
      try {
          //HttpServletResponse消息头参数设置
          response.setCharacterEncoding("UTF-8");
          response.setHeader("Content-Transfer-Encoding", "binary");
          response.setHeader("Cache-Control", "must-revalidate, post-check=0, pre-check=0");
          response.setHeader("Pragma", "public");
          response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=UTF-8");
          String fileName = "导出列表"+ ".xlsx";
          fileName = new String(fileName.getBytes(), "ISO-8859-1");
          response.setHeader("Content-Disposition", "attachment;filename=" + fileName );
          EasyExcel.write(response.getOutputStream(), Export.class)
              .autoCloseStream(Boolean.FALSE)
              .sheet("导出列表")
              .doWrite(list);
      } catch (Exception e) {
          e.printStackTrace();
      }

配置实现

假设我们不想为类上加注解,而是希望在配置/数据库中维护一个Map对象。运行时只需要修改配置/数据库,就可以实现数据导出为excel。

列配置字段:

@Data
public class DownLoadColumnBO {

    /**
     * 列名(汉字)
     */
    private String columnName;

    /**
     * 字段列
     */
    private String columnValue;
    /**
     * 时间格式化
     * 例如:yyyy-MM-dd HH:mm:ss
     */
    private String dateFormatter;

    /**
     * 枚举或者常量,处理列表返回数据,但是却展示汉字
     */
    private List<MappingInfo> mappingInfos;

    @Data
    public static class MappingInfo {
        /**
         * 文件中的值
         */
        private String name;

        /**
         * 列表中的值
         */
        private String value;
    }
}

工具类:

@Service
public class DownLoadConvert {

    /**
     *
     * @param datas 数据对象 key-字段名,vlue-字段值
     * @param downLoadColumnBOS 下载列的配置(动态读取到配置)
     * @return excel的字节流
     */
    public byte[] export(List<Map<String, Object>> datas, List<DownLoadColumnBO> downLoadColumnBOS) {
        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        ExcelWriter writer = EasyExcelFactory.write(stream).build();
        writeExcelAll(writer, datas, downLoadColumnBOS);
        writer.finish();
        return stream.toByteArray();
    }

    public void writeExcelAll(ExcelWriter writer, List<Map<String, Object>> datas, List<DownLoadColumnBO> downLoadColumnBOS) {
        //数据查询
        String sheetName = "sheet";
        WriteSheet writeSheet = EasyExcelFactory
                .writerSheet(sheetName)
                .head(getHeader(downLoadColumnBOS))
                .build();
        List<List<Object>> objListList = datas.stream()
                .map(d -> resolveData(downLoadColumnBOS, d))
                .collect(Collectors.toList());
        writer.write(objListList, writeSheet);
    }


    private static <T> List<Object> resolveData(List<DownLoadColumnBO> downLoadColumnBOS, Map<String, Object> data) {
        try {
            List<Object> objectList = new ArrayList<>();
            for (DownLoadColumnBO downLoadColumnBO : downLoadColumnBOS) {
                String columnValue = downLoadColumnBO.getColumnValue();
                Object o = data.get(columnValue);
                if (o == null) {
                    objectList.add("");
                    continue;
                }

                if (StringUtils.isNotBlank(downLoadColumnBO.getDateFormatter())) {
                    if (o.equals(0L)) {
                        objectList.add("");
                        continue;
                    }
                    o = new SimpleDateFormat(downLoadColumnBO.getDateFormatter()).format(new Date((long) o));
                }
                //当配置不为空的时候
                if (CollectionUtils.isNotEmpty(downLoadColumnBO.getMappingInfos())) {
                    Map<String, String> value2Mapping =
                            downLoadColumnBO.getMappingInfos().stream()
                                    .collect(Collectors.toMap(DownLoadColumnBO.MappingInfo::getValue, DownLoadColumnBO.MappingInfo::getName));
                    o = value2Mapping.getOrDefault((String) o, (String) o);
                }
                objectList.add(o);
            }
            return objectList;
        } catch (Exception e) {
            return Collections.emptyList();
        }
    }

    private List<List<String>> getHeader(List<DownLoadColumnBO> downLoadColumnBOS) {
        //若没有查询到列名
        if (CollectionUtils.isEmpty(downLoadColumnBOS)) {
            throw new RuntimeException("未配置excel标头");
        }
        return downLoadColumnBOS.stream().map(DownLoadColumnBO::getColumnName)
                .map(Collections::singletonList)
                .collect(Collectors.toList());
    }
}

文章参考

HSSF、XSSF和SXSSF区别以及Excel导出优化

使用easyexcel快速导出xlsx表格(简洁、高效、易懂)

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

推荐阅读更多精彩内容