快捷導(dǎo)航

Java實現(xiàn)讀取Excel文件功能(EasyExcel初使用)

更新時間：2024年07月23日 09:40:49 作者：Java雪荷

EasyExcel是一款基于Java語言的開源Excel解析工具,可以幫助我們快速、高效地讀取和寫入Excel文件,這篇文章主要給大家介紹了關(guān)于Java實現(xiàn)讀取Excel文件功能的相關(guān)資料,使用的是EasyExcel,需要的朋友可以參考下

前言

在我們項目的開發(fā)中啊，前端有時候會傳送 Excel 文件給后端（Java）去解析，那我們作為后端該如何實現(xiàn)對 Excel 文件的解析和數(shù)據(jù)讀取呢？說到這我就不得不推薦 EasyExcel 了！

EasyExcel 介紹

引用下官方對于 EasyExcel 介紹：EasyExcel是一個基于Java的、快速、簡潔、解決大文件內(nèi)存溢出的Excel處理工具。他能讓你在不用考慮性能、內(nèi)存的等因素的情況下，快速完成Excel的讀、寫等功能。

官方網(wǎng)址：EasyExcel官方文檔 - 基于Java的Excel處理工具 | Easy Excel

快速上手 EasyExcel

前置工作

先創(chuàng)建一個 Spring Boot 工程，并在 pom.xml 文件添加 EasyExcel 和 Lombok 依賴。

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.1.1</version>
        </dependency>

知道表頭

如果我們知道 Excel 數(shù)據(jù)的表頭，即每列數(shù)據(jù)的類型包括有多少列時就可以用此方法讀取 Excel 文件數(shù)據(jù)。

我們以下圖數(shù)據(jù)為例，對改 Excel 中的數(shù)據(jù)進(jìn)行獲取和處理。

方法一：

首先我們創(chuàng)建一個名為 ExcelData 的 Java 對象，共有兩個屬性，分別是 date（日期列數(shù)據(jù)）和 useNum（用戶列數(shù)據(jù)），每個屬性對應(yīng) Excel 每列某一行中的數(shù)據(jù)。那么很顯而易見，每一行的數(shù)據(jù)就是一個 ExcelData 對象，所有行的數(shù)據(jù)合起來就是一個泛型為 ExcelData 的 ExcelData 的集合。

@Data
public class ExcelData implements Serializable {
    /**
     * 對應(yīng)表格的日期列
     */
    private String date;
    /**
     * 對應(yīng)表格的用戶數(shù)列
     */
    private Integer userNum;
}

隨后編寫一個測試類，并在其中編寫測試方法。

EasyExcel 的 read 方法有很多中構(gòu)造方法，其中 Class head 就是表頭類型，傳入它還要傳入 ReadListener 監(jiān)聽器，以便在去讀取每行數(shù)據(jù)時做些自定義操作。我們直接傳入它的實現(xiàn)類實例，因為 PageReadListener 支持逐頁讀取數(shù)據(jù)，通過讀取指定行數(shù)的數(shù)據(jù)保證占用更少的內(nèi)存。

話不多說直接上代碼：

    /**
     * 知道表頭，并形成映射關(guān)系
     */
    @Test
    public void doImportsForMapping() throws FileNotFoundException{
        // 讀取 resource 目錄下的 Excel 文件（網(wǎng)站數(shù)據(jù).xlsx）
        File file = ResourceUtils.getFile("classpath:網(wǎng)站數(shù)據(jù).xlsx");
        // 創(chuàng)建一個 list 存儲每行的數(shù)據(jù)，即 ExcelData 對象
        List<ExcelData> list = new ArrayList<>();
        // 直接使用 EasyExcel 的 read 方法，同時定義表頭的類型，以便將列中數(shù)據(jù)映射為 ExcelData 對象
        EasyExcel.read(file, ExcelData.class, new PageReadListener<ExcelData>(dataList -> {
            // 并且每行數(shù)據(jù)，并將其 add 至 list 中
            for (ExcelData excelData : dataList) {
                if (excelData != null) {
                    list.add(excelData);
                }
            }
        })).excelType(ExcelTypeEnum.XLSX).sheet().doRead(); // 指定 Excel 的文件后綴，開始分析讀取
        for (ExcelData excelData : list) {
            System.out.println(excelData.getDate() + "," + excelData.getUserNum());
        }
    }

執(zhí)行結(jié)果：

方法二：

方法一是直接一次性讀取 Excel 中的數(shù)據(jù)，缺少要讀取的數(shù)據(jù)行數(shù)和一些自定義操作，所以我們在這里對上面的代碼增強一下。

