如何通過 Freemark 優雅地生成那些花里胡哨的復雜樣式 Excel 文件？

本文轉載自查看原文 2019-06-08 15:34 498 Spring Boot 2.0 教程

歡迎關注個人微信公眾號: 小哈學Java, 文末分享阿里 P8 高級架構師吐血總結的《Java 核心知識整理&面試.pdf》資源鏈接！！

個人網站: https://www.exception.site/essay/how-to-create-complex-style-excel-with-freemark

freemark生成復雜樣式excel

一、背景

小哈最近這段時間開始負責一個新的產品：下載中心。啥玩意這是？

產品的目的其實就是統一管控各業務組文件下載功能（包括一些海量數據的導出，文件合並上傳等），項目組不用自己再去實現各式各樣的文件（PDF, Word, Excel）生成, 統一對接下載中心，由下載中心統一完成文件的生成、合並、上傳、下載流程。

問題來了，這里面包括一些復雜文件的生成，如帶有復雜樣式的 Excel 文件，比如下面這個樣子的：

復雜Excel

這種復雜樣式的 Excel, 如果說放到各個業務線去實現還是好辦的，因為站在各個業務組的角度，場景變化不會太多，按照文件格式，代碼寫死即可。

但是站在下載中心的角度，因為需要對接各個業務中心，每個業務中心生成的樣式都不一樣，不可能每個業務組接進來，我都得定制的寫一套生成代碼吧！這顯然也不合常理！

那么，有沒有什么一勞永逸的辦法呢？答案是肯定的！

二、實現思路

要說實現方式，你的腦海里可能第一會想到傳統的 Apache poi，jxl ，亦或者是阿里出品 EasyExcel 等等。

PS: 關於阿里的 EasyExcel, 小哈之前有分享過，沒看過的小伙伴們，可以看下《7 行代碼優雅地實現 Excel 文件生成&下載功能》。

對於這種復雜樣式，要是用 Apache poi, jxl, 阿里 EasyExcel 去實現，不可避免的，代碼肯定會非常繁瑣。

有沒有啥優雅（偷懶的）的方式呢？

其實我們可以通過視圖引擎 Freemark、Velocity 來幫我們生成復雜樣式 Excel 文件，無需關心花里胡哨的復雜樣式，只關注於填充數據即可。接下來，我們以 Freemark 作為示例來講解，如何生成這個復雜樣式的 Excel 文件。

拓展閱讀: 什么是 Freemark ?

FreeMarker 是一款模板引擎：即一種基於模板和要改變的數據，並用來生成輸出文本(HTML網頁，電子郵件，配置文件，源代碼等)的通用工具。它不是面向最終用戶的，而是一個Java類庫，是一款程序員可以嵌入他們所開發產品的組件。

其實，對於Java 后端來說，它更常被用來服務端動態渲染 html 頁面返回給瀏覽器。前些年還比較火熱，近些年因為前后端分離的火熱，也開始慢慢淡出視野了。

三、快速上手

3.1 添加依賴

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

注意: 小哈這里基於 Spring Boot 寫的測試代碼，版本號可以無需指定，否則，你需要手動指定好版本號。

3.2 導出 xml 模板文件

首先，將復雜樣式的 Excel 文件另存為 .xml 視圖模板，如下圖所示：

打開 xml 模板文件，可以清晰的看到里面定義了各種節點，節點描述了整個 Excel 的樣式結構, 如下圖所示：

3.3 填充占位符

再回過頭來看下之前那個復雜 Excel 文件，觀察一下哪些單元格的值需要動態設置：

圖中用紅色特意標注出來了。

在剛剛另存為的 xml 模板文件中填寫 freemark 表達式，考慮到這里只是個示例 Demo, 僅僅選取幾個示例單元格來填寫占位符，如下所示：

訂單標題：

其他需要動態填充的單元格：

PS: xml 文件中，<Row> 節點代表一行，<Cell>代表一個單元格。

在需要動態填充數據的地方，加上相關 freemark 表達式，如 ${commodity.name!}，如下所示：

<Row ss:AutoFitHeight="0" ss:Height="54">
    <Cell ss:StyleID="s18"><Data ss:Type="String">1</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.name!}</Data></Cell>
    <Cell ss:StyleID="s18"/>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.num!}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.num1!}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">22</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">44</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">55</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">盒</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.price!}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.price2!}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.price3!}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.timestamp}</Data></Cell>
    <Cell ss:StyleID="s18"><Data ss:Type="String">${commodity.createTime?string('yyyy-MM-dd HH:mm:ss')}</Data></Cell>
    <Cell ss:StyleID="s18"/>
</Row>

按照服務端數據模型的定義，填寫好相應的字段名稱，再對照下后台 Commodity 商品類的定義：

這個商品類中，我們定義了不同類型的字段，如 String、int、Integer、Double、Float、金額類型 BigDecimal、日期類型 Date 等，用以測試對不同數據類型的兼容性。

確認相關屬性字段名無誤后，再來看下 freemark 生成 Excel 的核心代碼：

package site.exception.springbootfreemarkexcel;

import freemarker.template.Configuration;
import freemarker.template.Template;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import site.exception.springbootfreemarkexcel.entity.Commodity;

import java.io.File;
import java.io.FileWriter;
import java.math.BigDecimal;
import java.util.*;
/**
 * @author 犬小哈 （微信公眾號: 小哈學Java）
 * @site www.exception.site
 * @date 2019/5/21
 * @time 上午10:57
 * @discription
 **/
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootFreemarkExcelApplicationTests {

	@Test
	public void createExcelByFreemark() throws Exception {

		Configuration configuration = new Configuration(Configuration.VERSION_2_3_28);

		// 設置模板文件的父目錄
		configuration.setDirectoryForTemplateLoading(new File("/Users/a123123/Work/tmp_files"));

		// 加載模板文件
		Template template = configuration.getTemplate("/excel_template.xml", "UTF-8");

		// 數據准備，可以是從數據庫中查詢，這里為了方便演示，手動 new 了
		Map<String, Object> data = new HashMap<>();
		data.put("title", "測試標題1");

		List<Commodity> commodities = new ArrayList<>();
		Commodity commodity = Commodity.builder()
				.name("name1").num(11).num1(111)
				.price(new BigDecimal(11.1)).price2(new Double(11.11))
				.price3(new Float(11.1111))
				.createTime(new Date())
				.timestamp(System.currentTimeMillis())
				.build();

		commodities.add(commodity);

		// 生成 excel 文件
		template.process(data, new FileWriter("/Users/a123123/Work/tmp_files/excelByFreemark.xls"));
	}
}

可以看到生成復雜樣式的 Excel 的代碼非常簡潔。關於每一行代碼什么意思，注釋已經說得很清楚了，這里就不加以說明了。

運行單元測試，看下效果：