Java 如何快速,優雅的實現導出Excel

前言:

春節假期剛剛過去,大傢是不是已經開始瞭搬磚生活啦,嘻嘻 o(∩_∩)o ,可我還在休假中呢 !

好啦,咱們言歸正傳,開始聊聊正文。做過後端管理系統的同學,大概率都會收到過實現 導出Excel 的功能需求,因為這個功能在後臺管理系統中是個必備功能。

那大傢是怎麼實現這個功能的呢?

  • 使用Apache提供POI組件實現;
  • 使用現成的、簡便的第三方工具庫(避免重復造輪子)

Hutool 工具庫中的Excel工具類
EasyExcel 阿裡開源的基於Java的簡單、省內存的讀寫Excel工具庫

接下來咱們來聊聊使用 Hutool、EasyExcel 工具庫實現導出Excel。

使用第三方庫實現導出Excel

業界有句話:不重復造輪子。 使用工具類可以減少日常繁瑣的編碼,減少重復的編碼時間,提高開發效率。 作為程序員,應該多善於利用工具減少代碼冗餘,美化自己的代碼。

使用 Hutool 工具庫實現導出Excel:

1、首先添加依賴
在pom.xml中添加上依賴:

<!--hutool 導出 Excel 工具組件-->
<dependency>
  <groupId>cn.hutool</groupId>
  <artifactId>hutool-all</artifactId>
  <version>5.1.0</version>
</dependency>

<!--POI組件-->
<dependency>
  <groupId>org.apache.poi</groupId>
  <artifactId>poi-ooxml</artifactId>
  <version>4.1.0</version>
</dependency>

上面除瞭引入瞭 hutool 依賴之外,還引入瞭 poi-ooxml 依賴,這個包會自動關聯引入poi包,且可以很好的支持Office2007+的文檔格式 。

2、然後使用工具類實現導出Excel

import cn.hutool.core.collection.CollUtil;
import cn.hutool.poi.excel.ExcelUtil;
import cn.hutool.poi.excel.ExcelWriter;
import cn.hutool.poi.excel.StyleSet;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Font;

import java.util.ArrayList;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * @PACKAGE_NAME: com.lyl.excel
 * @ClassName: HutoolExcelUtils
 * @Description: 使用 Hutool 中的工具類實現 Excel的導出
 * @Date: 2021-02-18 16:24
 * @Author: [木子雷] 公眾號
 **/
public class HutoolExcelUtils {


    /**
     * 導出Excel
     *
     * @param args
     */
    public static void main(String[] args) {

        ArrayList<Map<String, Object>> rows = CollUtil.newArrayList(data());
        ExcelWriter writer = null;

        try {
            String path = "E:/QQPCmgr/Desktop/";

            String excelName = "Hutool" + System.currentTimeMillis() + ".xlsx";
            // 通過工具類創建writer,固定的文件輸出路徑
            writer = ExcelUtil.getWriter(path + excelName);

            // 定義第一行合並單元格樣式
            CellStyle headCellStyle = writer.getHeadCellStyle();
            // 設置內容字體
            Font font = writer.createFont();
            // 字體加粗
            font.setBold(true);
            // 字體顏色
            font.setColor(Font.COLOR_RED);
            headCellStyle.setFont(font);

            // 設置第 0 列的單元格的寬度,列數從零開始計算
            writer.setColumnWidth(0, 20);
            writer.setColumnWidth(1, 20);
            writer.setColumnWidth(2, 20);

            // 定義數據行的樣式
            StyleSet style = writer.getStyleSet();
            // 設置單元格文本內容自動換行
            style.setWrapText();

            // 合並單元格後的標題行(第一行),使用默認標題樣式
            writer.merge(rows.get(0).size() - 1, "導出測試:TEST");
            // 一次性寫出內容,使用默認樣式,強制輸出標題
            writer.write(rows, true);

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (writer != null) {
                // 記住關閉 writer,釋放內存
                writer.close();
            }
        }
    }


    /**
     * 構造 導出的數據
     *
     * @return
     */
    public static List<Map<String, Object>> data() {
        // 導出的數據
        ArrayList<Map<String, Object>> rows = new ArrayList<>();

        for (int i = 0; i < 10; i++) {
            Map<String, Object> row = new LinkedHashMap<>();

            row.put("字符串標題", "字符串" + i);
            row.put("日期標題", new Date());
            row.put("數字標題", 0.56);
            rows.add(row);
        }
        return rows;
    }

}

註意:

  • 記得修改代碼中導出Excel的路徑 path
  • 導出Excel的樣式是可以靈活變化的,可以自行進行設置

3、導出Excel的樣式如下

4、註意事項

  • 在導出大數據量時,可能會出現內存溢出的問題,不要擔心,Hutool也為我們提供瞭 BigExcelWriter 來避免大數據量輸出時可能會出現的內存溢出問題。
  • 上面的例子中,隻實現瞭部分的樣式設置,Hutool還提供瞭許多其它的樣式,大傢可以自行去嘗試;並且 Hutool 也支持寫出到 Web客戶端下載 。

官方文檔地址: Hutool 操作 Excel

使用 EasyExcel 工具庫實現導出Excel:

EasyExcel是一個基於Java的簡單、省內存的讀寫Excel的 阿裡開源 項目;正如它在GitHub中項目代碼介紹的那樣:一個快速、簡單避免OOM的java處理Excel工具。

