AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

EasyExcel的简单使用

2021-12-14 1356
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
数据可视化DataV，5个大屏 1个月
可视分析地图（DataV-Atlas），3 个项目，100M 存储空间
简介： EasyExcel的简单使用，以及如何通过postman进行导入导出功能的调试

1.基本介绍


EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。


依赖

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


2.简单的导出一个excel


对象

importcom.alibaba.excel.annotation.ExcelProperty;
importcom.alibaba.excel.annotation.format.DateTimeFormat;
importcom.alibaba.excel.annotation.write.style.ColumnWidth;
@DatapublicclassDemoExcel {
@ExcelProperty(value= {"数字"}, index=0)
@ColumnWidth(20)
privateDoubledoubleData;
@ExcelProperty(value= {"字符"}, index=1)
@ColumnWidth(20)
privateStringstring;
/*** 自定义的时间格式*/@DateTimeFormat("yyyy年MM月dd日 HH:mm:ss")
@ExcelProperty(value= {"时间"}, index=2)
@ColumnWidth(30)
privateDatedate;
}


Controller

importcom.alibaba.excel.EasyExcel;
@GetMapping("/download")
publicvoiddownload(HttpServletResponseresponse) {
// 模拟从数据库查询数据，不一定要转成demoExcel对象，只要字段能对应上就行List<DemoExcel>list=getList();
try {
// 导出数据response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
StringfileName=URLEncoder.encode(StringUtils.join(System.currentTimeMillis(), "_", "downloadExcel"), "UTF-8");
response.setHeader("Content-disposition", "attachment;filename="+fileName+".xlsx");
EasyExcel.write(response.getOutputStream(), DemoExcel.class).sheet("sheet1")
            .doWrite(list);
    } catch (Exceptione) {
log.debug("导出文件失败:{}", e.getMessage());
thrownewRuntimeException("导出文件失败");
    }
}


使用postman调试

点击send and download就能下载到excel

如果excel打不开，报错，多半是抛异常了，可以右键用记事本打开看到返回的json，也可以直接点一下send再调一次接口直接看到报错信息


3.简单的导入一个excel

对象

importcom.alibaba.excel.annotation.ExcelProperty;
importcom.alibaba.excel.annotation.format.DateTimeFormat;
importcom.alibaba.excel.annotation.write.style.ColumnWidth;
@DatapublicclassDemoExcel {
@ExcelProperty(value= {"数字"}, index=0)
@ColumnWidth(20)
privateDoubledoubleData;
@ExcelProperty(value= {"字符"}, index=1)
@ColumnWidth(20)
privateStringstring;
/*** 自定义的时间格式*/@DateTimeFormat("yyyy年MM月dd日 HH:mm:ss")
@ExcelProperty(value= {"时间"}, index=2)
@ColumnWidth(30)
privateDatedate;
}


监听

importcom.alibaba.excel.context.AnalysisContext;
importcom.alibaba.excel.event.AnalysisEventListener;
@Data@Slf4jpublicclassDemoDataListenerextendsAnalysisEventListener<DemoExcel> {
privateList<DemoExcel>list=newArrayList();
@Overridepublicvoidinvoke(DemoExceldata, AnalysisContextcontext) {
// 这里取到的data就是单独的一行数据，也可以在这个方法里对数据进行一些简单的处理list.add(data);
 }
@OverridepublicvoiddoAfterAllAnalysed(AnalysisContextcontext) {
// 这个方法是在excel解析完成后能对数据进行操作，也能在这里对数据进行各种处理log.info("获取数据量："+list.size());
 }
}

Controller

importcom.alibaba.excel.EasyExcel;
@PostMapping("/upload")
publicvoidupload(@RequestParam("file") MultipartFilefile) throwsIOException {
DemoDataListenerlistener=newDemoDataListener();
//headRowNumber(1)从第二行读数据//sheet()默认读第一个sheet页,当然想读第二页就往里填个1EasyExcel.read(file.getInputStream(), DemoExcel.class, listener).sheet().headRowNumber(1).doRead();
List<DemoExcel>list=listener.getList();
// 我们取到了excel中的数据后就能用来进行想要的操作了list.forEach(s-> {
log.info("读取到数据------"+s);
    });
}



使用postman调试

我还是用刚才导出来的那个文件进行一次导入

postman向上面这样设置就能进行导入文件了

控制台的日志告诉我取到了这个数组


4.导出的excel要自带下拉框,以及多个sheet页的导出


Controller

