关于java:Spring-Boot-我随手封装了一个万能的-Excel-导出工具传什么都能导出

61次阅读

共计 6590 个字符，预计需要花费 17 分钟才能阅读完成。

前言

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

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

我晓得，这是很多人都想过的，至多我就收到很多人问过我这个相似的问题。

我也跟他们说了，然而他们就是不入手，其实真的很简略。

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

不多说开搞。

注释

玩法很简略。

要实现的成果：

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

然而呢咱们封装进去的函数，要足够撑持不同的类，咱们主动去读取遍历 list，而后导出生成文件。

外围的思路是什么？

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

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

思路是什么：

① 咱们从不确定的类 的汇合 list 中，取出 外面的类。

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

②拼接内容

因为类不确定，那么咱们就采取反射把类全副字段属性作为 key 丢到 map 外面，同时把值丢到 value 外面。

这样咱们拼接内容的时候只须要依据 map 嘎嘎一顿遍历拼接即可。

举荐一个开源收费的 Spring Boot 最全教程：

https://github.com/javastacks/spring-boot-best-practice

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

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

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

测试代码：

@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);
}

看看成果：

导出的 excel 文件内容：

接下来换个类玩玩：

而后导出看看成果：

能够看到数据导出也是 OK 的：

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

扩大

下面的示例中导出的表头是属性名，如果正式的导出通常须要自定义表头名称，咱们这里能够应用自定义注解来实现。

JcExcelName.java

/**
 * @Author : JCccc
 * @CreateTime : 2020/5/14
 * @Description :
 **/
 
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JcExcelName {String name() default "";
 
}

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

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

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);
 
}

成果嘎嘎好：

而后反手就搞到咱们后面的文章应用例子外面：

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

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

文件进去了:

关上看看成果：

好了，就到这吧，十分完满。

起源：blog.csdn.net/qq_35387940/article/details/129062470

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完
java
发表至： java
2023-05-24
 0
尝试将正式服务迁移至docker中并管理的一次实践
Java核心技术笔记 继承
关于java:Spring-Security自定义用户认证过程1
关于java:看完这篇-finalfinally-和-finalize-和面试官扯皮就没问题了