1 問題背景
需求要做一個導出excel的功能
2 前言
- 本篇著重闡述后端怎么實現，前端實現的部分只會粗略闡述。該實現方案是經過生產環(huán)境考驗的，不是那些拿來練手的小demo。本文闡述的方案可以借鑒用來做畢設或者加到自己玩的項目中去。
- 再次聲明，本文是百萬級數據量的企業(yè)級解決方案，不是學校里面的畢設或者自己搭環(huán)境玩玩的小demo。客戶不會去一頁一頁地點擊導出，本文闡述的是一鍵導出幾千行甚至上萬行的數據。如果本文與你了解到的方案有出入可以在評論區(qū)交流，像那種導出幾行或十來行的方案就不要說了。
- 有讀者在評論里提問“請教百萬行能撐住嗎？”筆者沒有去驗證，有興趣或者有疑問的讀者可以去驗證下，本文的解決方案是導出幾千或上萬行數據。本文也只是想介紹電商生產環(huán)境中真實的需求以及真實的解決方案，如果要導出百萬行，那就只能采用異步方式去進行導出了，文末有提供思路。
3 實現思路
- 后端查詢要導出的數據，此處簡稱data
- 使用阿里的EasyExcel組件將data寫到HttpServletResponse里面，返回指定的響應頭、響應內容的類型、字符編碼。響應出去的數據是二進制數據，此處簡稱bytes數據
- 前端使用前端框架提供的方法，將 bytes數據轉成blob，然后生成下載地址，然后進行下載
4 后端實現
要引入阿里的EasyExcel依賴，此處不贅述
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.1.7</version>
</dependency>
下面是excel文件要保存的信息，需要指定列頭
@Data
public class UserInfoVO {
@ExcelProperty(value = "用戶ID",index = 0)
private Long id;
@ExcelProperty(value = "用戶姓名",index = 1)
private String username;
@ExcelProperty(value = "性別",index = 2)
private String sex;
}
導出的偽代碼如下：
@PostMapping("/xx/xxx/xxx")
public void export(HttpServletResponse reponse) {
// 設置響應頭等
response.setHeader("Content-Disposition", "attachment;filename=" + "文件名(隨便定義).xlsx");
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("UTF-8");
// 查數據，假如要導出UserInfo的列表信息
List<UserInfoVO> data = selectData();
// 導出數據
EasyExcel.write(response.getOutputStream()).head(UserInfoVO.class).sheet().doWrite(data);
}
5 設置Excel自適應列寬
思路：實現easyexcel提供的類并重寫方法，寫數據到HttpServletReponse的時候注冊一個自適應列寬的bean
實現AbstractColumnWidthStyleStrategy類，如下所示：
public class CustomCellWriteWeightConfig extends AbstractColumnWidthStyleStrategy {
private Map<Integer, Map<Integer, Integer>> CACHE = new HashMap<>();
@Override
protected void setColumnWidth(WriteSheetHolder writeSheetHolder, List<CellData> cellDataList, Cell cell, Head head, Integer integer, Boolean isHead) {
boolean needSetWidth = isHead || !CollectionUtils.isEmpty(cellDataList);
if (needSetWidth) {
Map<Integer, Integer> maxColumnWidthMap = CACHE.get(writeSheetHolder.getSheetNo());
if (maxColumnWidthMap == null) {
maxColumnWidthMap = new HashMap<>();
CACHE.put(writeSheetHolder.getSheetNo(), maxColumnWidthMap);
}
Integer columnWidth = this.dataLength(cellDataList, cell, isHead);
if (columnWidth >= 0) {
if (columnWidth > 254) {
columnWidth = 254;
}
Integer maxColumnWidth = maxColumnWidthMap.get(cell.getColumnIndex());
if (maxColumnWidth == null || columnWidth > maxColumnWidth) {
maxColumnWidthMap.put(cell.getColumnIndex(), columnWidth);
Sheet sheet = writeSheetHolder.getSheet();
sheet.setColumnWidth(cell.getColumnIndex(), columnWidth * 256);
}
}
}
}
/**
* 計算長度
* @param cellDataList
* @param cell
* @param isHead
* @return
*/
private Integer dataLength(List<CellData> cellDataList, Cell cell, Boolean isHead) {
if (isHead) {
return cell.getStringCellValue().getBytes().length;
} else {
CellData cellData = cellDataList.get(0);
CellDataTypeEnum type = cellData.getType();
if (type == null) {
return -1;
} else {
switch (type) {
case STRING:
// 換行符（數據需要提前解析好）
int index = cellData.getStringValue().indexOf("\n");
return index != -1 ?
cellData.getStringValue().substring(0, index).getBytes().length + 1 : cellData.getStringValue().getBytes().length + 1;
case BOOLEAN:
return cellData.getBooleanValue().toString().getBytes().length;
case NUMBER:
return cellData.getNumberValue().toString().getBytes().length;
default:
return -1;
}
}
}
}
}
注冊自適應列寬的組件：
EasyExcel.write(response.getOutputStream())
.head(SubscriptionOrderExportResp.class)
// 注冊自適應列寬組件
.registerWriteHandler(new CustomCellWriteWeightConfig())
.sheet()
.doWrite(data);
6 方案優(yōu)缺點
優(yōu)點：實現簡單，輕量級。能快速迭代上線 。
缺點：使用了同步方式返回數據，如果excel文件的數據量很多，那么將耗費很多時間，甚至http連接已經斷開了還未響應出去。文章來源：http://www.zghlxwxcb.cn/news/detail-430302.html
改進：本文解決方案是采用了同步方式導出，實時返回excel文件。可以做一個異步方式，后端創(chuàng)建一個任務異步生成excel文件，然后文件上傳到對象存儲服務器。前端輪詢任務是否完成，后端返回文件地址給前端下載。文章來源地址http://www.zghlxwxcb.cn/news/detail-430302.html
到了這里，關于SpringBoot實現導出Excel功能的文章就介紹完了。如果您還想了解更多內容，請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章，希望大家以后多多支持TOY模板網！