importcom.alibaba.excel.EasyExcel;
importcom.alibaba.excel.ExcelWriter;
importcom.alibaba.excel.write.metadata.WriteSheet;
importcom.alibaba.excel.write.metadata.WriteTable;
@GetMapping("/download/default")
publicvoiddownloadDefault(HttpServletResponseresponse) {
try {
// 导出数据response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系StringfileName=URLEncoder.encode(StringUtils.join(System.currentTimeMillis(), "_", "downloadExcel"), "UTF-8");
response.setHeader("Content-disposition", "attachment;filename="+fileName+".xlsx");
ExcelWriterwriter=EasyExcel.write(response.getOutputStream()).build();
// 预设值List<DefaultData>defaultData=getDefault();
// 设置第1个sheet为我们的模版 同时设置一个下拉框// 把sheet设置为不需要头 不然会输出sheet的头 这样看起来第一个table 就有2个头了WriteSheetwriteSheet=EasyExcel.writerSheet(0,"模板").needHead(false)
            .registerWriteHandler(newCustomSheetWriteHandler(defaultData))
            .build();
// 填写表单的表头WriteTablewriteTable0=EasyExcel.writerTable(0).needHead(true).build();
writeTable0.setClazz(DemoExcel.class);
writer.write(Lists.newArrayList(), writeSheet, writeTable0);
// 根据预设值的pid整理一下List<DemoDefaultExcel>defaultExcelList=getFormDataList(defaultData);
// 设置第2个sheet为字段可选范围 ,把可以选择的范围列出来，没有也没事WriteSheetwriteDefaultDataSheet=EasyExcel.writerSheet(1,"字段选填范围")
            .head(DemoDefaultExcel.class).build();
writer.write(defaultExcelList, writeDefaultDataSheet);
writer.finish();
    } catch (Exceptione) {
log.debug("导出文件失败:{}", e.getMessage());
thrownewRuntimeException("导出文件失败");
    }
}


Handler

importcom.alibaba.excel.write.handler.SheetWriteHandler;
importcom.alibaba.excel.write.metadata.holder.WriteSheetHolder;
importcom.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
importorg.apache.poi.ss.usermodel.DataValidation;
importorg.apache.poi.ss.usermodel.DataValidationConstraint;
importorg.apache.poi.ss.usermodel.DataValidationHelper;
importorg.apache.poi.ss.util.CellRangeAddressList;
publicclassCustomSheetWriteHandlerimplementsSheetWriteHandler {
privateList<DefaultData>defaultDataList;
publicCustomSheetWriteHandler(List<DefaultData>defaultDataList){
this.defaultDataList=defaultDataList;
    }
@OverridepublicvoidbeforeSheetCreate(WriteWorkbookHolderwriteWorkbookHolder, WriteSheetHolderwriteSheetHolder) {
    }
@OverridepublicvoidafterSheetCreate(WriteWorkbookHolderwriteWorkbookHolder, WriteSheetHolderwriteSheetHolder) {
// 筛选出pid为1的值，添加到第2列的下拉框中writeSheetHolder.getSheet().addValidationData(getValidationDataByPid(1L, 1, writeSheetHolder));
writeSheetHolder.getSheet().addValidationData(getValidationDataByPid(2L, 2, writeSheetHolder));
    }
privateDataValidationgetValidationDataByPid(Longpid, intcol, WriteSheetHolderwriteSheetHolder){
List<String>dataValues=defaultDataList.stream().filter(item->null!=item.getPid() &&item.getPid().equals(pid))
                .map(DefaultData::getNodeName).collect(Collectors.toList());
returngetValidationDataBySelects(writeSheetHolder, col, dataValues.toArray(newString[dataValues.size()]));
    }
privateDataValidationgetValidationDataBySelects(WriteSheetHolderwriteSheetHolder, intcol, String[] valus){
// 这里4个参数代表从第二行到第65536行，从第几列到第几列。可以根据需求增加CellRangeAddressListcellRangeAddressList=newCellRangeAddressList(1, 65535, col, col);
DataValidationHelperhelper=writeSheetHolder.getSheet().getDataValidationHelper();
DataValidationConstraintconstraint=helper.createExplicitListConstraint(valus);
DataValidationdataValidation=helper.createValidation(constraint, cellRangeAddressList);
returndataValidation;
    }
}


DefaultData.java

@DatapublicclassDefaultData {
privateLongpid;
privateStringnodeName;
}



预设值的结构是这样的


导出的文件第一页，第二列和第三列有了下拉框选项


第二页有可选范围的示范


5.导出的excel要有示例

DemoExampleExcel.java

