SpringBoot实现导出Excel功能

这篇具有很好参考价值的文章主要介绍了SpringBoot实现导出Excel功能。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

SpringBoot实现导出Excel功能

1 问题背景

需求要做一个导出excel的功能

2 前言

  1. 本篇着重阐述后端怎么实现,前端实现的部分只会粗略阐述。该实现方案是经过生产环境考验的,不是那些拿来练手的小demo。本文阐述的方案可以借鉴用来做毕设或者加到自己玩的项目中去。
  2. 再次声明,本文是百万级数据量的企业级解决方案,不是学校里面的毕设或者自己搭环境玩玩的小demo。客户不会去一页一页地点击导出,本文阐述的是一键导出几千行甚至上万行的数据。如果本文与你了解到的方案有出入可以在评论区交流,像那种导出几行或十来行的方案就不要说了。
  3. 有读者在评论里提问“请教百万行能撑住吗?”笔者没有去验证,有兴趣或者有疑问的读者可以去验证下,本文的解决方案是导出几千或上万行数据。本文也只是想介绍电商生产环境中真实的需求以及真实的解决方案,如果要导出百万行,那就只能采用异步方式去进行导出了,文末有提供思路。

3 实现思路

  1. 后端查询要导出的数据,此处简称data
  2. 使用阿里的EasyExcel组件将data写到HttpServletResponse里面,返回指定的响应头、响应内容的类型、字符编码。响应出去的数据是二进制数据,此处简称bytes数据
  3. 前端使用前端框架提供的方法,将 bytes数据转成blob,然后生成下载地址,然后进行下载

4 后端实现

要引入阿里的EasyExcel依赖,此处不赘述

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

下面是excel文件要保存的信息,需要指定列头

@Data
public class UserInfoVO {
  @ExcelProperty(value = "用户ID",index = 0)
  private Long id;
  @ExcelProperty(value = "用户姓名",index = 1)
  private String username;
  @ExcelProperty(value = "性别",index = 2)
  private String sex;
}

导出的伪代码如下:

  @PostMapping("/xx/xxx/xxx")
  public void export(HttpServletResponse reponse) {
        // 设置响应头等
        response.setHeader("Content-Disposition", "attachment;filename=" + "文件名(随便定义).xlsx");
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("UTF-8");

        // 查数据,假如要导出UserInfo的列表信息
        List<UserInfoVO> data = selectData();
       // 导出数据 
       EasyExcel.write(response.getOutputStream()).head(UserInfoVO.class).sheet().doWrite(data);
  }

5 设置Excel自适应列宽

思路:实现easyexcel提供的类并重写方法,写数据到HttpServletReponse的时候注册一个自适应列宽的bean

实现AbstractColumnWidthStyleStrategy类,如下所示:

public class CustomCellWriteWeightConfig extends AbstractColumnWidthStyleStrategy {

    private Map<Integer, Map<Integer, Integer>> CACHE = new HashMap<>();

    @Override
    protected void setColumnWidth(WriteSheetHolder writeSheetHolder, List<CellData> cellDataList, Cell cell, Head head, Integer integer, Boolean isHead) {
        boolean needSetWidth = isHead || !CollectionUtils.isEmpty(cellDataList);
        if (needSetWidth) {
            Map<Integer, Integer> maxColumnWidthMap = CACHE.get(writeSheetHolder.getSheetNo());
            if (maxColumnWidthMap == null) {
                maxColumnWidthMap = new HashMap<>();
                CACHE.put(writeSheetHolder.getSheetNo(), maxColumnWidthMap);
            }

            Integer columnWidth = this.dataLength(cellDataList, cell, isHead);
            if (columnWidth >= 0) {
                if (columnWidth > 254) {
                    columnWidth = 254;
                }

                Integer maxColumnWidth = maxColumnWidthMap.get(cell.getColumnIndex());
                if (maxColumnWidth == null || columnWidth > maxColumnWidth) {
                    maxColumnWidthMap.put(cell.getColumnIndex(), columnWidth);
                    Sheet sheet = writeSheetHolder.getSheet();
                    sheet.setColumnWidth(cell.getColumnIndex(), columnWidth * 256);
                }

            }
        }
    }

    /**
     * 计算长度
     * @param cellDataList
     * @param cell
     * @param isHead
     * @return
     */
    private Integer dataLength(List<CellData> cellDataList, Cell cell, Boolean isHead) {
        if (isHead) {
            return cell.getStringCellValue().getBytes().length;
        } else {
            CellData cellData = cellDataList.get(0);
            CellDataTypeEnum type = cellData.getType();
            if (type == null) {
                return -1;
            } else {
                switch (type) {
                    case STRING:
                        // 换行符(数据需要提前解析好)
                        int index = cellData.getStringValue().indexOf("\n");
                        return index != -1 ?
                                cellData.getStringValue().substring(0, index).getBytes().length + 1 : cellData.getStringValue().getBytes().length + 1;
                    case BOOLEAN:
                        return cellData.getBooleanValue().toString().getBytes().length;
                    case NUMBER:
                        return cellData.getNumberValue().toString().getBytes().length;
                    default:
                        return -1;
                }
            }
        }
    }
}

