点击上方“Java基基”,选择“设为星标”
做积极的人,而不是积极废人!
每天 14:00 更新文章,每天掉亿点点头发...
源码精品专栏
前言
如题,这个小玩意,就是不限制你查的是哪张表,用的是什么类。
我直接一把梭,嘎嘎给你一顿导出。
![12a5cebcbcd7ca19f888b7076559bc4c.png](https://i-blog.csdnimg.cn/blog_migrate/00735f39382b167493d2ff565aa628e1.png)
我知道,这是很多人都想过的, 至少我就收到很多人问过我这个类似的问题。
我也跟他们说了,但是他们就是不动手,其实真的很简单。
不动手怎么办? 我出手呗。
不多说开搞 。
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
项目地址:https://github.com/YunaiV/ruoyi-vue-pro
视频教程:https://doc.iocoder.cn/video/
正文
玩法很简单,我之前有写过一篇利用csv文件内容格式做excel文件导出的。
如果没有看过的,还等什么,现在就去看看:
SpringBoot 那年我双手插兜,手写一个excel导出
要实现的效果 :
类是不确定的 ,User ?Student ? District ? 不确定。
但是呢我们封装出来的函数,要足够支撑不同的类,我们自动去读取遍历list ,然后导出生成文件。
核心的思路是什么 ?
其实就还是利用csv文件的内容格式本质 ,看这两幅图 :
![bff03783b96e80e4dc530747f0170c18.png](https://i-blog.csdnimg.cn/blog_migrate/3cbc707068e60850009c4a0bcb5b04e1.png)
![438e46517861fc46190472470cbc4fff.png](https://i-blog.csdnimg.cn/blog_migrate/1bcbac7b726d7036bd39d3fb5a435119.png)
我们要实现万能的类导出excel !!!
思路是什么 :
① 我们从不确定的类 的集合list 中,取出 里面的类。
反射一手,拿出里面的属性名, 做第一行表格行标题名称拼接。
②拼接内容
因为类不确定,那么我们就采取反射把类全部字段属性作为key丢到map里面,同时把值丢到value里面。
这样我们拼接内容的时候只需要根据map 嘎嘎一顿遍历 拼接即可。
1.依赖
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.15</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-scratchpad</artifactId>
<version>3.15</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.69</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.5</version>
</dependency>
2. 核心的工具类,函数我都封装好了
MyCsvFileUtil.java
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.*;
/**
* @author JCccc
* @Remark 是我
*/
@Slf4j
public class MyCsvFileUtil {
public static final String FILE_SUFFIX = ".csv";
public static final String CSV_DELIMITER = ",";
public static final String CSV_TAIL = "\r\n";
protected static final String DATE_STR_FILE_NAME = "yyyyMMddHHmmssSSS";
/**
* 将字符串转成csv文件
*/
public static void createCsvFile(String savePath, String contextStr) throws IOException {
File file = new File(savePath);
//创建文件
file.createNewFile();
//创建文件输出流
FileOutputStream fileOutputStream = new FileOutputStream(file);
//将指定字节写入此文件输出流
fileOutputStream.write(contextStr.getBytes("gbk"));
fileOutputStream.flush();
fileOutputStream.close();
}
/**
* 写文件
*
* @param fileName
* @param content
*/
public static void writeFile(String fileName, String content) {
FileOutputStream fos = null;
OutputStreamWriter writer = null;
try {
fos = new FileOutputStream(fileName, true);
writer = new OutputStreamWriter(fos, "GBK");
writer.write(content);
writer.flush();
} catch (Exception e) {
log.error("写文件异常|{}", e);
} finally {
if (fos != null) {
IOUtils.closeQuietly(fos);
}
if (writer != null) {
IOUtils.closeQuietly(writer);
}
}
}
/**
* 构建文件名称
* @param dataList
* @return
*/
public static String buildCsvFileFileName(List dataList) {
return dataList.get(0).getClass().getSimpleName() + new SimpleDateFormat(DATE_STR_FILE_NAME).format(new Date()) + FILE_SUFFIX;
}
/**
* 构建excel 标题行名
* @param dataList
* @return
*/
public static String buildCsvFileTableNames(List dataList) {
Map<String, Object> map = toMap(dataList.get(0));
StringBuilder tableNames = new StringBuilder();
for (String key : map.keySet()) {
tableNames.append(key).append(MyCsvFileUtil.CSV_DELIMITER);
}
return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
}
/**
* 构建excel内容
* @param dataLists
* @return
*/
public static String buildCsvFileBodyMap(List dataLists) {
//不管你传什么玩意,我都给你反射一手,搞成Map
List<Map<String, Object>> mapList = new ArrayList<>();
for (Object o : dataLists) {
mapList.add(toMap(o));
}
//然后利用csv格式,对着map嘎嘎一顿拼接数据
StringBuilder lineBuilder = new StringBuilder();
for (Map<String, Object> rowData : mapList) {
for (String key : rowData.keySet()) {
Object value = rowData.get(key);
if (Objects.nonNull(value)) {
lineBuilder.append(value).append(MyCsvFileUtil.CSV_DELIMITER);
} else {
lineBuilder.append("--").append(MyCsvFileUtil.CSV_DELIMITER);
}
}
lineBuilder.append(MyCsvFileUtil.CSV_TAIL);
}
return lineBuilder.toString();
}
/**
* 类转map
* @param entity
* @param <T>
* @return
*/
public static<T> Map<String, Object> toMap(T entity){
Class<? extends Object> bean = entity.getClass();
Field[] fields = bean.getDeclaredFields();
Map<String, Object> map = new HashMap<>(fields.length);
for(Field field:fields){
try {
if(!"serialVersionUID".equals(field.getName())){
String methodName = "get"+field.getName().substring(0, 1).toUpperCase()+field.getName().substring(1);
Method method = bean.getDeclaredMethod(methodName);
Object fieldValue = method.invoke(entity);
map.put(field.getName(),fieldValue);
}
} catch (Exception e) {
log.warn("toMap() Exception={}",e.getMessage());
}
}
return map;
}
}
代码注意点(各种小封装):
①类转map
![ed7484d14292b88897c4f8c96cf2ff7c.png](https://i-blog.csdnimg.cn/blog_migrate/0daaaefd7b67d8f112102ce2cdd594b9.png)
② 反射转map 取字段属性名 拼接 标题
![b5420f7e1d34798945ebc4720e9b47e6.png](https://i-blog.csdnimg.cn/blog_migrate/fb2d204e2afc8dc4118f9e1ee42bc025.png)
③ 针对list<不确定类>
转化成 list<map>
,然后拼接excel内容
![8b6ad6c7990cf9f04ecffef65628da09.png](https://i-blog.csdnimg.cn/blog_migrate/1dc4a8e633fbcf7b46da3b715c3ff467.png)
测试代码:
@RequestMapping("/createCsvFileJcTest")
public void createCsvFileJcTest() {
//类不确定 随便怎么传都行
List<District> districts = districtService.queryByParentCodes(Arrays.asList("110100"));
//存放地址&文件名
String fileName = "D:\\mycsv\\"+MyCsvFileUtil.buildCsvFileFileName(districts);
//创建表格行标题
String tableNames = MyCsvFileUtil.buildCsvFileTableNames(districts);
//创建文件
MyCsvFileUtil.writeFile(fileName, tableNames);
//写入数据
String contentBody = MyCsvFileUtil.buildCsvFileBodyMap(districts);
//调用方法生成
MyCsvFileUtil.writeFile(fileName, contentBody);
}
![eb19344d91ca0ab29c7205434141a97c.png](https://i-blog.csdnimg.cn/blog_migrate/93faeb3d152a04cfb60421b1723876f4.png)
看看效果:
![fcb9265f295277941034acbad9415284.png](https://i-blog.csdnimg.cn/blog_migrate/e37d80b8e67b998dc64adb06faa30d97.png)
![f3997888a770740a746c5415f17cd5fa.png](https://i-blog.csdnimg.cn/blog_migrate/1c83a80d486114641da3ec1421d5bc5c.png)
导出的excel文件内容:
![60c22c1f5bd0ce8baec04317889132bb.png](https://i-blog.csdnimg.cn/blog_migrate/a74098ed0032ed931f5702f5a1980745.png)
接下来换个类玩玩:
![e5cf61ec76dcd1e2137c43b817ca8d31.png](https://i-blog.csdnimg.cn/blog_migrate/66799d1b44c3414643fe746a7dec8624.png)
然后导出看看效果:
![f4ba484871d58f48d79afb764ba8a8ba.png](https://i-blog.csdnimg.cn/blog_migrate/23135c223db1a34451c9442642a5d21a.png)
可以看到数据导出也是OK的:
![dee7159cf4275f051e2c18d0307a432e.png](https://i-blog.csdnimg.cn/blog_migrate/55558edf2d6674b8b0ef6abf6e26ab8c.png)
没错就是这么简单, 当然也是抛转引玉, 希望大家看了这篇文章,可以借鉴这些反射的函数玩法,做更多的好玩的封装,比如加上一些自定义注解的解析,比如加上一些前后置拦截器拓展等等。
基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
项目地址:https://github.com/YunaiV/yudao-cloud
视频教程:https://doc.iocoder.cn/video/
扩展
上面的示例中导出的表头是属性名,如果正式的导出通常需要自定义表头名称,我们这里可以使用自定义注解来完成。
JcExcelName.java
/**
* @Author : JCccc
* @CreateTime : 2020/5/14
* @Description :
**/
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JcExcelName {
String name() default "";
}
然后在想导出的类里面,想加看得懂的名字就加,不加就拿属性名:
![d124e6c7744f3e9a93c78cbe32f483b5.png](https://i-blog.csdnimg.cn/blog_migrate/cef7cc3446f88d41c3e113eb7e95da69.png)
随手再写一个 ,新的反射解析拿字段属性注解值函数:
public static <T> List<String> resolveExcelTableName(T entity) {
List<String> tableNamesList = new ArrayList<>();
Class<? extends Object> bean = entity.getClass();
Field[] fields = bean.getDeclaredFields();
Map<String, Object> map = new HashMap<>(fields.length);
for (Field field : fields) {
try {
if (!"serialVersionUID".equals(field.getName())) {
String tableTitleName = field.getName();
JcExcelName myFieldAnn = field.getAnnotation(JcExcelName.class);
String annName = myFieldAnn.name();
if (StringUtils.hasLength(annName)) {
tableTitleName = annName;
}
tableNamesList.add(tableTitleName);
}
} catch (Exception e) {
log.warn("toMap() Exception={}", e.getMessage());
}
}
return tableNamesList;
}
然后根据解析出来的注解值列名拼接 表格标题名格式:
public static String buildCsvFileTableNamesNew(List<String> dataList) {
StringBuilder tableNames = new StringBuilder();
for (String name : dataList) {
tableNames.append(name).append(MyCsvFileUtil.CSV_DELIMITER);
}
return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
}
测试看看效果:
public static void main(String[] args) {
User user = new User();
List<String> nameList = MapUtils.resolveExcelTableName(user);
System.out.println(nameList.toString());
String tableNames = buildCsvFileTableNamesNew(nameList);
System.out.println(tableNames);
}
效果嘎嘎好:
![44098702a2bbbc41b34fd7f266d17b2f.png](https://i-blog.csdnimg.cn/blog_migrate/8f5923c974cb486f92241595d87442d0.png)
然后反手就搞到我们前面的文章使用例子里面:
String tableNames = MyCsvFileUtil.buildCsvFileTableNamesNew( MyCsvFileUtil.resolveExcelTableName(dataList.get(0)));
![ecc4cc887371b960fc96b1470dd27df7.png](https://i-blog.csdnimg.cn/blog_migrate/fd97b9177f8f674e1e7150e83522b565.png)
执行一下示例接口,看看效果:
![24b04087a83f0a8451158f264c6f42e3.png](https://i-blog.csdnimg.cn/blog_migrate/55d8c87de953c24d196495c98d564eac.png)
文件出来了:
![9409394dd1d91223e41708ad332ff9b8.png](https://i-blog.csdnimg.cn/blog_migrate/ed2d408c2cad07759cf27c45682feff5.png)
打开看看效果:
![589b1b4d34c9f7ee7f079021739f3881.png](https://i-blog.csdnimg.cn/blog_migrate/4235499632b3a283035b88cb38e3955e.png)
好了,就到这吧,非常完美。
欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:
已在知识星球更新源码解析如下:
最近更新《芋道 SpringBoot 2.X 入门》系列,已经 101 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。
提供近 3W 行代码的 SpringBoot 示例,以及超 6W 行代码的电商微服务项目。
获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)