摘要：消費之后，多線程處理文件導(dǎo)出，生成文件后上傳到等文件服務(wù)器。前端直接查詢并且展現(xiàn)對應(yīng)的任務(wù)執(zhí)行列表，去等文件服務(wù)器下載文件即可。這客戶體驗不友好，而且網(wǎng)絡(luò)傳輸，系統(tǒng)占用多種問題。拓展閱讀導(dǎo)出最佳實踐框架

產(chǎn)品經(jīng)理需要導(dǎo)出一個頁面的所有的信息到 EXCEL 文件。

對于 excel 導(dǎo)出，是一個很常見的需求。

最常見的解決方案就是使用 poi 直接同步導(dǎo)出一個 excel 文件。

客戶體驗

如果導(dǎo)出的文件比較大，比如幾十萬條數(shù)據(jù)，同步導(dǎo)出頁面就會卡主，用戶無法進行其他操作。

服務(wù)性能

導(dǎo)出的時候，任務(wù)比較耗時就會阻塞主線程。

如果導(dǎo)出的服務(wù)是暴露給外部（前后端分離），這種大量的數(shù)據(jù)傳輸十分消耗性能。

使用異常處理導(dǎo)出請求，后臺 MQ 通知自己進行處理。

MQ 消費之后，多線程處理 excel 文件導(dǎo)出，生成文件后上傳到 FTP 等文件服務(wù)器。

前端直接查詢并且展現(xiàn)對應(yīng)的任務(wù)執(zhí)行列表，去 FTP 等文件服務(wù)器下載文件即可。

正常的 poi 在處理比較大的 excel 的時候，會出現(xiàn)內(nèi)存溢出。

網(wǎng)上的解決方案也比較多。

比如官方的 SXSSF (Since POI 3.8 beta3) 解決方式。

或者使用封裝好的包

easypoi ExcelBatchExportServer

hutool BigExcelWriter

原理都是強制使用 xssf 版本的Excel。

你也可以使用 easyexcel，當然這個注釋文檔有些欠缺，而且設(shè)計的比較復(fù)雜，不是很推薦。

我這里使用的是 hutool BigExcelWriter，
懶得自己再寫一遍。

如果一次查詢 100W 條數(shù)據(jù)庫，然后把這些信息全部加載到內(nèi)存中，是不可取的。

建議有2個：

限制每一次分頁的數(shù)量。比如一次最多查詢 1w 條。分成 100 次查詢。(必須)

限制查詢得總條數(shù)。比如限制為最多 10W 條。（根據(jù)實際情況選擇）

雖然使用者提出要導(dǎo)出類似于 3 個月的所有信息，但是數(shù)量太多，毫無意義。(提出者自己可能體會不到)

盡量避免 FULL-GC 的情況發(fā)生，因為目前的所有方式對于 excel 的輸出流都會占用內(nèi)存，100W 條很容易導(dǎo)致 FULL-GC。

去數(shù)據(jù)庫讀取的時候一定要記得分頁，免得給數(shù)據(jù)庫太大的壓力。

一次讀取太多，也會導(dǎo)致內(nèi)存直線上升。

比如 100W 條數(shù)據(jù)，則分成 100 次去數(shù)據(jù)庫讀取。

傳統(tǒng)的 excel 導(dǎo)出，都是前端一個請求，直接 HTTP 同步返回。導(dǎo)出 100W 條，就在那里傻等。

這客戶體驗不友好，而且網(wǎng)絡(luò)傳輸，系統(tǒng)占用多種問題。

建議使用異步處理的方式，將文件上傳到文件服務(wù)器。前端直接去文件服務(wù)器讀取。

對于上面提到的工具，比如 Hutool，在表頭的處理方面沒法很方便的統(tǒng)一。

你可以自己定義類似于 easypoi/easyexcel 中的注解，自己反射解析。

然后統(tǒng)一處理表頭即可。

OO 的方式操作 excel，編程更加方便優(yōu)雅。

sax 模式讀取，SXSS 模式寫入。避免 excel 大文件 OOM。

基于注解，編程更加靈活。

寫入可以基于對象列表，也可以基于 Map，實際使用更加方便。

設(shè)計簡單，注釋完整。方便大家學習改造。

讀取跳過空白行

excel 樣式相關(guān)的注解開發(fā)

實際工作和學習中，apache poi 操作 excel 過于復(fù)雜。

近期也看了一些其他的工具框架：

easypoi

easyexcel

hutool-poi

都或多或少難以滿足自己的實際需要，于是就自己寫了一個操作 excel 導(dǎo)出的工具。

使用 maven 管理。

     com.github.houbb
     iexcel
     0.0.2

你可以直接參考 ExcelUtilTest.java

定義一個需要寫入/讀取的 excel 對象。

ExcelFieldModel.java

只有聲明了 @ExcelField 的屬性才會被處理，使用說明：@ExcelField

public class ExcelFieldModel {

    @ExcelField
    private String name;

    @ExcelField(headName = "年齡")
    private String age;

    @ExcelField(mapKey = "EMAIL", writeRequire = false, readRequire = false)
    private String email;

    @ExcelField(mapKey = "ADDRESS", headName = "地址", writeRequire = true)
    private String address;
    
