原文連結: https://blog.csdn.net/sunnyzyq/article/details/121994504

前言
最近抽了兩天時間，把Java實現表格的相關操作進行了封裝，本次封裝是基於 POI 的二次開發，最終使用只需要呼叫一個工具類中的方法，就能滿足業務中絕大部門的匯入和匯出需求。

1. 功能測試
1.1 測試準備
在做測試前，我們需要將【2. 環境準備】中的四個檔案拷貝在工程裡（如：我這裡均放在了com.zyq.util.excel 包下）。

1.2 資料匯入
1.2.1 匯入解析為JSON
比如，我們有下面一個表格：

Controller 程式碼：

@PostMapping("/import")
public JSONArray importUser(@RequestPart("file")MultipartFile file) throws Exception {
JSONArray array = ExcelUtils.readMultipartFile(file);
System.out.println("匯入資料為:" + array);
return array;
}
測試效果：

1.2.2 匯入解析為物件（基礎）
首先，你需要建立一個與匯入表格對應的Java實體物件，並打上對應的Excel解析的匯入註解，@ExcelImport註解的value則為表頭名稱。

Controller 程式碼：

@PostMapping("/import")
public void importUser(@RequestPart("file")MultipartFile file) throws Exception {
List<User> users = ExcelUtils.readMultipartFile(file, User.class);
for (User user : users) {
System.out.println(user.toString());
}
}
測試效果：

1.2.3 匯入解析為物件（欄位自動對映）
對於有的列舉資料，通常我們匯入的時候，表格中的資料是值，而在資料儲存時，往往用的是鍵，比如：我們用sex=1可以表示為男，sex=2表示為女，那麼我們通過配置也可以達到匯入時，資料的自動對映。

那麼，我們只需要將Java實體中的物件sex欄位的型別改為對應的數字型別Integer，然後再註解中配置好 kv 屬性（屬性格式為：鍵1-值1;鍵2-值2;鍵3-值3;.....）

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：可以看到已經自動對映成功了。

1.2.4 匯入解析為物件（獲取行號）
我們在做頁面資料匯入時，有時候可能需要獲取行號，好追蹤匯入的資料。

那麼，我們只需要在對應的實體中加入一個 int 型別的 rowNum 欄位即可。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：

1.2.5 匯入解析為物件（獲取原始資料）
在做頁面資料匯入的時候，如果某行存在錯誤，一般我們會將原始的資料拿出來分析，為什麼會造成資料錯誤。那麼，我們在實體類中，增加一個 String 型別的 rowData 欄位即可。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：

1.2.6 匯入解析為物件（獲取錯誤提示）
當我們在匯入資料的時候，如果某行資料存在，欄位型別不正確，長度超過最大限制（詳見1.2.7），必填欄位驗證（1.2.8），資料唯一性驗證（1.2.9）等一些錯誤時候，我們可以往物件中新增一個 String 型別的 rowTips 欄位，則可以直接拿到對應的錯誤資訊。

比如，我們將表格中趙子龍的性別改為F（F並不是對映資料），將大喬的性別改為二十八（不能轉換為Integer型別資料）。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：可以看到，我們可以通過 rowTips 直接拿到對應的錯誤資料提示。

1.2.7 匯入解析為物件（限制欄位長度）
比如，我們手機通常為11為長度，那麼不妨限制電話的最大長度位數為11位。

對應的做法，就是在 @ExcelImport 註解中，設定 maxLength = 11 即可。

比如，我們將諸葛孔明的電話長度設定為超過11位數的一個字串。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：

1.2.8 匯入解析為物件（必填欄位驗證）
我們在做資料匯入的時候，往往還會有一些必填欄位，比如使用者的名稱，電話。

那麼，我們只需要在 @ExcelImport 註解屬性中，加上 required = true 即可。

我們將諸葛孔明的電話，以及第4行的姓名去掉，進行測試。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：

1.2.9 匯入解析為物件（資料唯一性驗證）
(1) 單欄位唯一性驗證

我們在匯入資料的時候，某個欄位是具有唯一性的，比如我們這裡假設規定姓名不能重複，那麼則可以在對應欄位的 @ExcelImport 註解上加上 unique = true 屬性。

這裡我們構建2條姓名一樣的資料進行測試。

Cotroller 程式碼略（和 1.2.2 完全一致）。

測試效果：

（2）多欄位唯一性驗證

如果你匯入的資料存在多欄位唯一性驗證這種情況，只需要將每個對應欄位的 @ExcelImport 註解屬性中，都加上 required = true 即可。

比如：我們將姓名和電話兩個欄位進行聯合唯一性驗證（即不能存在有名稱和電話都一樣的資料，單個欄位屬性重複允許）。

首先，我們將剛剛（1）的資料進行匯入。

測試效果：可以看到，雖然名稱有相同，但電話不相同，所以這裡並沒有提示唯一性驗證錯誤。

現在，我們將最後一行的電話也改為和第1行一樣的，於是，現在就存在了違背唯一性的兩條資料。

測試效果：可以看到，我們的聯合唯一性驗證生效了。

1.2.10 匯入多Sheet頁
如果你的匯入表格存在多個sheet頁（如下圖），並想解析每個sheet頁的資料，那麼也是可以的。

Controller 程式碼：

@PostMapping("/import")
public void upload(@RequestPart("file") MultipartFile file) throws Exception {
Map<String, JSONArray> map = ExcelUtils.readFileManySheet(file);
map.forEach((key, value) -> {
System.out.println("Sheet名稱：" + key);
System.out.println("Sheet資料：" + value);
System.out.println("----------------------");
});
}
程式碼截圖：

測試效果：

1.3 資料匯出
1.3.1 動態匯出（基礎）
這種方式十分靈活，表中的資料，完全自定義設定。