測試得知 64M內存1分鐘內讀取75M(46W行25列)的Excel ;除此之外還有 急速模式 能更快,但是內存占用會在100M多一點 。

1、首先添加依賴

<!--  阿裡開源的 excel 工具類庫 -->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>easyexcel</artifactId>
  <version>2.2.6</version>
</dependency>

註意: 此依賴不能和 poi-ooxml 依賴在一起用,否則運行時會報 類找不到 的異常。

2、然後使用工具類實現導出Excel
①、導出的數據模版類:

import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentFontStyle;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.ContentStyle;
import com.alibaba.excel.annotation.write.style.HeadFontStyle;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;
import com.alibaba.excel.annotation.write.style.HeadStyle;
import org.apache.poi.ss.usermodel.FillPatternType;

import java.util.Date;

/**
 * @PACKAGE_NAME: com.lyl.excel
 * @ClassName: DemoData
 * @Description:  使用 EasyExcel 導出數據時的數據模版
 * @Date: 2021-01-27 17:46
 * @Author: [木子雷] 公眾號
 **/

// 標題行 背景設置成紅色 IndexedColors.RED.getIndex()
@HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 10)
// 標題行 字體設置成20
@HeadFontStyle(fontHeightInPoints = 20)
@ContentRowHeight(25)// 文本內容行的高度
@HeadRowHeight(30)// 標題行的高度
@ColumnWidth(20)// 全局的列寬
public class DemoData {

    // 字符串的列內容 背景設置成天藍 IndexedColors.SKY_BLUE.getIndex()
    @ContentStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 40)
    // 字符串的列內容 字體設置成20
    @ContentFontStyle(fontHeightInPoints = 20)
    @ExcelProperty({"導出測試:TEST", "字符串標題"})
    private String string;

    @ColumnWidth(30)
    @ExcelProperty({"導出測試:TEST", "日期標題"})
    private Date date;

    @ExcelProperty({"導出測試:TEST", "數字標題"})
    private Double doubleData;

    /**
     * 忽略這個字段
     */
    @ExcelIgnore
    private String ignore;

    public String getString() {
        return string;
    }

    public void setString(String string) {
        this.string = string;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    public Double getDoubleData() {
        return doubleData;
    }

    public void setDoubleData(Double doubleData) {
        this.doubleData = doubleData;
    }

    public String getIgnore() {
        return ignore;
    }

    public void setIgnore(String ignore) {
        this.ignore = ignore;
    }
}

註意: 這個數據模版類中使用瞭大量的 自定義註解 ,通過使用註解可以使代碼變得更加的優雅、簡潔 。

關於項目中自定義註解的實際使用可以參考:自定義註解的魅力你到底懂不懂

②、實現數據導出到Excel:

import com.alibaba.excel.EasyExcel;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * @PACKAGE_NAME: com.lyl.excel
 * @ClassName: EasyExcelUtils
 * @Description: 阿裡巴巴 開源的  easyexcel 工具
 * @Date: 2021-01-20 16:58
 * @Author: [木子雷] 公眾號
 **/
public class EasyExcelUtils {


    public static void main(String[] args) {
        // 導出Excel的路徑
        String path = "E:/QQPCmgr/Desktop/";

        // 導出Excel路徑 + 文件名稱
        String filename = path + "EasyExcel" + System.currentTimeMillis() + ".xlsx";

        /**
         * 導出excel
         * filename:導出excel全路徑
         * DemoData.class:導出excel時的 數據模版
         * 模板:指的是導出excel的sheet頁
         * data():構造的DemoData.class數據模版的數據集合 
         */
        EasyExcel.write(filename, DemoData.class).sheet("模板").doWrite(data());
    }


    /**
     * 構造 導出的數據
     *
     * @return
     */
    private static List<DemoData> data() {
        List<DemoData> list = new ArrayList<DemoData>();
        for (int i = 0; i < 10; i++) {
            DemoData data = new DemoData();
            data.setString("字符串" + i);
            data.setDate(new Date());
            data.setDoubleData(0.56);
            list.add(data);
        }
        return list;
    }
}

註意:

記得修改代碼中導出Excel的路徑 path

  • 導出Excel的樣式是可以靈活變化的,可以自行進行設置

3、導出Excel的樣式如下

4、EasyExcel 導出Excel擴展:

上面導出Excel的例子中,隻實現瞭其中一部分功能,還有很多功能由於篇幅原因沒法一一展示出來,在這就簡單說下支持的其它功能:

  • 通過設置 隻導出模版數據中的指定列數據
  • 通過設置 將模版數據中的列數據導出到Excel中指定的列上
  • 可以將導出的數據分多個批次導入到同一個Excel中,避免大數據量時的內存溢出問題
  • 導出數據的自定義格式轉換,例如:日志、數字的格式轉換等
  • 支持將圖片導出到Excel中
  • 支持根據已有的Excel模版樣式 將數據導出Excel
  • 支持單元格合並、表格方式導出、自動列寬、設置單元格下拉、超鏈接等、以及插入批註
  • 除瞭上面的導出Excel功能之外,EasyExcel還支持 讀取Excel數據、Web客戶端的上傳、下載等 ;

官方文檔地址: 阿裡開源 EasyExcel

項目代碼地址: alibaba/easyexcel

EasyExcel項目代碼拉取下來後,可以直接去單元測試包下,查看已提供的功能測試使用方法:

以上就是Java 如何快速,優雅的實現導出Excel的詳細內容,更多關於Java 實現導出Excel的資料請關註WalkonNet其它相關文章!