【EasyExcel实践】万能导出，一个接口导出多张表以及任意字段（可指定字段顺序）

2023-12-07 17:15
文章标签 接口 实践 指定 万能 导出 顺序 任意 easyexcel 张表

本文主要是介绍【EasyExcel实践】万能导出，一个接口导出多张表以及任意字段（可指定字段顺序），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 前言
  • 正文
    • 一、POM依赖
    • 二、核心Java文件
      • 2.1 自定义表头注解 ExcelColumnTitle
      • 2.2 自定义标题头的映射接口
      • 2.3 自定义有序map存储表内数据
      • 2.4 表头工厂
      • 2.5 表flag和表头映射枚举
      • 2.6 测试用的实体
        • 2.6.1 NameAndFactoryDemo
        • 2.6.2 StudentDemo
      • 2.7 启动类
      • 2.8 测试控制器
    • 三、测试
      • 测试1
      • 测试2
      • 测试3
      • 测试4

前言

日前，看到一个比较奇怪的导出功能。

需要根据不同的页面，以及指定不同的字段列表（任意顺序），然后导出对应的表格。

先假设一个场景：
假如你的系统有多个列表展示页，每页中可以依据筛选条件，调整展示的列的个数，顺序等。然后要求导出的时侯，导出一摸一样的格式。也就是“所见即所得”的表格。

那么基于以上场景，我们就来考虑下如何实现？
本文就是对以上场景功能的一个实现。目前仅支持单sheet，不支持数据聚合等。

正文

本文项目环境：
java 8，springboot2.2.0, easyexcel

一、POM依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.2.0.RELEASE</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.2</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>2.2.11</version><exclusions><exclusion><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId></exclusion></exclusions></dependency></dependencies>

二、核心Java文件

此处粘贴全部的java文件
在这里插入图片描述

2.1 自定义表头注解 ExcelColumnTitle

package headbean;import java.lang.annotation.*;/*** 列名标题注解，标注列的标题** @author feng*/
@Documented
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelColumnTitle {String value();
}

2.2 自定义标题头的映射接口

此接口仅仅是用于规范实体，以及用于辅助实现导出功能。

package headbean;/*** excel头部映射接口，用于规范导出的实体类** @author feng*/
public interface ExcelHeadMapInterface {
}

2.3 自定义有序map存储表内数据

这个是表格导出时，字段数量，顺序的关键。

