快捷導(dǎo)航

Java 如何快速,優(yōu)雅的實(shí)現(xiàn)導(dǎo)出Excel

更新時(shí)間：2021年03月29日 11:18:06 作者：木子雷

這篇文章主要介紹了Java 如何快速,優(yōu)雅的實(shí)現(xiàn)導(dǎo)出Excel，幫助大家更好的理解和學(xué)習(xí)使用Java，感興趣的朋友可以了解下

前言：

春節(jié)假期剛剛過(guò)去，大家是不是已經(jīng)開(kāi)始了搬磚生活啦，嘻嘻 o(∩_∩)o ，可我還在休假中呢 !

好啦，咱們言歸正傳，開(kāi)始聊聊正文。做過(guò)后端管理系統(tǒng)的同學(xué)，大概率都會(huì)收到過(guò)實(shí)現(xiàn) 導(dǎo)出Excel 的功能需求，因?yàn)檫@個(gè)功能在后臺(tái)管理系統(tǒng)中是個(gè)必備功能。

那大家是怎么實(shí)現(xiàn)這個(gè)功能的呢？

使用Apache提供POI組件實(shí)現(xiàn)；
使用現(xiàn)成的、簡(jiǎn)便的第三方工具庫(kù)（避免重復(fù)造輪子）

Hutool 工具庫(kù)中的Excel工具類(lèi)
EasyExcel 阿里開(kāi)源的基于Java的簡(jiǎn)單、省內(nèi)存的讀寫(xiě)Excel工具庫(kù)

接下來(lái)咱們來(lái)聊聊使用 Hutool、EasyExcel 工具庫(kù)實(shí)現(xiàn)導(dǎo)出Excel。

使用第三方庫(kù)實(shí)現(xiàn)導(dǎo)出Excel

業(yè)界有句話：不重復(fù)造輪子。使用工具類(lèi)可以減少日常繁瑣的編碼，減少重復(fù)的編碼時(shí)間，提高開(kāi)發(fā)效率。作為程序員，應(yīng)該多善于利用工具減少代碼冗余，美化自己的代碼。

使用 Hutool 工具庫(kù)實(shí)現(xiàn)導(dǎo)出Excel：

1、首先添加依賴(lài)
在pom.xml中添加上依賴(lài)：

<!--hutool 導(dǎo)出 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 依賴(lài)之外，還引入了 poi-ooxml 依賴(lài)，這個(gè)包會(huì)自動(dòng)關(guān)聯(lián)引入poi包，且可以很好的支持Office2007+的文檔格式。

2、然后使用工具類(lèi)實(shí)現(xiàn)導(dǎo)出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 中的工具類(lèi)實(shí)現(xiàn) Excel的導(dǎo)出
 * @Date: 2021-02-18 16:24
 * @Author: [木子雷] 公眾號(hào)
 **/
public class HutoolExcelUtils {


    /**
     * 導(dǎo)出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";
            // 通過(guò)工具類(lèi)創(chuàng)建writer,固定的文件輸出路徑
            writer = ExcelUtil.getWriter(path + excelName);

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

            // 設(shè)置第 0 列的單元格的寬度，列數(shù)從零開(kāi)始計(jì)算
            writer.setColumnWidth(0, 20);
            writer.setColumnWidth(1, 20);
            writer.setColumnWidth(2, 20);

            // 定義數(shù)據(jù)行的樣式
            StyleSet style = writer.getStyleSet();
            // 設(shè)置單元格文本內(nèi)容自動(dòng)換行
            style.setWrapText();

            // 合并單元格后的標(biāo)題行（第一行），使用默認(rèn)標(biāo)題樣式
            writer.merge(rows.get(0).size() - 1, "導(dǎo)出測(cè)試：TEST");
            // 一次性寫(xiě)出內(nèi)容，使用默認(rèn)樣式，強(qiáng)制輸出標(biāo)題
            writer.write(rows, true);

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (writer != null) {
                // 記住關(guān)閉 writer，釋放內(nèi)存
                writer.close();
            }
        }
    }


    /**
     * 構(gòu)造 導(dǎo)出的數(shù)據(jù)
     *
     * @return
     */
    public static List<Map<String, Object>> data() {
        // 導(dǎo)出的數(shù)據(jù)
        ArrayList<Map<String, Object>> rows = new ArrayList<>();

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

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

}

注意：

記得修改代碼中導(dǎo)出Excel的路徑 path
導(dǎo)出Excel的樣式是可以靈活變化的，可以自行進(jìn)行設(shè)置

3、導(dǎo)出Excel的樣式如下

4、注意事項(xiàng)

在導(dǎo)出大數(shù)據(jù)量時(shí)，可能會(huì)出現(xiàn)內(nèi)存溢出的問(wèn)題，不要擔(dān)心，Hutool也為我們提供了 BigExcelWriter 來(lái)避免大數(shù)據(jù)量輸出時(shí)可能會(huì)出現(xiàn)的內(nèi)存溢出問(wèn)題。
上面的例子中，只實(shí)現(xiàn)了部分的樣式設(shè)置，Hutool還提供了許多其它的樣式，大家可以自行去嘗試；并且 Hutool 也支持寫(xiě)出到 Web客戶端下載。

官方文檔地址： Hutool 操作 Excel

使用 EasyExcel 工具庫(kù)實(shí)現(xiàn)導(dǎo)出Excel：

EasyExcel是一個(gè)基于Java的簡(jiǎn)單、省內(nèi)存的讀寫(xiě)Excel的阿里開(kāi)源項(xiàng)目；正如它在GitHub中項(xiàng)目代碼介紹的那樣：一個(gè)快速、簡(jiǎn)單避免OOM的java處理Excel工具。

測(cè)試得知 64M內(nèi)存1分鐘內(nèi)讀取75M(46W行25列)的Excel ；除此之外還有急速模式能更快，但是內(nèi)存占用會(huì)在100M多一點(diǎn) 。

1、首先添加依賴(lài)

<!--  阿里開(kāi)源的 excel 工具類(lèi)庫(kù) -->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>easyexcel</artifactId>
  <version>2.2.6</version>
</dependency>

注意：此依賴(lài)不能和 poi-ooxml 依賴(lài)在一起用，否則運(yùn)行時(shí)會(huì)報(bào) 類(lèi)找不到的異常。

2、然后使用工具類(lèi)實(shí)現(xiàn)導(dǎo)出Excel
①、導(dǎo)出的數(shù)據(jù)模版類(lèi)：

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 導(dǎo)出數(shù)據(jù)時(shí)的數(shù)據(jù)模版
 * @Date: 2021-01-27 17:46
 * @Author: [木子雷] 公眾號(hào)
 **/

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