importcom.alibaba.excel.annotation.ExcelProperty;
importcom.alibaba.excel.annotation.format.DateTimeFormat;
importcom.alibaba.excel.annotation.write.style.ColumnWidth;
importcom.alibaba.excel.annotation.write.style.ContentStyle;
importcom.alibaba.excel.annotation.write.style.HeadStyle;
importorg.apache.poi.ss.usermodel.FillPatternType;
@Data// 以注解形式设置样式// 头背景设置成黄色 IndexedColors.YELLOW.getIndex()@HeadStyle(fillPatternType=FillPatternType.SOLID_FOREGROUND, fillForegroundColor=13)
// 内容的背景设置成黄色 IndexedColors.YELLOW.getIndex()@ContentStyle(fillPatternType=FillPatternType.SOLID_FOREGROUND, fillForegroundColor=13)
publicclassDemoExampleExcel {
// 相同的表头会自动合并@ExcelProperty(value= {"示例", "示例", "数字"}, index=0)
@ColumnWidth(20)
privateDoubledoubleData;
@ExcelProperty(value= {"示例", "示例", "字符"}, index=1)
@ColumnWidth(20)
privateStringstring;
@ExcelProperty(value= {"示例", "示例", "字符2"}, index=2)
@ColumnWidth(20)
privateStringstring2;
@DateTimeFormat("yyyy年MM月dd日 HH:mm:ss")
@ExcelProperty(value= {"示例", "示例", "时间"}, index=3)
@ColumnWidth(30)
privateDatedate;
}


Controller

importcom.alibaba.excel.EasyExcel;
importcom.alibaba.excel.ExcelWriter;
importcom.alibaba.excel.write.metadata.WriteSheet;
importcom.alibaba.excel.write.metadata.WriteTable;
@GetMapping("/download/example")
publicvoiddownloadExample(HttpServletResponseresponse) {
try {
// 导出数据response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系StringfileName=URLEncoder.encode(StringUtils.join(System.currentTimeMillis(), "_", "downloadExcel"), "UTF-8");
response.setHeader("Content-disposition", "attachment;filename="+fileName+".xlsx");
ExcelWriterwriter=EasyExcel.write(response.getOutputStream()).build();
// 把sheet设置为不需要头 不然会输出sheet的头 这样看起来第一个table 就有2个头了WriteSheetwriteSheet=EasyExcel.writerSheet(0,"模板").needHead(false).build();
// 获取示例list 填写示例List<DemoExampleExcel>exampleExcels=getExampleList();
WriteTablewriteTable0=EasyExcel.writerTable(0).needHead(true).build();
writeTable0.setClazz(DemoExampleExcel.class);
writer.write(exampleExcels, writeSheet, writeTable0);
// 示例和表头间增加一栏空行writer.write(Lists.newArrayList(""), writeSheet);
// 填写表单的表头WriteTablewriteTable1=EasyExcel.writerTable(1).needHead(true).build();
writeTable1.setClazz(DemoExcel.class);
writer.write(Lists.newArrayList(), writeSheet, writeTable1);
writer.finish();
    } catch (Exceptione) {
log.debug("导出文件失败:{}", e.getMessage());
thrownewRuntimeException("导出文件失败");
    }
}


这里只列举了几种实用并且可能用的上的小功能。

更多的进阶技巧可以查看官方语雀。也欢迎大家继续补充这篇文章。

6.参考资料


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

官方语雀:https://www.yuque.com/easyexcel/doc/easyexcel

