EasyExcel 整合 SpringBoot :EasyExcel 填充数据实操展示
ztj100 2024-11-05 13:27 15 浏览 0 评论
- 官方演示地址:https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/fill/FillTest.java
- 官方文档演示:填充Excel | Easy Excel 官网 (alibaba.com)
一、前提准备
温馨提示:本文撰写时 alibaba/easyexcel 版本为 4.0.1 ,本文的版本已足够演示填充数据所涵盖的演示操作演示。
(1)引入maven依赖
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.22</version>
</dependency>
<!-- easy excel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.2</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
(2)代码准备
定义一个业务实体对象
@Data
@Builder
class Student {
/** 成绩 */
private String name;
/** 年龄 */
private Integer age;
/** 分数 */
private Double score;
/** 考试日期 */
private LocalDate testDate;
}
定义一个数据集合方法
private static List<Student> data(int dataTotal) {
List<Student> students = new ArrayList<>();
students.add(Student.builder().name("Allen").age(23).score(85.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("Bob").age(23).score(55.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("诸葛亮").age(73).score(95.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("孙悟空").age(523).score(85.5).testDate(LocalDate.now()).build());
for (int i = 0; i < dataTotal; i++) {
students.add(Student.builder().name("孙悟空" + i).age(10 + i).score(60D + i).testDate(LocalDate.now()).build());
}
return students;
}
二、EasyExcel 整合 SpringBoot
注意每个使用方法的 版本,有些用法会再不同的版本上存在差异,具体根据项目中引入的 easyexcel 版本确定使用调整即可。
(1)简单填充
填充模板示例
填充结果示例
完整演示源码
public static void testFillSimple() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
String templateFileName = fileDir + "simple.xlsx";
// 方案1 根据对象填充
String fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
Student student = Student.builder().name("Bob").age(23).score(96.5).testDate(LocalDate.now()).build();
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(student);
// 方案2 根据Map填充
fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
Map<String, Object> map = MapUtils.newHashMap();
map.put("name", "张三");
map.put("age", 25);
map.put("score", 99.9);
map.put("testDate", LocalDate.now().plusDays(1));
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(map);
}
(2)填充列表数据
excel 模板
填充完成
演示完整源码
public static void testFillListDate() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// 填充list 的时候还要注意 模板中{.} 多了个点 表示list
// 如果填充list的对象是map,必须包涵所有list的key,哪怕数据为null,必须使用map.put(key,null)
String templateFileName = fileDir + "list.xlsx";
// 方案1 一下子全部放到内存里面 并填充
String fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(data(4));
// 方案2 分多次 填充 会使用文件缓存(省内存)
fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
excelWriter.fill(data(3), writeSheet);
}
}
(3)复杂混合填充
填充模板demo
填充结果示例
完整演示代码
public static void testFillComplexData() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量
String templateFileName = fileDir + "complex.xlsx";
String fileName = fileDir + "complexFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
// 这里注意 入参用了forceNewRow 代表在写入list的时候不管list下面有没有空行 都会创建一行,然后下面的数据往后移动。默认 是false,会直接使用下一行,如果没有则创建。
// forceNewRow 如果设置了true,有个缺点 就是他会把所有的数据都放到内存了,所以慎用
// 简单的说 如果你的模板有list,且list不是最后一行,下面还有数据需要填充 就必须设置 forceNewRow=true 但是这个就会把所有数据放到内存 会很耗内存
// 如果数据量大 list不是最后一行 参照下一个
FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
// 填充一次
excelWriter.fill(data(2), fillConfig, writeSheet);
// 填充两次
excelWriter.fill(data(3), fillConfig, writeSheet);
Map<String, Object> map = MapUtils.newHashMap();
map.put("date", "2019年10月9日13:28:28");
map.put("total", 1000);
excelWriter.fill(map, writeSheet);
}
}
(4)横向填充
填充模板demo
填充结果示例
完整演示代码
public static void horizontalFill() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量
String templateFileName = fileDir + "horizontal.xlsx";
String fileName = fileDir + "horizontalFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
excelWriter.fill(data(2), fillConfig, writeSheet);
excelWriter.fill(data(1), fillConfig, writeSheet);
Map<String, Object> map = new HashMap<>();
map.put("date", "2024年07月19日 10:31:30");
excelWriter.fill(map, writeSheet);
}
}
(5)多列表横向竖向填充展示
填充模板 demo
填充结果
完整代码
public static void testCompositeFill() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量 {前缀.} 前缀可以区分不同的list
String templateFileName = fileDir + "composite.xlsx";
String fileName = fileDir+ "compositeFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
// 如果有多个list 模板上必须有{前缀.} 这里的前缀就是 data1,然后多个list必须用 FillWrapper包裹
excelWriter.fill(new FillWrapper("data1", data(1)), fillConfig, writeSheet);
excelWriter.fill(new FillWrapper("data2", data(2)), writeSheet);;
Map<String, Object> map = new HashMap<>();
map.put("date", LocalDate.now());
excelWriter.fill(map, writeSheet);
}
}
三、上述演示汇总代码展示
汇总上述演示代码情况,用于更加完整的展示和清楚使用的情况。有整体的观摩了解!
package com.example.demo;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.enums.WriteDirectionEnum;
import com.alibaba.excel.util.MapUtils;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.alibaba.excel.write.metadata.fill.FillWrapper;
import lombok.Builder;
import lombok.Data;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* easy excel 填充模板 演示示例
*
* @author drew
* @date 2024/7/19 上午9:40
*/
public class EasyExcelFillExcelTemplateTests {
/** 演示文件存放目录 */
private static final String fileDir = "D:/";
public static void main(String[] args) {
//testFillSimple();// 简单数据填充演示
//testFillListDate();// 列表数据填充演示
//testFillComplexData();// 复杂混合填充
//horizontalFill();// 横向填充
//testCompositeFill();// 多列表横向竖向混合填充
}
public static void testFillSimple() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
String templateFileName = fileDir + "simple.xlsx";
// 方案1 根据对象填充
String fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
Student student = Student.builder().name("Bob").age(23).score(96.5).testDate(LocalDate.now()).build();
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(student);
// 方案2 根据Map填充
fileName = fileDir + "simpleFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
Map<String, Object> map = MapUtils.newHashMap();
map.put("name", "张三");
map.put("age", 25);
map.put("score", 99.9);
map.put("testDate", LocalDate.now().plusDays(1));
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(map);
}
public static void testFillListDate() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// 填充list 的时候还要注意 模板中{.} 多了个点 表示list
// 如果填充list的对象是map,必须包涵所有list的key,哪怕数据为null,必须使用map.put(key,null)
String templateFileName = fileDir + "list.xlsx";
// 方案1 一下子全部放到内存里面 并填充
String fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
// 这里 会填充到第一个sheet, 然后文件流会自动关闭
EasyExcel.write(fileName).withTemplate(templateFileName).sheet().doFill(data(4));
// 方案2 分多次 填充 会使用文件缓存(省内存)
fileName = fileDir + "listFill" + System.currentTimeMillis() + ".xlsx";
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
excelWriter.fill(data(3), writeSheet);
}
}
public static void testFillComplexData() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量
String templateFileName = fileDir + "complex.xlsx";
String fileName = fileDir + "complexFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
// 这里注意 入参用了forceNewRow 代表在写入list的时候不管list下面有没有空行 都会创建一行,然后下面的数据往后移动。默认 是false,会直接使用下一行,如果没有则创建。
// forceNewRow 如果设置了true,有个缺点 就是他会把所有的数据都放到内存了,所以慎用
// 简单的说 如果你的模板有list,且list不是最后一行,下面还有数据需要填充 就必须设置 forceNewRow=true 但是这个就会把所有数据放到内存 会很耗内存
// 如果数据量大 list不是最后一行 参照下一个
FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
// 填充一次
excelWriter.fill(data(2), fillConfig, writeSheet);
// 填充两次
excelWriter.fill(data(3), fillConfig, writeSheet);
Map<String, Object> map = MapUtils.newHashMap();
map.put("date", "2019年10月9日13:28:28");
map.put("total", 1000);
excelWriter.fill(map, writeSheet);
}
}
public static void horizontalFill() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量
String templateFileName = fileDir + "horizontal.xlsx";
String fileName = fileDir + "horizontalFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
excelWriter.fill(data(2), fillConfig, writeSheet);
excelWriter.fill(data(1), fillConfig, writeSheet);
Map<String, Object> map = new HashMap<>();
map.put("date", "2024年07月19日 10:31:30");
excelWriter.fill(map, writeSheet);
}
}
public static void testCompositeFill() {
// 模板注意 用{} 来表示你要用的变量 如果本来就有"{","}" 特殊字符 用"\{","\}"代替
// {} 代表普通变量 {.} 代表是list的变量 {前缀.} 前缀可以区分不同的list
String templateFileName = fileDir + "composite.xlsx";
String fileName = fileDir+ "compositeFill" + System.currentTimeMillis() + ".xlsx";
// 方案1
try (ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(templateFileName).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet().build();
FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
// 如果有多个list 模板上必须有{前缀.} 这里的前缀就是 data1,然后多个list必须用 FillWrapper包裹
excelWriter.fill(new FillWrapper("data1", data(1)), fillConfig, writeSheet);
excelWriter.fill(new FillWrapper("data2", data(2)), writeSheet);;
Map<String, Object> map = new HashMap<>();
map.put("date", LocalDate.now());
excelWriter.fill(map, writeSheet);
}
}
private static List<Student> data(int dataTotal) {
List<Student> students = new ArrayList<>();
students.add(Student.builder().name("Allen").age(23).score(85.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("Bob").age(23).score(55.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("诸葛亮").age(73).score(95.5).testDate(LocalDate.now()).build());
students.add(Student.builder().name("孙悟空").age(523).score(85.5).testDate(LocalDate.now()).build());
for (int i = 0; i < dataTotal; i++) {
students.add(Student.builder().name("孙悟空" + i).age(10 + i).score(60D + i).testDate(LocalDate.now()).build());
}
return students;
}
}
@Data
@Builder
class Student {
/** 成绩 */
private String name;
/** 年龄 */
private Integer age;
/** 分数 */
private Double score;
/** 考试日期 */
private LocalDate testDate;
}
附录
- 官方文档演示:填充Excel | Easy Excel 官网
- EasyExcel 开源地址:GitHub - alibaba/easyexcel: 快速、简洁、解决大文件内存溢出的java处理Excel工具
如果对你有帮助花,还起感谢 点赞收藏分享 哦
相关推荐
- Vue 技术栈(全家桶)(vue technology)
-
Vue技术栈(全家桶)尚硅谷前端研究院第1章:Vue核心Vue简介官网英文官网:https://vuejs.org/中文官网:https://cn.vuejs.org/...
- vue 基础- nextTick 的使用场景(vue的nexttick这个方法有什么用)
-
前言《vue基础》系列是再次回炉vue记的笔记,除了官网那部分知识点外,还会加入自己的一些理解。(里面会有部分和官网相同的文案,有经验的同学择感兴趣的阅读)在开发时,是不是遇到过这样的场景,响应...
- vue3 组件初始化流程(vue组件初始化顺序)
-
学习完成响应式系统后,咋们来看看vue3组件的初始化流程既然是看vue组件的初始化流程,咋们先来创建基本的代码,跑跑流程(在app.vue中写入以下内容,来跑流程)...
- vue3优雅的设置element-plus的table自动滚动到底部
-
场景我是需要在table最后添加一行数据,然后把滚动条滚动到最后。查网上的解决方案都是读取html结构,暴力的去获取,虽能解决问题,但是不喜欢这种打补丁的解决方案,我想着官方应该有相关的定义,于是就去...
- Vue3为什么推荐使用ref而不是reactive
-
为什么推荐使用ref而不是reactivereactive本身具有很大局限性导致使用过程需要额外注意,如果忽视这些问题将对开发造成不小的麻烦;ref更像是vue2时代optionapi的data的替...
- 9、echarts 在 vue 中怎么引用?(必会)
-
首先我们初始化一个vue项目,执行vueinitwebpackechart,接着我们进入初始化的项目下。安装echarts,npminstallecharts-S//或...
- 无所不能,将 Vue 渲染到嵌入式液晶屏
-
该文章转载自公众号@前端时刻,https://mp.weixin.qq.com/s/WDHW36zhfNFVFVv4jO2vrA前言...
- vue-element-admin 增删改查(五)(vue-element-admin怎么用)
-
此篇幅比较长,涉及到的小知识点也比较多,一定要耐心看完,记住学东西没有耐心可不行!!!一、添加和修改注:添加和编辑用到了同一个组件,也就是此篇文章你能学会如何封装组件及引用组件;第二能学会async和...
- 最全的 Vue 面试题+详解答案(vue面试题知识点大全)
-
前言本文整理了...
- 基于 vue3.0 桌面端朋友圈/登录验证+60s倒计时
-
今天给大家分享的是Vue3聊天实例中的朋友圈的实现及登录验证和倒计时操作。先上效果图这个是最新开发的vue3.x网页端聊天项目中的朋友圈模块。用到了ElementPlus...
- 不来看看这些 VUE 的生命周期钩子函数?| 原力计划
-
作者|huangfuyk责编|王晓曼出品|CSDN博客VUE的生命周期钩子函数:就是指在一个组件从创建到销毁的过程自动执行的函数,包含组件的变化。可以分为:创建、挂载、更新、销毁四个模块...
- Vue3.5正式上线,父传子props用法更丝滑简洁
-
前言Vue3.5在2024-09-03正式上线,目前在Vue官网显最新版本已经是Vue3.5,其中主要包含了几个小改动,我留意到日常最常用的改动就是props了,肯定是用Vue3的人必用的,所以针对性...
- Vue 3 生命周期完整指南(vue生命周期及使用)
-
Vue2和Vue3中的生命周期钩子的工作方式非常相似,我们仍然可以访问相同的钩子,也希望将它们能用于相同的场景。...
- 救命!这 10 个 Vue3 技巧藏太深了!性能翻倍 + 摸鱼神器全揭秘
-
前端打工人集合!是不是经常遇到这些崩溃瞬间:Vue3项目越写越卡,组件通信像走迷宫,复杂逻辑写得脑壳疼?别慌!作为在一线摸爬滚打多年的老前端,今天直接甩出10个超实用的Vue3实战技巧,手把...
- 怎么在 vue 中使用 form 清除校验状态?
-
在Vue中使用表单验证时,经常需要清除表单的校验状态。下面我将介绍一些方法来清除表单的校验状态。1.使用this.$refs...
你 发表评论:
欢迎- 一周热门
- 最近发表
-
- Vue 技术栈(全家桶)(vue technology)
- vue 基础- nextTick 的使用场景(vue的nexttick这个方法有什么用)
- vue3 组件初始化流程(vue组件初始化顺序)
- vue3优雅的设置element-plus的table自动滚动到底部
- Vue3为什么推荐使用ref而不是reactive
- 9、echarts 在 vue 中怎么引用?(必会)
- 无所不能,将 Vue 渲染到嵌入式液晶屏
- vue-element-admin 增删改查(五)(vue-element-admin怎么用)
- 最全的 Vue 面试题+详解答案(vue面试题知识点大全)
- 基于 vue3.0 桌面端朋友圈/登录验证+60s倒计时
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- node卸载 (33)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- exceptionininitializererror (33)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)