package headbean;import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;/*** 表格数据专用的map，带顺序，而且初始化的时候，依据指定的表头变量字段名确定导出数据的顺序** @author feng*/
public class ExcelDataLinkedHashMap<V> extends LinkedHashMap<String, V> {private static final long serialVersionUID = -8554095999151235982L;/*** 头部字段名缓存*/private final Set<String> headColumnNamesCache;/*** ExcelDataLinkedHashMap构造器** @param headColumnNames 表头字段变量名，例如：[name,studentNo,age,className]*/public ExcelDataLinkedHashMap(List<String> headColumnNames) {// 字段名去重headColumnNames = headColumnNames.stream().distinct().collect(Collectors.toList());// 构建字段名缓存this.headColumnNamesCache = new HashSet<>(headColumnNames);// 指定列数据排列顺序for (String headColumnName : headColumnNames) {this.put(headColumnName, null);}}@Overridepublic V put(String key, V value) {// 只保存字段名缓存中的key以及valueif (headColumnNamesCache.contains(key)) {return super.put(key, value);}return null;}
}

2.4 表头工厂

负责实现初始化表头字段名，以及后期使用时，从中获取表头信息。
核心功能是解析自定义的表头注解。

package factory;import enums.ExcelHeadBeanFlagEnum;
import headbean.ExcelColumnTitle;
import headbean.ExcelHeadMapInterface;import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;public class ExcelHeadMapFactory {/*** 全局表头名映射，ExcelHeadMapInterface实现类型为key，它内部变量的变量名和中文名映射为value*/private static final Map<Class<? extends ExcelHeadMapInterface>, Map<String, String>> HEAD_NAME_MAP = new HashMap<>();public static void addHeadClass(Class<? extends ExcelHeadMapInterface> headClass) {HEAD_NAME_MAP.put(headClass, mapToPrepareHead(headClass));}public static Map<String, String> getHeadMap(Class<? extends ExcelHeadMapInterface> headClass) {return HEAD_NAME_MAP.get(headClass);}public static Map<String, String> getHeadMapByFlag(String flag) {return getHeadMap(ExcelHeadBeanFlagEnum.getHeadClass(flag));}private static Map<String, String> mapToPrepareHead(Class<?> excelHeadClass) {Map<String, String> namedMap = new HashMap<>();Field[] declaredFields = excelHeadClass.getDeclaredFields();for (Field declaredField : declaredFields) {boolean annotationPresent = declaredField.isAnnotationPresent(ExcelColumnTitle.class);if(annotationPresent) {ExcelColumnTitle excelProperty = declaredField.getAnnotation(ExcelColumnTitle.class);String chineseFieldName = excelProperty.value();// 保存字段名和中文变量名namedMap.put(declaredField.getName(), chineseFieldName);}}return namedMap;}
}

2.5 表flag和表头映射枚举

这个枚举，如果你的系统这类功能很多。可以设计为数据库的方式做映射。然后以查字典表的方式，来处理。当然使用枚举大概率是够用了。

package enums;import headbean.ExcelHeadMapInterface;
import headbean.NameAndFactoryDemo;
import headbean.StudentDemo;
import lombok.AllArgsConstructor;
import lombok.Getter;import java.util.Arrays;/*** 表头flag枚举，映射flag与对应的实体类型；主要是可以根据flag找到对应实体类型。** @author feng*/
@Getter
@AllArgsConstructor
public enum ExcelHeadBeanFlagEnum {NAME_AND_FACTORY_DEMO("NameAndFactoryDemo", NameAndFactoryDemo.class),STUDENT_DEMO("StudentDemo", StudentDemo.class);private final String flag;private final Class<? extends ExcelHeadMapInterface> headClass;public static Class<? extends ExcelHeadMapInterface> getHeadClass(String flag) {return Arrays.stream(values()).filter(bean -> bean.getFlag().equals(flag)).findFirst().orElseThrow(RuntimeException::new).getHeadClass();}
}

2.6 测试用的实体

2.6.1 NameAndFactoryDemo
package headbean;import lombok.Data;@Data
public class NameAndFactoryDemo implements ExcelHeadMapInterface {@ExcelColumnTitle("名字")private String name;@ExcelColumnTitle("工厂")private String factory;
}
2.6.2 StudentDemo
package headbean;import lombok.Data;@Data
public class StudentDemo implements ExcelHeadMapInterface {@ExcelColumnTitle("姓名")private String name;@ExcelColumnTitle("年龄")private Integer age;@ExcelColumnTitle("学号")private String studentNo;@ExcelColumnTitle("班级")private String className;
}

2.7 启动类

主要是项目启动后，注册表头数据到内存。

package org.feng;import factory.ExcelHeadMapFactory;
import headbean.ExcelHeadMapInterface;
import headbean.NameAndFactoryDemo;
import headbean.StudentDemo;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;import java.util.ArrayList;
import java.util.List;@SpringBootApplication
public class ExcelDemoApplication implements CommandLineRunner {public static void main(String[] args) {SpringApplication.run(ExcelDemoApplication.class, args);}@Overridepublic void run(String... args) throws Exception {List<Class<? extends ExcelHeadMapInterface>> needRegisterExcelHeadClassList = new ArrayList<>();needRegisterExcelHeadClassList.add(NameAndFactoryDemo.class);needRegisterExcelHeadClassList.add(StudentDemo.class);needRegisterExcelHeadClassList.forEach(ExcelHeadMapFactory::addHeadClass);}
}

2.8 测试控制器

package org.feng;import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.write.metadata.WriteSheet;
import enums.ExcelHeadBeanFlagEnum;
import factory.ExcelHeadMapFactory;
import headbean.ExcelDataLinkedHashMap;
import headbean.ExcelHeadMapInterface;
import headbean.NameAndFactoryDemo;
import headbean.StudentDemo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;import javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.*;
import java.util.function.BiFunction;@Controller
@RequestMapping("/excel")
public class ExcelDemoController {@GetMapping("/exportDy")public String exportDy(@RequestParam("flag")String flag,@RequestParam("table")List<String> table, HttpServletResponse response) throws IOException {String fileName = System.currentTimeMillis() + ".xlsx";Class<? extends ExcelHeadMapInterface> headClass = ExcelHeadBeanFlagEnum.getHeadClass(flag);Map<String, String> namedPrepareHeadMap = ExcelHeadMapFactory.getHeadMap(headClass);Map<String, String> head = new LinkedHashMap<>();for (String fieldName : table) {head.put(namedPrepareHeadMap.get(fieldName), fieldName);}List<Map<String, String>> excelDataList = new ArrayList<>();excelDataList.add(head);// 制造假数据for (BiFunction<Class<? extends ExcelHeadMapInterface>, List<Map<String, String>>, Boolean> biFunction : bizList) {Boolean applied = biFunction.apply(headClass, excelDataList);if(applied) {break;}}byte[] bytes = easyOut(excelDataList);response.setHeader("Content-disposition", "attachment;filename=" + fileName);response.setContentType("application/x-msdownload");response.setCharacterEncoding("utf-8");response.getOutputStream().write(bytes);response.getOutputStream().flush();return "success";}static final List<BiFunction<Class<? extends ExcelHeadMapInterface>, List<Map<String, String>>, Boolean>> bizList = new ArrayList<>();@PostConstructprivate void init() {bizList.add(this::genStudentDemoData);bizList.add(this::genNameAndFactoryDemoData);}private boolean genStudentDemoData(Class<? extends ExcelHeadMapInterface> headClass, List<Map<String, String>> excelDataList) {if(headClass == StudentDemo.class) {Map<String, String> headMap = excelDataList.get(0);for (int i = 0; i < 5; i++) {Collection<String> fieldNames = headMap.values();Map<String, String> data = new ExcelDataLinkedHashMap<>(new ArrayList<>(fieldNames));excelDataList.add(data);data.put("name", "张三"+(i+1));data.put("age", "年龄"+(i+1));data.put("studentNo", "学号"+(i+1));data.put("className", "班级"+(i+1));}return true;}return false;}private boolean genNameAndFactoryDemoData(Class<? extends ExcelHeadMapInterface> headClass, List<Map<String, String>> excelDataList) {if(headClass == NameAndFactoryDemo.class) {Map<String, String> headMap = excelDataList.get(0);for (int i = 0; i < 5; i++) {Collection<String> fieldNames = headMap.values();Map<String, String> data = new ExcelDataLinkedHashMap<>(new ArrayList<>(fieldNames));excelDataList.add(data);data.put("name", "张三"+(i+1));data.put("factory", "工厂"+(i+1));}return true;}return false;}/*** 导出数据（单sheet）* @param exportData key 是sheet名称，value是每个sheet里面的数据，支持自定义表头*/public static byte[] easyOut(List<Map<String, String>> exportData) {return easyOut(Collections.singletonMap("Sheet", exportData));}/*** 导出数据（多sheet）* @param exportData key 是sheet名称，value是每个sheet里面的数据，可以自定义*/public static byte[] easyOut(Map<String, List<Map<String, String>>> exportData) {// 导出数据ByteArrayOutputStream out = new ByteArrayOutputStream();com.alibaba.excel.ExcelWriter excelWriter = EasyExcel.write(out).build();int i=0;for (Map.Entry<String, List<Map<String, String>>> entry: exportData.entrySet()) {WriteSheet writeSheet = EasyExcel.writerSheet(i, entry.getKey()).head(head(entry.getValue().get(0))).build();i++;excelWriter.write(data(entry.getValue(), true), writeSheet);}excelWriter.finish();return out.toByteArray();}private static List<List<String>> head(Map<String, String> cellData) {List<List<String>> head = new ArrayList<>();for (String key: cellData.keySet()) {head.add(Collections.singletonList(key));}return head;}private static List<List<String>> data(List<Map<String, String>> sheetData, boolean skipHead) {List<List<String>> data = new ArrayList<>();for (int i = 0; i < sheetData.size(); i++) {if(i == 0 && skipHead) {continue;}data.add(new ArrayList<>(sheetData.get(i).values()));}return data;}
}

三、测试

测试1

http://localhost:8080/excel/exportDy?flag=StudentDemo&table=name,studentNo,age,className

获得的表格内容为：
在这里插入图片描述

测试2

http://localhost:8080/excel/exportDy?flag=StudentDemo&table=name,studentNo,age

获得的表格内容为：
在这里插入图片描述

测试3

http://localhost:8080/excel/exportDy?flag=NameAndFactoryDemo&table=factory,name
获得的表格内容为：
在这里插入图片描述

测试4

http://localhost:8080/excel/exportDy?flag=StudentDemo&table=className,name,studentNo
获得的表格内容为：
在这里插入图片描述

这篇关于【EasyExcel实践】万能导出，一个接口导出多张表以及任意字段（可指定字段顺序）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/466676。

相关文章

Spring Boot 配置文件之类型、加载顺序与最佳实践记录

Spring Boot 配置文件之类型、加载顺序与最佳实践记录

《SpringBoot配置文件之类型、加载顺序与最佳实践记录》SpringBoot的配置文件是灵活且强大的工具,通过合理的配置管理,可以让应用开发和部署更加高效,无论是简单的属性配置,还是复杂... 目录Spring Boot 配置文件详解一、Spring Boot 配置文件类型1.1 applicatio
阅读更多...
go中空接口的具体使用

go中空接口的具体使用

《go中空接口的具体使用》空接口是一种特殊的接口类型,它不包含任何方法,本文主要介绍了go中空接口的具体使用,具有一定的参考价值,感兴趣的可以了解一下... 目录接口-空接口1. 什么是空接口？2. 如何使用空接口？第一，第二，第三，3. 空接口几个要注意的坑坑1：坑2：坑3：接口-空接口1. 什么是空接
阅读更多...
java中使用POI生成Excel并导出过程

java中使用POI生成Excel并导出过程

《java中使用POI生成Excel并导出过程》：本文主要介绍java中使用POI生成Excel并导出过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录需求说明及实现方式需求完成通用代码版本1版本2结果展示type参数为atype参数为b总结注：本文章中代码均为
阅读更多...
tomcat多实例部署的项目实践

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录，测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的
阅读更多...
Python 中的异步与同步深度解析(实践记录)

Python 中的异步与同步深度解析(实践记录)

《Python中的异步与同步深度解析(实践记录)》在Python编程世界里,异步和同步的概念是理解程序执行流程和性能优化的关键,这篇文章将带你深入了解它们的差异,以及阻塞和非阻塞的特性,同时通过实际... 目录python中的异步与同步：深度解析与实践异步与同步的定义异步同步阻塞与非阻塞的概念阻塞非阻塞同步
阅读更多...
Python Dash框架在数据可视化仪表板中的应用与实践记录

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash？1.1
阅读更多...
使用Python实现获取网页指定内容

使用Python实现获取网页指定内容

《使用Python实现获取网页指定内容》在当今互联网时代,网页数据抓取是一项非常重要的技能,本文将带你从零开始学习如何使用Python获取网页中的指定内容,希望对大家有所帮助... 目录引言1. 网页抓取的基本概念2. python中的网页抓取库3. 安装必要的库4. 发送HTTP请求并获取网页内容5. 解
阅读更多...
springboot集成Deepseek4j的项目实践

springboot集成Deepseek4j的项目实践

《springboot集成Deepseek4j的项目实践》本文主要介绍了springboot集成Deepseek4j的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录Deepseek4j快速开始Maven 依js赖基础配置基础使用示例1. 流式返回示例2. 进阶
阅读更多...
Python实现将MySQL中所有表的数据都导出为CSV文件并压缩

Python实现将MySQL中所有表的数据都导出为CSV文件并压缩

《Python实现将MySQL中所有表的数据都导出为CSV文件并压缩》这篇文章主要为大家详细介绍了如何使用Python将MySQL数据库中所有表的数据都导出为CSV文件到一个目录,并压缩为zip文件到... python将mysql数据库中所有表的数据都导出为CSV文件到一个目录，并压缩为zip文件到另一个
阅读更多...
Android App安装列表获取方法(实践方案)

Android App安装列表获取方法(实践方案)

《AndroidApp安装列表获取方法(实践方案)》文章介绍了Android11及以上版本获取应用列表的方案调整,包括权限配置、白名单配置和action配置三种方式,并提供了相应的Java和Kotl... 目录前言实现方案         方案概述一、 androidManifest 三种配置方式
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2