當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

惊了！7 行代码优雅地实现 Excel 文件生成下载功能

發(fā)布時間：2025/4/5 编程问答 66 豆豆

生活随笔收集整理的這篇文章主要介紹了惊了！7 行代码优雅地实现 Excel 文件生成下载功能小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

歡迎關(guān)注個人微信公眾號: 小哈學(xué)Java

個人網(wǎng)站: www.exception.site/essay/how-t…

一、前言

關(guān)于導(dǎo)出 Excel 文件，可以說是大多數(shù)服務(wù)中都需要集成的功能。那么，要如何優(yōu)雅快速地（偷懶地）去實現(xiàn)這個功能呢？

你可能第一想法是：這還不簡單？用 Apache 開源框架 poi, 或者 jxl 都可以實現(xiàn)啊。面向百度編程，把代碼模板 copy 下來，根據(jù)自己的業(yè)務(wù)再改改，能有多難？

你仿佛在逗我笑

嗯.. 的確不難，但是你的代碼可能是下面這個熊樣子的：

用傳統(tǒng)excel框架生成文件的代碼模板

上面這段代碼看上去是不是又臭又長呢？今天，小哈將教您如何使用 7 行代碼搞定 Excel 文件生成功能！

我要開始裝逼了

二、Apache poi、jxl 的缺陷

在說如何實現(xiàn)之前，我們先來討論一下傳統(tǒng) Excel 框架的不足！除了上面說的，Apache poi、jxl 都存在生成 excel 文件不夠簡單優(yōu)雅快速外，它們都還存在一個嚴(yán)重的問題，那就是非常耗內(nèi)存，嚴(yán)重時會導(dǎo)致內(nèi)存溢出。

POI 雖然目前來說，是 excel 解析框架中被使用最廣泛的，但這個框架并不完美。

為什么這么說呢？

開發(fā)者們大部分使用 POI，都是使用其 userModel 模式。而 userModel 的好處是上手容易使用簡單，隨便拷貝個代碼跑一下，剩下就是寫業(yè)務(wù)轉(zhuǎn)換了，雖然轉(zhuǎn)換也要寫上百行代碼，但是還是可控的。

然而 userModel 模式最大的問題是在于，對內(nèi)存消耗非常大，一個幾兆的文件解析甚至要用掉上百兆的內(nèi)存。現(xiàn)實情況是，很多應(yīng)用現(xiàn)在都在采用這種模式，之所以還正常在跑是因為并發(fā)不大，并發(fā)上來后，一定會OOM或者頻繁的 full gc。

三、阿里出品的 EasyExcel，安利一波

什么是 EasyExcel? 見名知意，就是讓你操作 Excel 異常的酸爽。先來看下 EasyExcel GitHub 官方截圖：

easyExcel GitHub 截圖

截止目前為止已有 5519 Star, 官方對其的簡介是：

快速、簡單避免OOM的java處理Excel工具！

以下是官方介紹：

esayExcel GitHub 簡介

四、EasyExcel 解決了什么

主要來說，有以下幾點：

傳統(tǒng) Excel 框架，如 Apache poi、jxl 都存在內(nèi)存溢出的問題；
傳統(tǒng) excel 開源框架使用復(fù)雜、繁瑣;
EasyExcel 底層還是使用的 poi, 但是做了很多優(yōu)化，比如修復(fù)了并發(fā)情況下的一些 bug, 具體修復(fù)細(xì)節(jié)，可閱讀官方文檔 github.com/alibaba/eas…；

好像很厲害的樣子

五、快速上手

5.1 添加依賴

<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>1.1.2-beta5</version> </dependency> 復(fù)制代碼

5.2 七行代碼搞定 Excel 生成

使用EasyExcel生成Excel模板代碼

