SpringBoot 封装一个万能的导出excel工具，传什么都能导出

前言

如题，这个小玩意，就是不限制你查的是哪张表，用的是什么类。

我直接一把梭，嘎嘎给你一顿导出。

我知道，这是很多人都想过的， 至少我就收到很多人问过我这个类似的问题。

我也跟他们说了，但是他们就是不动手，其实真的很简单。

不动手怎么办？  我出手呗。

不多说开搞 。

正文

玩法很简单，我之前有写过一篇利用csv文件内容格式做excel文件导出的。

如果没有看过的，还等什么，现在就去看看：

Springboot 那年我双手插兜，手写一个excel导出

要实现的效果 ：

类是不确定的 ，User ？ Student ?  District ?   不确定。

但是呢我们封装出来的函数，要足够支撑不同的类，我们自动去读取遍历list ，然后导出生成文件。

核心的思路是什么 ？ 

其实就还是利用csv文件的内容格式本质 ，看这两幅图 ：

我们要实现万能的类导出excel ！！！

思路是什么 ：

① 我们从不确定的类 的集合list 中，取出 里面的类。

反射一手，拿出里面的属性名， 做第一行表格行标题名称拼接。

②拼接内容
因为类不确定，那么我们就采取反射把类全部字段属性作为key丢到map里面，
同时把值丢到value里面。

这样我们拼接内容的时候只需要根据map 嘎嘎一顿遍历 拼接即可。

1.依赖

1. <dependency>
2. <groupId>org.apache.poi</groupId>
3. <artifactId>poi-ooxml</artifactId>
4. <version>3.15</version>
5. </dependency>
6. <dependency>
7. <groupId>org.apache.poi</groupId>
8. <artifactId>poi-scratchpad</artifactId>
9. <version>3.15</version>
10. </dependency>
11. <dependency>
12. <groupId>com.alibaba</groupId>
13. <artifactId>fastjson</artifactId>
14. <version>1.2.69</version>
15. </dependency>
16. <dependency>
17. <groupId>commons-io</groupId>
18. <artifactId>commons-io</artifactId>
19. <version>2.5</version>
20. </dependency>

2. 核心的工具类，函数我都封装好了

MyCsvFileUtil.java

1. import lombok.extern.slf4j.Slf4j;
2. import org.apache.commons.io.IOUtils;
4. import java.io.File;
5. import java.io.FileOutputStream;
6. import java.io.IOException;
7. import java.io.OutputStreamWriter;
8. import java.lang.reflect.Field;
9. import java.lang.reflect.Method;
10. import java.text.SimpleDateFormat;
11. import java.util.*;
13. /**
14. * @author JCccc
15. * @Remark 是我
16. */
17. @Slf4j
18. public class MyCsvFileUtil {
19. public static final String FILE_SUFFIX = ".csv";
20. public static final String CSV_DELIMITER = ",";
21. public static final String CSV_TAIL = "\r\n";
22. protected static final String DATE_STR_FILE_NAME = "yyyyMMddHHmmssSSS";
24. /**
25. * 将字符串转成csv文件
26. */
27. public static void createCsvFile(String savePath, String contextStr) throws IOException {
29. File file = new File(savePath);
30. //创建文件
31. file.createNewFile();
32. //创建文件输出流
33. FileOutputStream fileOutputStream = new FileOutputStream(file);
34. //将指定字节写入此文件输出流
35. fileOutputStream.write(contextStr.getBytes("gbk"));
36. fileOutputStream.flush();
37. fileOutputStream.close();
38. }
40. /**
41. * 写文件
42. *
43. * @param fileName
44. * @param content
45. */
46. public static void writeFile(String fileName, String content) {
47. FileOutputStream fos = null;
48. OutputStreamWriter writer = null;
49. try {
50. fos = new FileOutputStream(fileName, true);
51. writer = new OutputStreamWriter(fos, "GBK");
52. writer.write(content);
53. writer.flush();
54. } catch (Exception e) {
55. log.error("写文件异常|{}", e);
56. } finally {
57. if (fos != null) {
58. IOUtils.closeQuietly(fos);
59. }
60. if (writer != null) {
61. IOUtils.closeQuietly(writer);
62. }
63. }
64. }
66. /**
67. * 构建文件名称
68. * @param dataList
69. * @return
70. */
71. public static String buildCsvFileFileName(List dataList) {
72. return dataList.get(0).getClass().getSimpleName() + new SimpleDateFormat(DATE_STR_FILE_NAME).format(new Date()) + FILE_SUFFIX;
73. }
75. /**
76. * 构建excel 标题行名
77. * @param dataList
78. * @return
79. */
80. public static String buildCsvFileTableNames(List dataList) {
81. Map<String, Object> map = toMap(dataList.get(0));
82. StringBuilder tableNames = new StringBuilder();
83. for (String key : map.keySet()) {
84. tableNames.append(key).append(MyCsvFileUtil.CSV_DELIMITER);
85. }
86. return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
87. }
89. /**
90. * 构建excel内容
91. * @param dataLists
92. * @return
93. */
94. public static String buildCsvFileBodyMap(List dataLists) {
95. //不管你传什么玩意，我都给你反射一手，搞成Map
96. List<Map<String, Object>> mapList = new ArrayList<>();
97. for (Object o : dataLists) {
98. mapList.add(toMap(o));
99. }
100. //然后利用csv格式，对着map嘎嘎一顿拼接数据
101. StringBuilder lineBuilder = new StringBuilder();
102. for (Map<String, Object> rowData : mapList) {
103. for (String key : rowData.keySet()) {
104. Object value = rowData.get(key);
105. if (Objects.nonNull(value)) {
106. lineBuilder.append(value).append(MyCsvFileUtil.CSV_DELIMITER);
107. } else {
108. lineBuilder.append("--").append(MyCsvFileUtil.CSV_DELIMITER);
109. }
110. }
111. lineBuilder.append(MyCsvFileUtil.CSV_TAIL);
112. }
113. return lineBuilder.toString();
114. }
116. /**
117. * 类转map
118. * @param entity
119. * @param <T>
120. * @return
121. */
122. public static<T> Map<String, Object> toMap(T entity){
123. Class<? extends Object> bean = entity.getClass();
124. Field[] fields = bean.getDeclaredFields();
125. Map<String, Object> map = new HashMap<>(fields.length);
126. for(Field field:fields){
127. try {
128. if(!"serialVersionUID".equals(field.getName())){
129. String methodName = "get"+field.getName().substring(0, 1).toUpperCase()+field.getName().substring(1);
130. Method method = bean.getDeclaredMethod(methodName);
131. Object fieldValue = method.invoke(entity);
132. map.put(field.getName(),fieldValue);
133. }
134. } catch (Exception e) {
135. log.warn("toMap() Exception={}",e.getMessage());
136. }
137. }
138. return map;
139. }
140. }

 代码注意点(各种小封装)：

