Spring Boot 我隨手封裝了一個萬能的 Excel 導出工具，傳什麼都能導出！

前言

如題，這個小玩意，就是不限制你查的是哪張表，用的是什麼類。

我直接一把梭，嘎嘎給你一頓導出。

我知道，這是很多人都想過的，至少我就收到很多人問過我這個類似的問題。

我也跟他們說了，但是他們就是不動手，其實真的很簡單。

不動手怎麼辦？我出手唄。

不多說開搞。

正文

玩法很簡單。

要實現的效果：

類是不確定的，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開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！

Spring Boot 我隨手封裝了一個萬能的 Excel 導出工具，傳什麼都能導出！

前言

正文

我們要實現萬能的類導出excel ！！！

① 我們從不確定的類的集合list 中，取出裏面的類。

②拼接內容

擴展

自學編程兩個月，現在我月入 4 萬元

Google Chrome驅動程序 124.0.6367.62（正式版本）去哪下載？

公司新來一個幹練小夥，把 MyBatis 替換成 MyBatis-Plus，上線後哭暈在廁所。。。

美團二面：爲什麼不推薦使用 MyBatis 二級緩存？大部分人都答不上來！

Nacos 2.3.2 正式發佈，修復重大 bug！

騰訊雲也崩了。。

牛逼！一鍵生成整個項目類關係圖，這款 IDEA 插件堪稱神器！

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

Spring Boot 我隨手封裝了一個萬能的 Excel 導出工具，傳什麼都能導出！

前言

正文

我們要實現萬能的類導出excel ！！！

① 我們從不確定的類 的集合list 中，取出 裏面的類。

②拼接內容

擴展

① 我們從不確定的類的集合list 中，取出裏面的類。