@Test public void writeExcel1() throws Exception {// 文件輸出位置OutputStream out = new FileOutputStream("/Users/a123123/Work/tmp_files/test.xlsx");ExcelWriter writer = EasyExcelFactory.getWriter(out);// 寫僅有一個 Sheet 的 Excel 文件, 此場景較為通用Sheet sheet1 = new Sheet(1, 0, WriteModel.class);// 第一個 sheet 名稱sheet1.setSheetName("第一個sheet");// 寫數(shù)據(jù)到 Writer 上下文中// 入?yún)?: 創(chuàng)建要寫入的模型數(shù)據(jù)// 入?yún)?: 要寫入的目標(biāo) sheetwriter.write(createModelList(), sheet1);// 將上下文中的最終 outputStream 寫入到指定文件中writer.finish();// 關(guān)閉流out.close(); } 復(fù)制代碼

上面這段示例代碼中，有兩個點很重要，小哈已經(jīng)重點標(biāo)注標(biāo)：

①：WriteModel 這個對象就是要寫入 Excel 的數(shù)據(jù)模型對象，**等等，你這好像不行吧？表頭 head，以及每個單元格內(nèi)的數(shù)據(jù)順序都沒指定，能達(dá)到想要的效果么？別急，后面會討論這塊！
②：創(chuàng)建需要寫入的數(shù)據(jù)集，當(dāng)然了，正常業(yè)務(wù)中，這塊都是從數(shù)據(jù)庫中查詢出來的。

PS: 如果說寫入的數(shù)據(jù)量很大，需要做分片查詢再寫入的處理，否則可能會 OOM（Out of Memory）.

回過頭來，我們來看看 WriteModel 這個對象內(nèi)部到底有什么幺蛾子！

WriteModel對象

/*** @author 微信公眾號: 小哈學(xué)Java* @Site： www.exception.site* @date 2019/5/9* @time 下午2:07* @discription 寫入Excel模型對象**/ @Data @NoArgsConstructor @AllArgsConstructor @Builder public class WriteModel extends BaseRowModel {@ExcelProperty(value = "姓名", index = 0)private String name;@ExcelProperty(value = "密碼", index = 1)private String password;@ExcelProperty(value = "年齡", index = 2)private Integer age; } 復(fù)制代碼

ExayExcel 提供注解的方式, 來方便的定義 Excel 需要的數(shù)據(jù)模型：

①：首先，定義的寫入模型必須要繼承自 BaseRowModel.java;
②：通過 @ExcelProperty 注解來指定每個字段的列名稱，以及下標(biāo)位置；

同時，上面定義的 createModelList() 方法也很簡單，通過循環(huán)，創(chuàng)建一個寫入模型的 List 集合：

createModleList()

廢話不多說，這個快速接入的案例也介紹的差不多了，跑一跑單元測試看下實際效果：

測試結(jié)果

怎么樣，效果還是挺棒棒的！

厲害了

六、特殊場景支持

在實際的業(yè)務(wù)中，我們還會有一些特需的需求，比如說下面這些。

6.1 動態(tài)生成 Excel 內(nèi)容

上面的例子是基于注解的，也就是說表頭 head, 以及內(nèi)容都是寫死的，換句話說，我定義好了一個數(shù)據(jù)模型，那么，生成的 Excel 文件也就是只能遵循這種模型來了，但是，實際業(yè)務(wù)中可能會存在動態(tài)變化的需求，要怎么做呢？

動態(tài)生成Excel

@Test public void writeExcel2() throws Exception {// 文件輸出位置OutputStream out = new FileOutputStream("/Users/a123123/Work/tmp_files/test2.xlsx");ExcelWriter writer = EasyExcelFactory.getWriter(out);// 動態(tài)添加表頭，適用一些表頭動態(tài)變化的場景Sheet sheet1 = new Sheet(1, 0);sheet1.setSheetName("第一個sheet");// 創(chuàng)建一個表格，用于 Sheet 中使用Table table1 = new Table(1);// 無注解的模式，動態(tài)添加表頭table1.setHead(DataUtil.createTestListStringHead());// 寫數(shù)據(jù)writer.write1(createDynamicModelList(), sheet1, table1);// 將上下文中的最終 outputStream 寫入到指定文件中writer.finish();// 關(guān)閉流out.close(); } 復(fù)制代碼

①：無注解模式，動態(tài)添加表頭，也可自由組合復(fù)雜表頭，代碼如下：

動態(tài)生成Excel表頭數(shù)據(jù)

public static List<List<String>> createTestListStringHead(){// 模型上沒有注解，表頭數(shù)據(jù)動態(tài)傳入List<List<String>> head = new ArrayList<List<String>>();List<String> headCoulumn1 = new ArrayList<String>();List<String> headCoulumn2 = new ArrayList<String>();List<String> headCoulumn3 = new ArrayList<String>();List<String> headCoulumn4 = new ArrayList<String>();List<String> headCoulumn5 = new ArrayList<String>();headCoulumn1.add("第一列");headCoulumn1.add("第一列");headCoulumn1.add("第一列");headCoulumn2.add("第一列");headCoulumn2.add("第一列");headCoulumn2.add("第一列");headCoulumn3.add("第二列");headCoulumn3.add("第二列");headCoulumn3.add("第二列");headCoulumn4.add("第三列");headCoulumn4.add("第三列2");headCoulumn4.add("第三列2");headCoulumn5.add("第一列");headCoulumn5.add("第3列");headCoulumn5.add("第4列");head.add(headCoulumn1);head.add(headCoulumn2);head.add(headCoulumn3);head.add(headCoulumn4);head.add(headCoulumn5);return head; } 復(fù)制代碼

②：創(chuàng)建動態(tài)數(shù)據(jù)，注意這里的數(shù)據(jù)類型是 Object:

創(chuàng)建動態(tài)數(shù)據(jù)

跑一下單元測試，看下效果：

動態(tài)創(chuàng)建效果測試

6.2 自定義表頭以及內(nèi)容樣式

我想自定義表頭，內(nèi)容樣式，咋辦？

自定義表格樣式

我們復(fù)用了上面的示例代碼，并額外添加了設(shè)置自定義表格樣式的代碼, createTableStytle() 具體內(nèi)容如下：

創(chuàng)建表格樣式代碼

public static TableStyle createTableStyle() {TableStyle tableStyle = new TableStyle();// 設(shè)置表頭樣式Font headFont = new Font();// 字體是否加粗headFont.setBold(true);// 字體大小headFont.setFontHeightInPoints((short)12);// 字體headFont.setFontName("楷體");tableStyle.setTableHeadFont(headFont);// 背景色tableStyle.setTableHeadBackGroundColor(IndexedColors.BLUE);// 設(shè)置表格主體樣式Font contentFont = new Font();contentFont.setBold(true);contentFont.setFontHeightInPoints((short)12);contentFont.setFontName("黑體");tableStyle.setTableContentFont(contentFont);tableStyle.setTableContentBackGroundColor(IndexedColors.GREEN);return tableStyle; } 復(fù)制代碼

我們可以通過 TableStyle 這個類來設(shè)置表頭、表格主題的樣式。

6.3 合并單元格

我們可以通過 merge() 方法來合并單元格：

合并單元格

注意下標(biāo)是從 0 開始的，也就是說合并了第六行到第七行，其中的第一列到第五列，跑下代碼，看下效果：

合并單元格效果圖

6.4 自定義處理

對于更復(fù)雜的處理，EasyExcel 預(yù)留了 WriterHandler 接口來，允許你自定義處理代碼：

WriterHandler

接口中定義了三個方法:

sheet(): 在創(chuàng)建每個 sheet 后自定義業(yè)務(wù)邏輯處理；
row(): 在創(chuàng)建每個 row 后自定義業(yè)務(wù)邏輯處理；
cell(): 在創(chuàng)建每個 cell 后自定義業(yè)務(wù)邏輯處理；

我們實現(xiàn)了該接口后，編寫自定義邏輯處理代碼，然后調(diào)用 getWriterWithTempAndHandler() 靜態(tài)方法獲取 ExcelWriter 對象時，傳入 WriterHandler 的實現(xiàn)類即可。

傳入WriterHandler

比如下面的示例代碼：

ExcelWriter writer = EasyExcelFactory.getWriterWithTempAndHandler(null, out, ExcelTypeEnum.XLSX, true, new MyWriterHandler()); 復(fù)制代碼

七、Web 下載示例代碼

public class Down {@GetMapping("/a.htm")public void cooperation(HttpServletRequest request, HttpServletResponse response) {ServletOutputStream out = response.getOutputStream();ExcelWriter writer = new ExcelWriter(out, ExcelTypeEnum.XLSX, true);String fileName = new String(("UserInfo " + new SimpleDateFormat("yyyy-MM-dd").format(new Date())).getBytes(), "UTF-8");Sheet sheet1 = new Sheet(1, 0);sheet1.setSheetName("第一個sheet");writer.write0(getListString(), sheet1);writer.finish();response.setContentType("multipart/form-data");response.setCharacterEncoding("utf-8");response.setHeader("Content-disposition", "attachment;filename="+fileName+".xlsx");out.flush();}} 復(fù)制代碼

八、需要注意的點

8.1 寫入大數(shù)據(jù)時，需分片

比如說，我們需要從數(shù)據(jù)庫中查詢出數(shù)據(jù)量較大時，我們需要在業(yè)務(wù)層做分片處理，也就是，我們需要分多次查詢，再寫入，防止內(nèi)存溢出 OOM.

8.2 Excel 最大行數(shù)問題

Excel 03, 07 版本均有行數(shù)、列數(shù)的限制：

版本最大行最大列

Excel 2003	65536	256
Excel 2007	1048576	16384

csv 由于是文本文件，實際上沒有最大行數(shù)的限制，但是用 Excel 客戶端打開還是多了不顯示。

也就是說，如果你想寫入更多的行數(shù)是不行的，強行這么做，程序會報類似如下異常

Invalid row number (1048576) outside allowable range (0..1048575) 復(fù)制代碼

如何解決呢？

分多個 Excel 文件寫入;

同一個 Excel 文件，分多個 Sheet 寫入；

九、總結(jié)

小哈今天主要給小伙伴介紹了 EasyExcel, 為什么要使用它，以及演示了相關(guān)示例代碼。當(dāng)然了，EasyExcel 除了寫 Excel 文件外，它還有快速讀取 Excel 的功能，由于本文主要介紹的是：如何優(yōu)雅地實現(xiàn) Excel 文件生成，所以就沒有介紹了，有興趣的小伙伴們，也可以去 GitHub 官網(wǎng)去去查看相關(guān)文檔。

最后，祝您看完本文后有所收獲，下期見！

十、GitHub 源碼地址

github.com/weiwosuoai/…

十一、Ref

github.com/alibaba/eas…

免費分享 | 面試&學(xué)習(xí)福利資源

最近在網(wǎng)上發(fā)現(xiàn)一個不錯的 PDF 資源《Java 核心知識&面試.pdf》分享給大家，不光是面試，學(xué)習(xí)，你都值得擁有！！！

獲取方式: 關(guān)注公眾號: 小哈學(xué)Java, 后臺回復(fù)資源，既可免費無套路獲取資源鏈接，下面是目錄以及部分截圖：

關(guān)注微信公眾號【小哈學(xué)Java】,回復(fù)【資源】，即可免費無套路領(lǐng)取資源鏈接哦

重要的事情說兩遍，關(guān)注公眾號: 小哈學(xué)Java, 后臺回復(fù)資源，既可免費無套路獲取資源鏈接 ！！！

歡迎關(guān)注微信公眾號: 小哈學(xué)Java