文章标签：
DataV数据可视化
Java
easyexcel
数据格式
JSON
相关实践学习
DataV Board用户界面概览
本实验带领用户熟悉DataV Board这款可视化产品的用户界面
阿里云实时数仓实战 - 项目介绍及架构设计
课程简介 1)学习搭建一个数据仓库的过程，理解数据在整个数仓架构的从采集、存储、计算、输出、展示的整个业务流程。 2)整个数仓体系完全搭建在阿里云架构上，理解并学会运用各个服务组件，了解各个组件之间如何配合联动。 3&nbsp;)前置知识要求 &nbsp; 课程大纲 第一章&nbsp;了解数据仓库概念 初步了解数据仓库是干什么的 第二章&nbsp;按照企业开发的标准去搭建一个数据仓库 数据仓库的需求是什么 架构 怎么选型怎么购买服务器 第三章&nbsp;数据生成模块 用户形成数据的一个准备 按照企业的标准，准备了十一张用户行为表 方便使用 第四章&nbsp;采集模块的搭建 购买阿里云服务器 安装 JDK 安装 Flume 第五章&nbsp;用户行为数据仓库 严格按照企业的标准开发 第六章&nbsp;搭建业务数仓理论基础和对表的分类同步 第七章&nbsp;业务数仓的搭建&nbsp; 业务行为数仓效果图&nbsp;&nbsp;
长沙-邓超
目录
相关文章
小小小林
|
6月前
|
数据可视化 前端开发 Java
简单使用Swagger
Swagger是一个用于生成、描述和可视化RESTful服务的框架，简化前后端分离开发，自动化接口文档生成，支持功能测试。Springfox是Spring中的Swagger实现。Knife4j是Java MVC的Swagger增强工具，提供更便捷的Api文档生成。使用步骤包括添加依赖、配置Docket、设置静态资源映射。常用注解如`@Api`, `@ApiOperation`, `@ApiModel`, `@ApiModelProperty`用于美化接口文档。虽然Swagger可生成接口文档，但它与设计阶段工具如Yapi互补，分别适用于开发和设计阶段。
小小小林
96 3
简单使用Swagger
nanshaws
|
25天前
|
JSON 算法 Java
hutool工具的简单使用
这篇文章介绍了Hutool工具库的基本使用，通过代码示例展示了如何利用Hutool进行字符串处理、文件操作、集合操作、加密解密、日期时间处理、网络请求和读取资源文件等常见任务。
nanshaws
24 0
hutool工具的简单使用
遇事问春风乄
|
6月前
|
安全 Java Maven
【JavaEE进阶】 SpringBoot的创建与简单使用
【JavaEE进阶】 SpringBoot的创建与简单使用
遇事问春风乄
54 0
宁在春
|
6月前
|
存储 easyexcel Java
SpringBoot整合Easyexcel操作Excel,闲暇之余，让我们学习更多
SpringBoot整合Easyexcel操作Excel,闲暇之余，让我们学习更多
宁在春
330 0
快乐阿超
|
12月前
|
JSON fastjson 数据格式
fastjson基本使用
fastjson基本使用
快乐阿超
77 0
从未止步..
|
XML Java Maven
实现springboot的简单使用~
实现springboot的简单使用~
从未止步..
38 0
是谢添啊
|
easyexcel API 数据安全/隐私保护
EasyExcel使用与详细说明，EasyExcel工具类（三）
EasyExcel使用与详细说明，EasyExcel工具类
是谢添啊
8622 0
是谢添啊
|
easyexcel
EasyExcel使用与详细说明，EasyExcel工具类（二）
EasyExcel使用与详细说明，EasyExcel工具类
是谢添啊
944 0
得过且过的勇者y
|
Java Spring
SpringBoot2.6整合Swagger2（附易踩坑点:运行报错/访问404）
一、引入依赖
得过且过的勇者y
1083 0
编程达人
|
Java Maven
Java：SpringBoot整合Knife4j（Swagger）提供接口文档
Java：SpringBoot整合Knife4j（Swagger）提供接口文档
编程达人
173 0
Java：SpringBoot整合Knife4j（Swagger）提供接口文档

热门文章

最新文章

  • 1
    阿里Java代码规约插件即将全球首发，邀您来发布仪式现场
  • 2
    淘宝 NPM 镜像
  • 3
    MySQL数据表生成ER图
  • 4
    Object reference not set to an instance of an object.
  • 5
    锐捷网络&视易K米，携手助力2016腾讯全球合作伙伴万人大会
  • 6
    WF4.0实战(九)：猜数字游戏，测下你的智力
  • 7
    数据结构复习笔记(6)
  • 8
    OutOfMemoryError与StackOverFlowError
  • 9
    Percona XtraDB Cluster 集群环境建立与验证指南
  • 10
    在没有ISA管控的时候
  • 1
    小程序数据绑定机制的优点
    22
  • 2
    小程序的 API 做了什么处理，能够做到全局变量的隐藏
    21
  • 3
    在 Babel 插件中使用 TypeScript 类型
    17
  • 4
    Kotlin - 函数与Lambda表达式
    17
  • 5
    Kotlin - 区间与数组
    15
  • 6
    Kotlin - 运算符与中缀表达式
    16
  • 7
    babel 原理，怎么写 babel 插件
    15
  • 8
    Kotlin - 面向对象之抽象类与接口
    13
  • 9
    Kotlin - 参数与异常
    12
  • 10
    Kotlin - 分支与循环
    15

    • 相关课程

    更多
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 高级应用

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第15讲】：Spring Boot 2.0 API与Spring REST Docs实战
  • Java Spring Boot开发实战系列课程【第6讲】：Spring Boot 2.0实战MyBatis与优化(Java面试题)
  • Java Spring Boot开发实战系列课程【第7讲】：Spring Boot 2.0安全机制与MVC身份验证实战(Java面试题)

    • 相关实验场景

    更多
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月