在此方法中我們通過匿名內(nèi)部類的方式實現(xiàn) ReadListenser 接口，無需額外寫一個類去實現(xiàn) ReadListener了。我們設(shè)置了一個臨時存儲的列表（大小為 2），當(dāng)每次讀取的數(shù)據(jù)（執(zhí)行 invoke 方法）添加到臨時存儲表中。當(dāng)其長度超過 2 時進(jìn)行全部刪除，在刪除前我們可以將臨時存儲的列表存到數(shù)據(jù)庫中，或進(jìn)行一些其他的自定義操作。

doAfterAllAnalysed 方法是分析并獲取所有的數(shù)據(jù)后會執(zhí)行的一個方法，我們可以在其中打上日志，表示 Excel 所有數(shù)據(jù)已存入數(shù)據(jù)庫中。

 /**
     * 知道表頭，并形成映射關(guān)系
     * @throws FileNotFoundException
     */
    @Test
    public void doImportsForMappingByInnerClass() throws FileNotFoundException{
        File file = ResourceUtils.getFile("classpath:網(wǎng)站數(shù)據(jù).xlsx");
        EasyExcel.read(file, ExcelData.class, new ReadListener<ExcelData>() {

            // 單次緩存的數(shù)據(jù)量
            public static final int BATCH_COUNT = 2;

            // 臨時存儲的列表
            private List<ExcelData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
            @Override
            public void invoke(ExcelData excelData, AnalysisContext analysisContext) {
                cachedDataList.add(excelData);
                getData(excelData);
                if (cachedDataList.size() >= BATCH_COUNT) {
                    cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
                }
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext analysisContext) {
                System.out.println("存儲數(shù)據(jù)庫成功");
            }

            private void getData(ExcelData excelData) {
                System.out.println(excelData.getDate() + "," + excelData.getUserNum());
            }
        }).excelType(ExcelTypeEnum.XLSX).sheet().doRead();

    }

執(zhí)行結(jié)果：

不知道表頭

方法三：

上面的兩種方法都是我們知道表頭，包括列的類型和列數(shù)量的情況下對 Excel 文件進(jìn)行數(shù)據(jù)獲取的。那我們不知道表頭信息，又該如何操作呢？

我們依賴?yán)?EasyExcel 的 read 方法，和前面的步驟大差不差，只不過這次參數(shù)少了，如果你還要獲取表頭即表格的第一行數(shù)據(jù)，還可通過 headRowNumber 方法指定首行編號為 0。

此時返回的是一個 List<Map<Integer, String>> 集合，其中 Map 的鍵對應(yīng)表格的列編號（從 0 開始），值就是對應(yīng)某一行某一列的值，List 的索引代表某一行的數(shù)據(jù)。調(diào)用 Map 對象的 values() 方法即可直接獲取某一行數(shù)據(jù)的集合，List<Map<Integer, String>> 就是所有行數(shù)據(jù)的集合。我們這說可能不太直觀，我把它打印出來給你們看就很簡單明了了。

[{0=日期, 1=用戶數(shù)}, {0=1號, 1=10}, {0=2號, 1=20}, {0=3號, 1=30}, {0=4號, 1=70}, {0=5號, 1=20}, {0=6號, 1=29}, {0=7號, 1=24}, {0=8號, 1=31}, {0=9號, 1=40}, {0=10號, 1=38}, {0=11號, 1=43}]

代碼如下：

    @Test
    public void doImport() throws FileNotFoundException {
        List<Map<Integer, String>> list = null;
        File file = ResourceUtils.getFile("classpath:網(wǎng)站數(shù)據(jù).xlsx");
        try {
            list = EasyExcel.read(file)
                    .excelType(ExcelTypeEnum.XLSX)
                    .sheet()
                    .headRowNumber(0)
                    .doReadSync();
        } catch (Exception e) {
            throw new RuntimeException("讀取 Excel 文件失敗");
        }
        StringBuilder stringBuilder = new StringBuilder();
        for (int i=0;i<list.size();i++) {
            // 轉(zhuǎn)為 LinkedHashMap 主要是為了保證讀取的數(shù)據(jù)和表格順序一致
            LinkedHashMap<Integer, String> linkedHashMap = (LinkedHashMap) list.get(i);
            List<String> dataList = linkedHashMap.values().stream()
                    .filter(ObjectUtils::isNotEmpty).collect(Collectors.toList());
            stringBuilder.append(StringUtils.join(dataList, ",")).append("\n");
        }
        System.out.println(stringBuilder.toString());
    }

執(zhí)行結(jié)果：