Controller 程式碼：

@GetMapping("/export")
public void export(HttpServletResponse response) {
// 表頭資料
List<Object> head = Arrays.asList("姓名","年齡","性別","頭像");
// 使用者1資料
List<Object> user1 = new ArrayList<>();
user1.add("諸葛亮");
user1.add(60);
user1.add("男");
user1.add("https://profile.csdnimg.cn/A/7/3/3_sunnyzyq");
// 使用者2資料
List<Object> user2 = new ArrayList<>();
user2.add("大喬");
user2.add(28);
user2.add("女");
user2.add("https://profile.csdnimg.cn/6/1/9/0_m0_48717371");
// 將資料彙總
List<List<Object>> sheetDataList = new ArrayList<>();
sheetDataList.add(head);
sheetDataList.add(user1);
sheetDataList.add(user2);
// 匯出資料
ExcelUtils.export(response,"使用者表", sheetDataList);
}
程式碼截圖：

由於是 get 請求，我們直接在瀏覽器上輸入請求地址即可觸發下載。

開啟下載表格，我們可以看到，表中的資料和我們程式碼組裝的順序一致。

1.3.2 動態匯出（匯出圖片）
如果你的匯出中，需要將對應圖片連結直接顯示為圖片的話，那麼，這裡也是可以的，只需要將對應的型別轉為 java.net.URL 型別即可（注意：轉的時候有異常處理，為了方便演示，我這裡直接丟擲）

測試效果：

1.3.3 動態匯出（實現下拉列表）
我們在做一些資料匯出的時候，可能要對某一行的下拉資料進行約束限制。

比如，當我們下載一個匯入模版的時候，我們可以將性別，城市對應的列設定為下拉選擇。

測試效果：

1.3.4 動態匯出（橫向合併）
比如，我們將表頭橫向合併，只需要將合併的單元格設定為 ExcelUtils.COLUMN_MERGE 即可。

測試效果：可以看到表頭的地址已經被合併了。

1.3.5 動態匯出（縱向合併）
除了橫向合併，我們還可以進行縱向合併，只需要將合併的單元格設定為 ExcelUtils.ROW_MERGE 即可。

測試效果：

1.3.6 匯出模板（基礎）
我們在做資料匯入的時候，往往首先會提供一個模版供其下載，這樣使用者在匯入的時候才知道如何去填寫資料。匯出模板除了可以用上面的動態匯出，這裡還提供了一種更加便捷的寫法。只需要建立一個類，然後再對應欄位上打上 @ExcelExport 註解類即可。

Controller 程式碼：

@GetMapping("/export")
public void export(HttpServletResponse response) {
ExcelUtils.exportTemplate(response, "使用者表", User.class);
}
程式碼截圖：

測試效果：

1.3.7 匯出模板（附示例資料）
我們在做模版下載時候，有時往往會攜帶一條樣本資料，好提示使用者資料格式是什麼，那麼我們只需要在對應欄位上進行配置即可。

Controller程式碼：

測試效果：

1.3.8 按物件匯出（基礎）
我們還可以通過 List 物件，對資料直接進行匯出。首先，同樣需要在對應類的欄位上，設定匯出名稱。

Controller 程式碼：

測試效果：

1.3.9 按物件匯出（資料對映）
在上面 1.3.8 的匯出中，我們可以看到，性別資料匯出來是1和2，這個不利於使用者體驗，應該需要轉換為對應的中文，我們可以在欄位註解上進行對應的配置。

Controller 程式碼略（和1.3.8完全一致）

測試效果：可以看到1和2顯示為了對應的男和女

1.3.10 按物件匯出（調整表頭順序）
如果你需要對錶頭欄位進行排序，有兩種方式：

第一種：按照表格的順序，排列Java類中的欄位；

第二種：在 @ExcelExport 註解中，指定 sort 屬性，其值越少，排名越靠前。

Controller 程式碼略（和1.3.8完全一致）

測試效果：可以看到，此時匯出資料的表頭順序，和我們指定的順序完全一致。

1.3.11 多Sheet頁匯出
Controller 程式碼（示例）：

/**
* 匯出多 Sheet 頁實現
*/
@GetMapping("/exportManySheet")
public void exportManySheet(HttpServletResponse response) {
// 第 1 個 Sheet 頁
List<List<Object>> sheet1 = new ArrayList<>();
List<Object> sheet1Head = new ArrayList<>();
sheet1Head.add("姓名");
sheet1Head.add("數學");
sheet1Head.add("英語");
sheet1.add(sheet1Head);
List<Object> row1 = new ArrayList<>();
row1.add("Jack");
row1.add(85);
row1.add(100);
sheet1.add(row1);
List<Object> row2 = new ArrayList<>();
row2.add("Marry");
row2.add(85);
row2.add(100);
sheet1.add(row2);
// 第 2 個 Sheet 頁
List<List<Object>> sheet2 = new ArrayList<>();
List<Object> sheet2Head = new ArrayList<>();
sheet2Head.add("姓名");
sheet2Head.add("音樂");
sheet2Head.add("美術");
sheet2.add(sheet2Head);
List<Object> row01 = new ArrayList<>();
row01.add("Jack");
row01.add(77);
row01.add(66);
sheet2.add(row01);
List<Object> row02 = new ArrayList<>();
row02.add("Marry");
row02.add(99);
row02.add(88);
sheet2.add(row02);
// 將兩個 Sheet 頁新增到集合中
Map<String, List<List<Object>>> sheets = new LinkedHashMap<>();
sheets.put("文化課", sheet1);
sheets.put("藝術課", sheet2);
// 匯出資料
ExcelUtils.exportManySheet(response, "學生成績表", sheets);
}
測試效果：