    // 字符串的列內(nèi)容 背景設(shè)置成天藍(lán) IndexedColors.SKY_BLUE.getIndex()
    @ContentStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 40)
    // 字符串的列內(nèi)容 字體設(shè)置成20
    @ContentFontStyle(fontHeightInPoints = 20)
    @ExcelProperty({"導(dǎo)出測(cè)試：TEST", "字符串標(biāo)題"})
    private String string;

    @ColumnWidth(30)
    @ExcelProperty({"導(dǎo)出測(cè)試：TEST", "日期標(biāo)題"})
    private Date date;

    @ExcelProperty({"導(dǎo)出測(cè)試：TEST", "數(shù)字標(biāo)題"})
    private Double doubleData;

    /**
     * 忽略這個(gè)字段
     */
    @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;
    }
}

注意：這個(gè)數(shù)據(jù)模版類(lèi)中使用了大量的自定義注解，通過(guò)使用注解可以使代碼變得更加的優(yōu)雅、簡(jiǎn)潔。

關(guān)于項(xiàng)目中自定義注解的實(shí)際使用可以參考：自定義注解的魅力你到底懂不懂

②、實(shí)現(xiàn)數(shù)據(jù)導(dǎo)出到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: 阿里巴巴 開(kāi)源的  easyexcel 工具
 * @Date: 2021-01-20 16:58
 * @Author: [木子雷] 公眾號(hào)
 **/
public class EasyExcelUtils {


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

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

        /**
         * 導(dǎo)出excel
         * filename：導(dǎo)出excel全路徑
         * DemoData.class：導(dǎo)出excel時(shí)的 數(shù)據(jù)模版
         * 模板：指的是導(dǎo)出excel的sheet頁(yè)
         * data()：構(gòu)造的DemoData.class數(shù)據(jù)模版的數(shù)據(jù)集合 
         */
        EasyExcel.write(filename, DemoData.class).sheet("模板").doWrite(data());
    }


    /**
     * 構(gòu)造 導(dǎo)出的數(shù)據(jù)
     *
     * @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;
    }
}

注意：

記得修改代碼中導(dǎo)出Excel的路徑 path

導(dǎo)出Excel的樣式是可以靈活變化的，可以自行進(jìn)行設(shè)置

3、導(dǎo)出Excel的樣式如下

4、EasyExcel 導(dǎo)出Excel擴(kuò)展：

上面導(dǎo)出Excel的例子中，只實(shí)現(xiàn)了其中一部分功能，還有很多功能由于篇幅原因沒(méi)法一一展示出來(lái)，在這就簡(jiǎn)單說(shuō)下支持的其它功能：

通過(guò)設(shè)置只導(dǎo)出模版數(shù)據(jù)中的指定列數(shù)據(jù)
通過(guò)設(shè)置將模版數(shù)據(jù)中的列數(shù)據(jù)導(dǎo)出到Excel中指定的列上
可以將導(dǎo)出的數(shù)據(jù)分多個(gè)批次導(dǎo)入到同一個(gè)Excel中，避免大數(shù)據(jù)量時(shí)的內(nèi)存溢出問(wèn)題
導(dǎo)出數(shù)據(jù)的自定義格式轉(zhuǎn)換，例如：日志、數(shù)字的格式轉(zhuǎn)換等
支持將圖片導(dǎo)出到Excel中
支持根據(jù)已有的Excel模版樣式將數(shù)據(jù)導(dǎo)出Excel
支持單元格合并、表格方式導(dǎo)出、自動(dòng)列寬、設(shè)置單元格下拉、超鏈接等、以及插入批注
除了上面的導(dǎo)出Excel功能之外，EasyExcel還支持讀取Excel數(shù)據(jù)、Web客戶端的上傳、下載等；

官方文檔地址：阿里開(kāi)源 EasyExcel

項(xiàng)目代碼地址： alibaba/easyexcel

EasyExcel項(xiàng)目代碼拉取下來(lái)后，可以直接去單元測(cè)試包下，查看已提供的功能測(cè)試使用方法：