①类转map 

② 反射转map 取字段属性名 拼接 标题

③ 针对list<不确定类> 转化成 list<map> ，然后拼接excel内容 

 

测试代码：

1. @RequestMapping("/createCsvFileJcTest")
2. public void createCsvFileJcTest() {
3. //类不确定 随便怎么传都行
4. List<District> districts = districtService.queryByParentCodes(Arrays.asList("110100"));
5. //存放地址&文件名
6. String fileName = "D:\\mycsv\\"+MyCsvFileUtil.buildCsvFileFileName(districts);
7. //创建表格行标题
8. String tableNames = MyCsvFileUtil.buildCsvFileTableNames(districts);
9. //创建文件
10. MyCsvFileUtil.writeFile(fileName, tableNames);
11. //写入数据
12. String contentBody = MyCsvFileUtil.buildCsvFileBodyMap(districts);
13. //调用方法生成
14. MyCsvFileUtil.writeFile(fileName, contentBody);
15. }

看看效果：

 

导出的excel文件内容： 

 

接下来换个类玩玩：

 然后导出看看效果：

可以看到数据导出也是OK的： 

 

没错就是这么简单， 当然也是抛转引玉， 希望大家看了这篇文章，可以借鉴这些反射的函数玩法，做更多的好玩的封装，比如加上一些自定义注解的解析，比如加上一些前后置拦截器拓展等等。

好了该篇就到这。

-------持续有空就继续玩封装---------

哦豁，我的看官们提出了想法，很不错：

是的导出来的这个属性名，客户不满意呀。 那就搞一手。 自定义注解搞起来！

我出手侠从来不迟到！

JcExcelName.java 

1. /**
2. * @Author : JCccc
3. * @CreateTime : 2020/5/14
4. * @Description :
5. **/
7. @Target({ElementType.METHOD, ElementType.FIELD})
8. @Retention(RetentionPolicy.RUNTIME)
9. public @interface JcExcelName {
11. String name() default "";
13. }

然后在想导出的类里面，想加看得懂的名字就加，不加就拿属性名：

 随手再写一个 ，新的反射解析拿字段属性注解值函数：

1. public static <T> List<String> resolveExcelTableName(T entity) {
2. List<String> tableNamesList = new ArrayList<>();
3. Class<? extends Object> bean = entity.getClass();
4. Field[] fields = bean.getDeclaredFields();
5. Map<String, Object> map = new HashMap<>(fields.length);
6. for (Field field : fields) {
7. try {
8. if (!"serialVersionUID".equals(field.getName())) {
9. String tableTitleName = field.getName();
10. JcExcelName myFieldAnn = field.getAnnotation(JcExcelName.class);
11. String annName = myFieldAnn.name();
12. if (StringUtils.hasLength(annName)) {
13. tableTitleName = annName;
14. }
15. tableNamesList.add(tableTitleName);
16. }
17. } catch (Exception e) {
18. log.warn("toMap() Exception={}", e.getMessage());
19. }
20. }
21. return tableNamesList;
22. }

然后根据解析出来的注解值列名拼接 表格标题名格式：

1. public static String buildCsvFileTableNamesNew(List<String> dataList) {
2. StringBuilder tableNames = new StringBuilder();
3. for (String name : dataList) {
4. tableNames.append(name).append(MyCsvFileUtil.CSV_DELIMITER);
5. }
6. return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
7. }

测试看看效果：

1. public static void main(String[] args) {
3. User user = new User();
4. List<String> nameList = MapUtils.resolveExcelTableName(user);
5. System.out.println(nameList.toString());
6. String tableNames = buildCsvFileTableNamesNew(nameList);
7. System.out.println(tableNames);
9. }

效果嘎嘎好：

 然后反手就搞到我们前面的文章使用例子里面：

String tableNames = MyCsvFileUtil.buildCsvFileTableNamesNew( MyCsvFileUtil.resolveExcelTableName(dataList.get(0))); 

执行一下示例接口，看看效果：

文件出来了:

 打开看看效果：

好了，就到这吧。

ps：

Springboot 最简单的结合MYSQL数据实现EXCEL表格导出及数据导入

Springboot 指定自定义模板导出Excel文件

SpringBoot 导出多个Excel文件，压缩成.zip格式下载

Springboot 获取导入的Excel文件的sheet表 列名

 Springboot 导入导出Excel ，一对多关系，复合表格、合并单元格数据

Springboot 那年我双手插兜，手写一个excel导出

来源：https://blog.csdn.net/qq_35387940/article/details/129062470