第一個 Sheet 頁

第二個 Sheet 頁

2. 環境準備
2.1 Maven 依賴
本次工具類的封裝主要依賴於阿里巴巴的JSON包，以及表格處理的POI包，所以我們需要匯入這兩個庫的依賴包，另外，我們還需要檔案上傳的相關包，畢竟我們在瀏覽器頁面，做Excel匯入時，是上傳的Excel檔案。

<!-- 檔案上傳 -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpmime</artifactId>
<version>4.5.7</version>
</dependency>
<!-- JSON -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.41</version>
</dependency>
<!-- POI -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.16</version>
</dependency>
2.2 類檔案
ExcelUtils
package com.zyq.utils.excel;

import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import org.apache.poi.hssf.usermodel.HSSFDataValidation;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.usermodel.ClientAnchor.AnchorType;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.ss.util.CellRangeAddressList;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.net.URL;
import java.text.NumberFormat;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.Map.Entry;

/**
* Excel匯入匯出工具類
* 原文連結（不定時增加新功能）: https://zyqok.blog.csdn.net/article/details/121994504
*
* @author sunnyzyq
* @date 2021/12/17
*/
public class ExcelUtils {

private static final String XLSX = ".xlsx";
private static final String XLS = ".xls";
public static final String ROW_MERGE = "row_merge";
public static final String COLUMN_MERGE = "column_merge";
private static final String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";
private static final String ROW_NUM = "rowNum";
private static final String ROW_DATA = "rowData";
private static final String ROW_TIPS = "rowTips";
private static final int CELL_OTHER = 0;
private static final int CELL_ROW_MERGE = 1;
private static final int CELL_COLUMN_MERGE = 2;
private static final int IMG_HEIGHT = 30;
private static final int IMG_WIDTH = 30;
private static final char LEAN_LINE = '/';
private static final int BYTES_DEFAULT_LENGTH = 10240;
private static final NumberFormat NUMBER_FORMAT = NumberFormat.getNumberInstance();


public static <T> List<T> readFile(File file, Class<T> clazz) throws Exception {
JSONArray array = readFile(file);
return getBeanList(array, clazz);
}

public static <T> List<T> readMultipartFile(MultipartFile mFile, Class<T> clazz) throws Exception {
JSONArray array = readMultipartFile(mFile);
return getBeanList(array, clazz);
}

public static JSONArray readFile(File file) throws Exception {
return readExcel(null, file);
}

public static JSONArray readMultipartFile(MultipartFile mFile) throws Exception {
return readExcel(mFile, null);
}

public static Map<String, JSONArray> readFileManySheet(File file) throws Exception {
return readExcelManySheet(null, file);
}

public static Map<String, JSONArray> readFileManySheet(MultipartFile file) throws Exception {
return readExcelManySheet(file, null);
}

private static <T> List<T> getBeanList(JSONArray array, Class<T> clazz) throws Exception {
List<T> list = new ArrayList<>();
Map<Integer, String> uniqueMap = new HashMap<>(16);
for (int i = 0; i < array.size(); i++) {
list.add(getBean(clazz, array.getJSONObject(i), uniqueMap));
}
return list;
}

/**
* 獲取每個物件的資料
*/
private static <T> T getBean(Class<T> c, JSONObject obj, Map<Integer, String> uniqueMap) throws Exception {
T t = c.newInstance();
Field[] fields = c.getDeclaredFields();
List<String> errMsgList = new ArrayList<>();
boolean hasRowTipsField = false;
StringBuilder uniqueBuilder = new StringBuilder();
int rowNum = 0;
for (Field field : fields) {
// 行號
if (field.getName().equals(ROW_NUM)) {
rowNum = obj.getInteger(ROW_NUM);
field.setAccessible(true);
field.set(t, rowNum);
continue;
}
// 是否需要設定異常資訊
if (field.getName().equals(ROW_TIPS)) {
hasRowTipsField = true;
continue;
}
// 原始資料
if (field.getName().equals(ROW_DATA)) {
field.setAccessible(true);
field.set(t, obj.toString());
continue;
}
// 設定對應屬性值
setFieldValue(t, field, obj, uniqueBuilder, errMsgList);
}
// 資料唯一性校驗
if (uniqueBuilder.length() > 0) {
if (uniqueMap.containsValue(uniqueBuilder.toString())) {
Set<Integer> rowNumKeys = uniqueMap.keySet();
for (Integer num : rowNumKeys) {
if (uniqueMap.get(num).equals(uniqueBuilder.toString())) {
errMsgList.add(String.format("資料唯一性校驗失敗,(%s)與第%s行重複)", uniqueBuilder, num));
}
}
} else {
uniqueMap.put(rowNum, uniqueBuilder.toString());
}
}
// 失敗處理
if (errMsgList.isEmpty() && !hasRowTipsField) {
return t;
}
StringBuilder sb = new StringBuilder();
int size = errMsgList.size();
for (int i = 0; i < size; i++) {
if (i == size - 1) {
sb.append(errMsgList.get(i));
} else {
sb.append(errMsgList.get(i)).append(";");
}
}
// 設定錯誤資訊
for (Field field : fields) {
if (field.getName().equals(ROW_TIPS)) {
field.setAccessible(true);
field.set(t, sb.toString());
}
}
return t;
}

private static <T> void setFieldValue(T t, Field field, JSONObject obj, StringBuilder uniqueBuilder, List<String> errMsgList) {
// 獲取 ExcelImport 註解屬性
ExcelImport annotation = field.getAnnotation(ExcelImport.class);
if (annotation == null) {
return;
}
String cname = annotation.value();
if (cname.trim().length() == 0) {
return;
}
// 獲取具體值
String val = null;
if (obj.containsKey(cname)) {
val = getString(obj.getString(cname));
}
if (val == null) {
return;
}
field.setAccessible(true);
// 判斷是否必填
boolean require = annotation.required();
if (require && val.isEmpty()) {
errMsgList.add(String.format("[%s]不能為空", cname));
return;
}
// 資料唯一性獲取
boolean unique = annotation.unique();
if (unique) {
if (uniqueBuilder.length() > 0) {
uniqueBuilder.append("--").append(val);
} else {
uniqueBuilder.append(val);
}
}
// 判斷是否超過最大長度
int maxLength = annotation.maxLength();
if (maxLength > 0 && val.length() > maxLength) {
errMsgList.add(String.format("[%s]長度不能超過%s個字元(當前%s個字元)", cname, maxLength, val.length()));
}
// 判斷當前屬性是否有對映關係
LinkedHashMap<String, String> kvMap = getKvMap(annotation.kv());
if (!kvMap.isEmpty()) {
boolean isMatch = false;
for (String key : kvMap.keySet()) {
if (kvMap.get(key).equals(val)) {
val = key;
isMatch = true;
break;
}
}
if (!isMatch) {
errMsgList.add(String.format("[%s]的值不正確(當前值為%s)", cname, val));
return;
}
}
// 其餘情況根據型別賦值
String fieldClassName = field.getType().getSimpleName();
try {
if ("String".equalsIgnoreCase(fieldClassName)) {
field.set(t, val);
} else if ("boolean".equalsIgnoreCase(fieldClassName)) {
field.set(t, Boolean.valueOf(val));
} else if ("int".equalsIgnoreCase(fieldClassName) || "Integer".equals(fieldClassName)) {
try {
field.set(t, Integer.valueOf(val));
} catch (NumberFormatException e) {
errMsgList.add(String.format("[%s]的值格式不正確(當前值為%s)", cname, val));
}
} else if ("double".equalsIgnoreCase(fieldClassName)) {
field.set(t, Double.valueOf(val));
} else if ("long".equalsIgnoreCase(fieldClassName)) {
field.set(t, Long.valueOf(val));
} else if ("BigDecimal".equalsIgnoreCase(fieldClassName)) {
field.set(t, new BigDecimal(val));
}
} catch (Exception e) {
e.printStackTrace();
}
}

private static Map<String, JSONArray> readExcelManySheet(MultipartFile mFile, File file) throws IOException {
Workbook book = getWorkbook(mFile, file);
if (book == null) {
return Collections.emptyMap();
}
Map<String, JSONArray> map = new LinkedHashMap<>();
for (int i = 0; i < book.getNumberOfSheets(); i++) {
Sheet sheet = book.getSheetAt(i);
JSONArray arr = readSheet(sheet);
map.put(sheet.getSheetName(), arr);
}
book.close();
return map;
}

private static JSONArray readExcel(MultipartFile mFile, File file) throws IOException {
Workbook book = getWorkbook(mFile, file);
if (book == null) {
return new JSONArray();
}
JSONArray array = readSheet(book.getSheetAt(0));
book.close();
return array;
}

private static Workbook getWorkbook(MultipartFile mFile, File file) throws IOException {
boolean fileNotExist = (file == null || !file.exists());
if (mFile == null && fileNotExist) {
return null;
}
// 解析表格資料
InputStream in;
String fileName;
if (mFile != null) {
// 上傳檔案解析
in = mFile.getInputStream();
fileName = getString(mFile.getOriginalFilename()).toLowerCase();
} else {
// 本地檔案解析
in = new FileInputStream(file);
fileName = file.getName().toLowerCase();
}
Workbook book;
if (fileName.endsWith(XLSX)) {
book = new XSSFWorkbook(in);
} else if (fileName.endsWith(XLS)) {
POIFSFileSystem poifsFileSystem = new POIFSFileSystem(in);
book = new HSSFWorkbook(poifsFileSystem);
} else {
return null;
}
in.close();
return book;
}

private static JSONArray readSheet(Sheet sheet) {
// 首行下標
int rowStart = sheet.getFirstRowNum();
// 尾行下標
int rowEnd = sheet.getLastRowNum();
// 獲取表頭行
Row headRow = sheet.getRow(rowStart);
if (headRow == null) {
return new JSONArray();
}
int cellStart = headRow.getFirstCellNum();
int cellEnd = headRow.getLastCellNum();
Map<Integer, String> keyMap = new HashMap<>();
for (int j = cellStart; j < cellEnd; j++) {
// 獲取表頭資料
String val = getCellValue(headRow.getCell(j));
if (val != null && val.trim().length() != 0) {
keyMap.put(j, val);
}
}
// 如果表頭沒有資料則不進行解析
if (keyMap.isEmpty()) {
return (JSONArray) Collections.emptyList();
}
// 獲取每行JSON物件的值
JSONArray array = new JSONArray();
// 如果首行與尾行相同，表明只有一行，返回表頭資料
if (rowStart == rowEnd) {
JSONObject obj = new JSONObject();
// 新增行號
obj.put(ROW_NUM, 1);
for (int i : keyMap.keySet()) {
obj.put(keyMap.get(i), "");
}
array.add(obj);
return array;
}
for (int i = rowStart + 1; i <= rowEnd; i++) {
Row eachRow = sheet.getRow(i);
JSONObject obj = new JSONObject();
// 新增行號
obj.put(ROW_NUM, i + 1);
StringBuilder sb = new StringBuilder();
for (int k = cellStart; k < cellEnd; k++) {
if (eachRow != null) {
String val = getCellValue(eachRow.getCell(k));
// 所有資料新增到裡面，用於判斷該行是否為空
sb.append(val);
obj.put(keyMap.get(k), val);
}
}
if (sb.length() > 0) {
array.add(obj);
}
}
return array;
}

private static String getCellValue(Cell cell) {
// 空白或空
if (cell == null || cell.getCellTypeEnum() == CellType.BLANK) {
return "";
}
// String型別
if (cell.getCellTypeEnum() == CellType.STRING) {
String val = cell.getStringCellValue();
if (val == null || val.trim().length() == 0) {
return "";
}
return val.trim();
}
// 數字型別
if (cell.getCellTypeEnum() == CellType.NUMERIC) {
// 科學計數法型別
return NUMBER_FORMAT.format(cell.getNumericCellValue()) + "";
}
// 布林值型別
if (cell.getCellTypeEnum() == CellType.BOOLEAN) {
return cell.getBooleanCellValue() + "";
}
// 錯誤型別
return cell.getCellFormula();
}

public static <T> void exportTemplate(HttpServletResponse response, String fileName, Class<T> clazz) {
exportTemplate(response, fileName, fileName, clazz, false);
}

public static <T> void exportTemplate(HttpServletResponse response, String fileName, String sheetName,
Class<T> clazz) {
exportTemplate(response, fileName, sheetName, clazz, false);
}

public static <T> void exportTemplate(HttpServletResponse response, String fileName, Class<T> clazz,
boolean isContainExample) {
exportTemplate(response, fileName, fileName, clazz, isContainExample);
}

public static <T> void exportTemplate(HttpServletResponse response, String fileName, String sheetName,
Class<T> clazz, boolean isContainExample) {
// 獲取表頭欄位
List<ExcelClassField> headFieldList = getExcelClassFieldList(clazz);
// 獲取表頭資料和示例資料
List<List<Object>> sheetDataList = new ArrayList<>();
List<Object> headList = new ArrayList<>();
List<Object> exampleList = new ArrayList<>();
Map<Integer, List<String>> selectMap = new LinkedHashMap<>();
for (int i = 0; i < headFieldList.size(); i++) {
ExcelClassField each = headFieldList.get(i);
headList.add(each.getName());
exampleList.add(each.getExample());
LinkedHashMap<String, String> kvMap = each.getKvMap();
if (kvMap != null && kvMap.size() > 0) {
selectMap.put(i, new ArrayList<>(kvMap.values()));
}
}
sheetDataList.add(headList);
if (isContainExample) {
sheetDataList.add(exampleList);
}
// 匯出資料
export(response, fileName, sheetName, sheetDataList, selectMap);
}

private static <T> List<ExcelClassField> getExcelClassFieldList(Class<T> clazz) {
// 解析所有欄位
Field[] fields = clazz.getDeclaredFields();
boolean hasExportAnnotation = false;
Map<Integer, List<ExcelClassField>> map = new LinkedHashMap<>();
List<Integer> sortList = new ArrayList<>();
for (Field field : fields) {
ExcelClassField cf = getExcelClassField(field);
if (cf.getHasAnnotation() == 1) {
hasExportAnnotation = true;
}
int sort = cf.getSort();
if (map.containsKey(sort)) {
map.get(sort).add(cf);
} else {
List<ExcelClassField> list = new ArrayList<>();
list.add(cf);
sortList.add(sort);
map.put(sort, list);
}
}
Collections.sort(sortList);
// 獲取表頭
List<ExcelClassField> headFieldList = new ArrayList<>();
if (hasExportAnnotation) {
for (Integer sort : sortList) {
for (ExcelClassField cf : map.get(sort)) {
if (cf.getHasAnnotation() == 1) {
headFieldList.add(cf);
}
}
}
} else {
headFieldList.addAll(map.get(0));
}
return headFieldList;
}

private static ExcelClassField getExcelClassField(Field field) {
ExcelClassField cf = new ExcelClassField();
String fieldName = field.getName();
cf.setFieldName(fieldName);
ExcelExport annotation = field.getAnnotation(ExcelExport.class);
// 無 ExcelExport 註解情況
if (annotation == null) {
cf.setHasAnnotation(0);
cf.setName(fieldName);
cf.setSort(0);
return cf;
}
// 有 ExcelExport 註解情況
cf.setHasAnnotation(1);
cf.setName(annotation.value());
String example = getString(annotation.example());
if (!example.isEmpty()) {
if (isNumeric(example)) {
cf.setExample(Double.valueOf(example));
} else {
cf.setExample(example);
}
} else {
cf.setExample("");
}
cf.setSort(annotation.sort());
// 解析對映
String kv = getString(annotation.kv());
cf.setKvMap(getKvMap(kv));
return cf;
}

private static LinkedHashMap<String, String> getKvMap(String kv) {
LinkedHashMap<String, String> kvMap = new LinkedHashMap<>();
if (kv.isEmpty()) {
return kvMap;
}
String[] kvs = kv.split(";");
if (kvs.length == 0) {
return kvMap;
}
for (String each : kvs) {
String[] eachKv = getString(each).split("-");
if (eachKv.length != 2) {
continue;
}
String k = eachKv[0];
String v = eachKv[1];
if (k.isEmpty() || v.isEmpty()) {
continue;
}
kvMap.put(k, v);
}
return kvMap;
}

/**
* 匯出表格到本地
*
* @param file 本地檔案物件
* @param sheetData 匯出資料
*/
public static void exportFile(File file, List<List<Object>> sheetData) {
if (file == null) {
System.out.println("檔案建立失敗");
return;
}
if (sheetData == null) {
sheetData = new ArrayList<>();
}
Map<String, List<List<Object>>> map = new HashMap<>();
map.put(file.getName(), sheetData);
export(null, file, file.getName(), map, null);
}

/**
* 匯出表格到本地
*
* @param <T> 匯出資料類似，和K型別保持一致
* @param filePath 檔案父路徑（如：D:/doc/excel/）
* @param fileName 檔名稱（不帶尾綴，如：學生表）
* @param list 匯出資料
* @throws IOException IO異常
*/
public static <T> File exportFile(String filePath, String fileName, List<T> list) throws IOException {
File file = getFile(filePath, fileName);
List<List<Object>> sheetData = getSheetData(list);
exportFile(file, sheetData);
return file;
}

/**
* 獲取檔案
*
* @param filePath filePath 檔案父路徑（如：D:/doc/excel/）
* @param fileName 檔名稱（不帶尾綴，如：使用者表）
* @return 本地File檔案物件
*/
private static File getFile(String filePath, String fileName) throws IOException {
String dirPath = getString(filePath);
String fileFullPath;
if (dirPath.isEmpty()) {
fileFullPath = fileName;
} else {
// 判定資料夾是否存在，如果不存在，則級聯建立
File dirFile = new File(dirPath);
if (!dirFile.exists()) {
dirFile.mkdirs();
}
// 獲取資料夾全名
if (dirPath.endsWith(String.valueOf(LEAN_LINE))) {
fileFullPath = dirPath + fileName + XLSX;
} else {
fileFullPath = dirPath + LEAN_LINE + fileName + XLSX;
}
}
System.out.println(fileFullPath);
File file = new File(fileFullPath);
if (!file.exists()) {
file.createNewFile();
}
return file;
}

private static <T> List<List<Object>> getSheetData(List<T> list) {
// 獲取表頭欄位
List<ExcelClassField> excelClassFieldList = getExcelClassFieldList(list.get(0).getClass());
List<String> headFieldList = new ArrayList<>();
List<Object> headList = new ArrayList<>();
Map<String, ExcelClassField> headFieldMap = new HashMap<>();
for (ExcelClassField each : excelClassFieldList) {
String fieldName = each.getFieldName();
headFieldList.add(fieldName);
headFieldMap.put(fieldName, each);
headList.add(each.getName());
}
// 新增表頭名稱
List<List<Object>> sheetDataList = new ArrayList<>();
sheetDataList.add(headList);
// 獲取表資料
for (T t : list) {
Map<String, Object> fieldDataMap = getFieldDataMap(t);
Set<String> fieldDataKeys = fieldDataMap.keySet();
List<Object> rowList = new ArrayList<>();
for (String headField : headFieldList) {
if (!fieldDataKeys.contains(headField)) {
continue;
}
Object data = fieldDataMap.get(headField);
if (data == null) {
rowList.add("");
continue;
}
ExcelClassField cf = headFieldMap.get(headField);
// 判斷是否有對映關係
LinkedHashMap<String, String> kvMap = cf.getKvMap();
if (kvMap == null || kvMap.isEmpty()) {
rowList.add(data);
continue;
}
String val = kvMap.get(data.toString());
if (isNumeric(val)) {
rowList.add(Double.valueOf(val));
} else {
rowList.add(val);
}
}
sheetDataList.add(rowList);
}
return sheetDataList;
}

private static <T> Map<String, Object> getFieldDataMap(T t) {
Map<String, Object> map = new HashMap<>();
Field[] fields = t.getClass().getDeclaredFields();
try {
for (Field field : fields) {
String fieldName = field.getName();
field.setAccessible(true);
Object object = field.get(t);
map.put(fieldName, object);
}
} catch (IllegalArgumentException | IllegalAccessException e) {
e.printStackTrace();
}
return map;
}

public static void exportEmpty(HttpServletResponse response, String fileName) {
List<List<Object>> sheetDataList = new ArrayList<>();
List<Object> headList = new ArrayList<>();
headList.add("匯出無資料");
sheetDataList.add(headList);
export(response, fileName, sheetDataList);
}

public static void export(HttpServletResponse response, String fileName, List<List<Object>> sheetDataList) {
export(response, fileName, fileName, sheetDataList, null);
}

public static void exportManySheet(HttpServletResponse response, String fileName, Map<String, List<List<Object>>> sheetMap) {
export(response, null, fileName, sheetMap, null);
}


public static void export(HttpServletResponse response, String fileName, String sheetName,
List<List<Object>> sheetDataList) {
export(response, fileName, sheetName, sheetDataList, null);
}

public static void export(HttpServletResponse response, String fileName, String sheetName,
List<List<Object>> sheetDataList, Map<Integer, List<String>> selectMap) {

Map<String, List<List<Object>>> map = new HashMap<>();
map.put(sheetName, sheetDataList);
export(response, null, fileName, map, selectMap);
}

public static <T, K> void export(HttpServletResponse response, String fileName, List<T> list, Class<K> template) {
// list 是否為空
boolean lisIsEmpty = list == null || list.isEmpty();
// 如果模板資料為空，且匯入的資料為空，則匯出空檔案
if (template == null && lisIsEmpty) {
exportEmpty(response, fileName);
return;
}
// 如果 list 資料，則匯出模板資料
if (lisIsEmpty) {
exportTemplate(response, fileName, template);
return;
}
// 匯出資料
List<List<Object>> sheetDataList = getSheetData(list);
export(response, fileName, sheetDataList);
}

public static void export(HttpServletResponse response, String fileName, List<List<Object>> sheetDataList, Map<Integer, List<String>> selectMap) {
export(response, fileName, fileName, sheetDataList, selectMap);
}

private static void export(HttpServletResponse response, File file, String fileName,
Map<String, List<List<Object>>> sheetMap, Map<Integer, List<String>> selectMap) {
// 整個 Excel 表格 book 物件
SXSSFWorkbook book = new SXSSFWorkbook();
// 每個 Sheet 頁
Set<Entry<String, List<List<Object>>>> entries = sheetMap.entrySet();
for (Entry<String, List<List<Object>>> entry : entries) {
List<List<Object>> sheetDataList = entry.getValue();
Sheet sheet = book.createSheet(entry.getKey());
Drawing<?> patriarch = sheet.createDrawingPatriarch();
// 設定表頭背景色（灰色）
CellStyle headStyle = book.createCellStyle();
headStyle.setFillForegroundColor(IndexedColors.GREY_80_PERCENT.index);
headStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
headStyle.setAlignment(HorizontalAlignment.CENTER);
headStyle.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.index);
// 設定表身背景色（預設色）
CellStyle rowStyle = book.createCellStyle();
rowStyle.setAlignment(HorizontalAlignment.CENTER);
rowStyle.setVerticalAlignment(VerticalAlignment.CENTER);
// 設定表格列寬度（預設為15個位元組）
sheet.setDefaultColumnWidth(15);
// 建立合併演算法陣列
int rowLength = sheetDataList.size();
int columnLength = sheetDataList.get(0).size();
int[][] mergeArray = new int[rowLength][columnLength];
for (int i = 0; i < sheetDataList.size(); i++) {
// 每個 Sheet 頁中的行資料
Row row = sheet.createRow(i);
List<Object> rowList = sheetDataList.get(i);
for (int j = 0; j < rowList.size(); j++) {
// 每個行資料中的單元格資料
Object o = rowList.get(j);
int v = 0;
if (o instanceof URL) {
// 如果要匯出圖片的話, 連結需要傳遞 URL 物件
setCellPicture(book, row, patriarch, i, j, (URL) o);
} else {
Cell cell = row.createCell(j);
if (i == 0) {
// 第一行為表頭行，採用灰色底背景
v = setCellValue(cell, o, headStyle);
} else {
// 其他行為資料行，預設白底色
v = setCellValue(cell, o, rowStyle);
}
}
mergeArray[i][j] = v;
}
}
// 合併單元格
mergeCells(sheet, mergeArray);
// 設定下拉列表
setSelect(sheet, selectMap);
}
// 寫資料
if (response != null) {
// 前端匯出
try {
write(response, book, fileName);
} catch (IOException e) {
e.printStackTrace();
}
} else {
// 本地匯出
FileOutputStream fos;
try {
fos = new FileOutputStream(file);
ByteArrayOutputStream ops = new ByteArrayOutputStream();
book.write(ops);
fos.write(ops.toByteArray());
fos.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}

/**
* 合併當前Sheet頁的單元格
*
* @param sheet 當前 sheet 頁
* @param mergeArray 合併單元格演算法
*/
private static void mergeCells(Sheet sheet, int[][] mergeArray) {
// 橫向合併
for (int x = 0; x < mergeArray.length; x++) {
int[] arr = mergeArray[x];
boolean merge = false;
int y1 = 0;
int y2 = 0;
for (int y = 0; y < arr.length; y++) {
int value = arr[y];
if (value == CELL_COLUMN_MERGE) {
if (!merge) {
y1 = y;
}
y2 = y;
merge = true;
} else {
merge = false;
if (y1 > 0) {
sheet.addMergedRegion(new CellRangeAddress(x, x, (y1 - 1), y2));
}
y1 = 0;
y2 = 0;
}
}
if (y1 > 0) {
sheet.addMergedRegion(new CellRangeAddress(x, x, (y1 - 1), y2));
}
}
// 縱向合併
int xLen = mergeArray.length;
int yLen = mergeArray[0].length;
for (int y = 0; y < yLen; y++) {
boolean merge = false;
int x1 = 0;
int x2 = 0;
for (int x = 0; x < xLen; x++) {
int value = mergeArray[x][y];
if (value == CELL_ROW_MERGE) {
if (!merge) {
x1 = x;
}
x2 = x;
merge = true;
} else {
merge = false;
if (x1 > 0) {
sheet.addMergedRegion(new CellRangeAddress((x1 - 1), x2, y, y));
}
x1 = 0;
x2 = 0;
}
}
if (x1 > 0) {
sheet.addMergedRegion(new CellRangeAddress((x1 - 1), x2, y, y));
}
}
}

private static void write(HttpServletResponse response, SXSSFWorkbook book, String fileName) throws IOException {
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
String name = new String(fileName.getBytes("GBK"), "ISO8859_1") + XLSX;
response.addHeader("Content-Disposition", "attachment;filename=" + name);
ServletOutputStream out = response.getOutputStream();
book.write(out);
out.flush();
out.close();
}

private static int setCellValue(Cell cell, Object o, CellStyle style) {
// 設定樣式
cell.setCellStyle(style);
// 資料為空時
if (o == null) {
cell.setCellType(CellType.STRING);
cell.setCellValue("");
return CELL_OTHER;
}
// 是否為字串
if (o instanceof String) {
String s = o.toString();
if (isNumeric(s)) {
cell.setCellType(CellType.NUMERIC);
cell.setCellValue(Double.parseDouble(s));
return CELL_OTHER;
} else {
cell.setCellType(CellType.STRING);
cell.setCellValue(s);
}
if (s.equals(ROW_MERGE)) {
return CELL_ROW_MERGE;
} else if (s.equals(COLUMN_MERGE)) {
return CELL_COLUMN_MERGE;
} else {
return CELL_OTHER;
}
}
// 是否為字串
if (o instanceof Integer || o instanceof Long || o instanceof Double || o instanceof Float) {
cell.setCellType(CellType.NUMERIC);
cell.setCellValue(Double.parseDouble(o.toString()));
return CELL_OTHER;
}
// 是否為Boolean
if (o instanceof Boolean) {
cell.setCellType(CellType.BOOLEAN);
cell.setCellValue((Boolean) o);
return CELL_OTHER;
}
// 如果是BigDecimal，則預設3位小數
if (o instanceof BigDecimal) {
cell.setCellType(CellType.NUMERIC);
cell.setCellValue(((BigDecimal) o).setScale(3, RoundingMode.HALF_UP).doubleValue());
return CELL_OTHER;
}
// 如果是Date資料，則顯示格式化資料
if (o instanceof Date) {
cell.setCellType(CellType.STRING);
cell.setCellValue(formatDate((Date) o));
return CELL_OTHER;
}
// 如果是其他，則預設字串型別
cell.setCellType(CellType.STRING);
cell.setCellValue(o.toString());
return CELL_OTHER;
}

private static void setCellPicture(SXSSFWorkbook wb, Row sr, Drawing<?> patriarch, int x, int y, URL url) {
// 設定圖片寬高
sr.setHeight((short) (IMG_WIDTH * IMG_HEIGHT));
// （jdk1.7版本try中定義流可自動關閉）
try (InputStream is = url.openStream(); ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
byte[] buff = new byte[BYTES_DEFAULT_LENGTH];
int rc;
while ((rc = is.read(buff, 0, BYTES_DEFAULT_LENGTH)) > 0) {
outputStream.write(buff, 0, rc);
}
// 設定圖片位置
XSSFClientAnchor anchor = new XSSFClientAnchor(0, 0, 0, 0, y, x, y + 1, x + 1);
// 設定這個，圖片會自動填滿單元格的長寬
anchor.setAnchorType(AnchorType.MOVE_AND_RESIZE);
patriarch.createPicture(anchor, wb.addPicture(outputStream.toByteArray(), HSSFWorkbook.PICTURE_TYPE_JPEG));
} catch (Exception e) {
e.printStackTrace();
}
}

private static String formatDate(Date date) {
if (date == null) {
return "";
}
SimpleDateFormat format = new SimpleDateFormat(DATE_FORMAT);
return format.format(date);
}

private static void setSelect(Sheet sheet, Map<Integer, List<String>> selectMap) {
if (selectMap == null || selectMap.isEmpty()) {
return;
}
Set<Entry<Integer, List<String>>> entrySet = selectMap.entrySet();
for (Entry<Integer, List<String>> entry : entrySet) {
int y = entry.getKey();
List<String> list = entry.getValue();
if (list == null || list.isEmpty()) {
continue;
}
String[] arr = new String[list.size()];
for (int i = 0; i < list.size(); i++) {
arr[i] = list.get(i);
}
DataValidationHelper helper = sheet.getDataValidationHelper();
CellRangeAddressList addressList = new CellRangeAddressList(1, 65000, y, y);
DataValidationConstraint dvc = helper.createExplicitListConstraint(arr);
DataValidation dv = helper.createValidation(dvc, addressList);
if (dv instanceof HSSFDataValidation) {
dv.setSuppressDropDownArrow(false);
} else {
dv.setSuppressDropDownArrow(true);
dv.setShowErrorBox(true);
}
sheet.addValidationData(dv);
}
}

private static boolean isNumeric(String str) {
if ("0.0".equals(str)) {
return true;
}
for (int i = str.length(); --i >= 0; ) {
if (!Character.isDigit(str.charAt(i))) {
return false;
}
}
return true;
}

private static String getString(String s) {
if (s == null) {
return "";
}
if (s.isEmpty()) {
return s;
}
return s.trim();
}

}
ExcelImport
package com.zyq.util.excel;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* @author sunnyzyq
* @date 2021/12/17
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelImport {

/** 欄位名稱 */
String value();

/** 匯出對映，格式如：0-未知;1-男;2-女 */
String kv() default "";

/** 是否為必填欄位（預設為非必填） */
boolean required() default false;

/** 最大長度（預設255） */
int maxLength() default 255;

/** 匯入唯一性驗證（多個欄位則取聯合驗證） */
boolean unique() default false;

}
ExcelExport
package com.zyq.util.excel;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* @author sunnyzyq
* @date 2021/12/17
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelExport {

/** 欄位名稱 */
String value();

/** 匯出排序先後: 數字越小越靠前（預設按Java類欄位順序匯出） */
int sort() default 0;

/** 匯出對映，格式如：0-未知;1-男;2-女 */
String kv() default "";

/** 匯出模板示例值（有值的話，直接取該值，不做對映） */
String example() default "";

}
ExcelClassField
package com.zyq.util.excel;

import java.util.LinkedHashMap;

/**
* @author sunnyzyq
* @date 2021/12/17
*/
public class ExcelClassField {

/** 欄位名稱 */
private String fieldName;

/** 表頭名稱 */
private String name;

/** 對映關係 */
private LinkedHashMap<String, String> kvMap;

/** 示例值 */
private Object example;

/** 排序 */
private int sort;

/** 是否為註解欄位：0-否，1-是 */
private int hasAnnotation;

public String getFieldName() {
return fieldName;
}

public void setFieldName(String fieldName) {
this.fieldName = fieldName;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public LinkedHashMap<String, String> getKvMap() {
return kvMap;
}

public void setKvMap(LinkedHashMap<String, String> kvMap) {
this.kvMap = kvMap;
}

public Object getExample() {
return example;
}

public void setExample(Object example) {
this.example = example;
}

public int getSort() {
return sort;
}

public void setSort(int sort) {
this.sort = sort;
}

public int getHasAnnotation() {
return hasAnnotation;
}

public void setHasAnnotation(int hasAnnotation) {
this.hasAnnotation = hasAnnotation;
}

}