注册自适应列宽的组件:

EasyExcel.write(response.getOutputStream())
                    .head(SubscriptionOrderExportResp.class)
                    //  注册自适应列宽组件
                    .registerWriteHandler(new CustomCellWriteWeightConfig())
                    .sheet()
                    .doWrite(data);

6 方案优缺点

优点:实现简单,轻量级。能快速迭代上线 。

缺点:使用了同步方式返回数据,如果excel文件的数据量很多,那么将耗费很多时间,甚至http连接已经断开了还未响应出去。

改进:本文解决方案是采用了同步方式导出,实时返回excel文件。可以做一个异步方式,后端创建一个任务异步生成excel文件,然后文件上传到对象存储服务器。前端轮询任务是否完成,后端返回文件地址给前端下载。文章来源地址https://www.toymoban.com/news/detail-430302.html

到了这里,关于SpringBoot实现导出Excel功能的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 接了个变态需求:生成 Excel + PDF 导出,用 Java 怎么实现?

    Excel、PDF的导出、导入是我们工作中经常遇到的一个问题,刚好今天公司业务遇到了这个问题,顺便记个笔记以防下次遇到相同的问题而束手无策。 公司有这么两个需求: 需求一 、给了一个表单,让把查出来的数据组装到表单中并且提供以PDF格式的下载功能。 需求二、  将

    2024年02月20日
    浏览(43)
  • 【Go】excelize库实现excel导入导出封装(一),自定义导出样式、隔行背景色、自适应行高、动态导出指定列、动态更改表头

    最近在学go操作excel,毕竟在web开发里,操作excel是非常非常常见的。这里我选择用 excelize 库来实现操作excel。 为了方便和通用,我们需要把导入导出进行封装,这样以后就可以很方便的拿来用,或者进行扩展。 我参考的是这篇文章:【GO】excelize导入导出封装 这个导入导出封

    2024年02月04日
    浏览(49)
  • vue 实现导出 Excel功能

    例如,创建一个文件夹命名为 utils ,再创建一个导出Excel的js文件 exportExcel.js 当渲染的table数据中有操作按钮或者有一些不需要的字段的话,可以写一个打印模板,用作导出Excel功能

    2024年02月12日
    浏览(37)
  • springboot实现导出excel

    添加maven依赖 编写要导出的类 去数据库查询要导出的数据 调用接口导出数据 实操测试 点击链接会实现导出excel的功能 http://162.14.107.118:8086/PC/exportExcelAddMoney

    2024年02月10日
    浏览(42)
  • EasyExcel实现Excel文件导入导出功能

    Java领域解析、生成Excel比较有名的框架有Apache poi、jxl等。但他们都存在一个严重的问题就是非常的耗内存。如果你的系统并发量不大的话可能还行,但是一旦并发上来后一定会OOM或者JVM频繁的full gc。 EasyExcel是阿里巴巴开源的一个excel处理框架,以使用简单、节省内存著称。

    2024年02月02日
    浏览(68)
  • SpringBoot实现Excel导入导出

    话不多说,直接上代码 依赖文档 找到pom文件,如下图所示 引入需要的依赖 导出写法: 导入写法: 已上就是导入导出

    2024年02月09日
    浏览(42)
  • springboot项目实现excel导出

    项目中经常会有列表查询,然后导出excel的功能,以下是其中一种方法,简单写个Demo ,先看项目结构: pom.xml 其他依赖就不提了,主要就只这个依赖org.apache.poi.poi-ooxml 说明: poi是Apache旗下的一个开源项目,由Apache官方维护,poi有两个不同的jar包,分别是处理excel2003和excel2

    2024年02月08日
    浏览(50)
  • 使用vue实现导出Excel功能【纯前端】

    最近接手一个项目,其中一个需求是将查询出来table中的数据导出为Excel文件,并下载到本地。 问题来了,这种东西,不是应该后端去实现更好一些吗?如果放在前端做,要拿到全部数据,然后把这些数据进行解析,再进行一系列的骚操作转化成Excel文件,假如数据量少还好,

    2024年02月10日
    浏览(44)
  • 【Java】百万数据excel导出功能如何实现

    人不走空                                                                          目录         🌈个人主页:人不走空       💖系列专栏:算法专题 ⏰诗词歌赋:斯是陋室,惟吾德馨 前言 1.异步处理 1.1 使用job 1.2 使用mq 2.使用easyexcel 3.分页查询 4.多个she

    2024年02月20日
    浏览(60)
  • Vue前端实现excel的导入、导出、打印功能

    导入导出依赖: npm install xlsx@0.16.9 npm install xlsx-style@0.8.13 --save 安装xlsx-style,运行报错 This relative module was not found: ./cptable in ./node_modules/xlsx-style@0.8.13@xlsx-style/dist/cpexcel.js 解决报错 在node_modulesxlsx-styledistcpexcel.js 807行 的 var cpt = require(\\\'./cpt\\\' + \\\'able\\\'); 改为: var cpt = cptable; 打印

    2023年04月08日
    浏览(47)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包