    //getter and setter
}

IExcelWriter 有幾個實現(xiàn)類，你可以直接 new 或者借助 ExcelUtil 類去創(chuàng)建。

IExcelWriter 接口說明

excelWriter03Test()

一個將對象列表寫入 2003 excel 文件的例子。

/**
 * 寫入到 03 excel 文件
 */
@Test
public void excelWriter03Test() {
    // 待生成的 excel 文件路徑
    final String filePath = "excelWriter03.xls";

    // 對象列表
    List models = buildModelList();

    try(IExcelWriter excelWriter = ExcelUtil.get03ExcelWriter();
        OutputStream outputStream = new FileOutputStream(filePath)) {
        // 可根據(jù)實際需要，多次寫入列表
        excelWriter.write(models);

        // 將列表內(nèi)容真正的輸出到 excel 文件
        excelWriter.flush(outputStream);
    } catch (IOException e) {
        throw new ExcelRuntimeException(e);
    }
}

buildModelList()

/**
 * 構(gòu)建測試的對象列表
 * @return 對象列表
 */
private List buildModelList() {
    List models = new ArrayList<>();
    ExcelFieldModel model = new ExcelFieldModel();
    model.setName("測試1號");
    model.setAge("25");
    model.setEmail("123@gmail.com");
    model.setAddress("貝克街23號");

    ExcelFieldModel modelTwo = new ExcelFieldModel();
    modelTwo.setName("測試2號");
    modelTwo.setAge("30");
    modelTwo.setEmail("125@gmail.com");
    modelTwo.setAddress("貝克街26號");

    models.add(model);
    models.add(modelTwo);
    return models;
}

有時候列表只寫入一次很常見，所有就簡單的封裝了下：

/**
 * 只寫入一次列表
 * 其實是對原來方法的簡單封裝
 */
@Test
public void onceWriterAndFlush07Test() {
    // 待生成的 excel 文件路徑
    final String filePath = "onceWriterAndFlush07.xlsx";

    // 對象列表
    List models = buildModelList();

    // 對應(yīng)的 excel 寫入對象
    IExcelWriter excelWriter = ExcelUtil.get07ExcelWriter();

    // 只寫入一次列表
    ExcelUtil.onceWriteAndFlush(excelWriter, models, filePath);
}

excel 讀取時會根據(jù)文件名稱判斷是哪個版本的 excel。

IExcelReader 有幾個實現(xiàn)類，你可以直接 new 或者借助 ExcelUtil 類去創(chuàng)建。

IExcelReader 接口說明

/**
 * 讀取測試
 */
@Test
public void readWriterTest() {
    File file = new File("excelWriter03.xls");
    IExcelReader excelReader = ExcelUtil.getExcelReader(file);
    List models = excelReader.readAll(ExcelFieldModel.class);
    System.out.println(models);
}

@ExcelField 的屬性說明如下：

/**
 * 寫出數(shù)據(jù)，本方法只是將數(shù)據(jù)寫入Workbook中的Sheet，并不寫出到文件

 * 

 * data中元素支持的類型有：
 *  
 * 1. Bean，既元素為一個Bean，第一個Bean的字段名列表會作為首行，剩下的行為Bean的字段值列表，data表示多行 

 * 
 * @param data 數(shù)據(jù)
 * @return this
 */
IExcelWriter write(Collection data);

/**
 * 寫出數(shù)據(jù)，本方法只是將數(shù)據(jù)寫入Workbook中的Sheet，并不寫出到文件

 *  將 map 按照 targetClass 轉(zhuǎn)換為對象列表
 *  應(yīng)用場景: 直接 mybatis mapper 查詢出的 map 結(jié)果，或者其他的構(gòu)造結(jié)果。
 * @param mapList map 集合
 * @param targetClass 目標類型
 * @return this
 */
IExcelWriter write(Collection> mapList, final Class targetClass);

/**
 * 將Excel Workbook刷出到輸出流
 *
 * @param outputStream 輸出流
 * @return this
 */
IExcelWriter flush(OutputStream outputStream);

創(chuàng)建 IExcelWriter 的時候，可以指定 sheet 的下標或者名稱。來指定寫入的 sheet。

創(chuàng)建 IExcelWriter 的后，可以調(diào)用 excelWriter.containsHead(bool) 指定是否生成 excel 表頭。

/**
 * 讀取當前 sheet 的所有信息
 * @param tClass 對應(yīng)的 javabean 類型
 * @return 對象列表
 */
List readAll(Class tClass);

/**
 * 讀取指定范圍內(nèi)的
 * @param tClass 泛型
 * @param startIndex 開始的行信息(從0開始)
 * @param endIndex 結(jié)束的行信息
 * @return 讀取的對象列表
 */
List read(Class tClass, final int startIndex, final int endIndex);

創(chuàng)建 IExcelReader 的時候，可以指定 sheet 的下標或者名稱。來指定讀取的 sheet。

注意：大文件 sax 讀取模式，只支持指定 sheet 的下標。

創(chuàng)建 IExcelReader 的后，可以調(diào)用 excelReader.containsHead(bool) 指定是否讀取 excel 表頭。

excel 導(dǎo)出最佳實踐

iexcel 框架