Java使用EasyExcel動態(tài)添加自增序號列
更新時間：2021年09月06日 09:55:50 作者：莊周de蝴蝶
本文將介紹如何通過使用EasyExcel自定義攔截器實現(xiàn)在最終的Excel文件中新增一列自增的序號列，具有一定的參考價值，感興趣的小伙伴們可以參考一下
前言
本文將介紹如何通過使用EasyExcel自定義攔截器實現(xiàn)在最終的Excel文件中新增一列自增的序號列，最終的效果如下：
此外，本文所使用的完整代碼示例已上傳到GitHub。
實現(xiàn)
本文主要是通過自定義一個繼承AbstractRowWriteHandler的攔截器來實現(xiàn)在最終導出的結果中新增序號列，通過修改源碼中保存頭部標題的Map內(nèi)容來給自己添加的序號列留出位置，先展示最終的代碼：
/**
* 自定義 excel 行處理器, 增加序號列
*
* @author butterfly
* @date 2020-09-05
*/
@Component
public class AddNoHandler extends AbstractRowWriteHandler {
private boolean init = true;
@Override
public void beforeRowCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
Integer rowIndex, Integer relativeRowIndex, Boolean isHead) {
if (init) {
// 修改存儲頭部及對應字段信息的 map, 將其中的內(nèi)容均右移一位, 給新增的序列號預留為第一列
ExcelWriteHeadProperty excelWriteHeadProperty = writeSheetHolder.excelWriteHeadProperty();
Map<Integer, Head> headMap = excelWriteHeadProperty.getHeadMap();
Map<Integer, ExcelContentProperty> contentMap = excelWriteHeadProperty.getContentPropertyMap();
int size = headMap.size();
for (int current = size; current > 0; current--) {
int previous = current - 1;
headMap.put(current, headMap.get(previous));
contentMap.put(current, contentMap.get(previous));
}
// 空出第一列
headMap.remove(0);
contentMap.remove(0);
// 只需要修改一次 map 即可, 故使用 init 變量進行控制
init = false;
}
}
@Override
public void afterRowCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
Integer relativeRowIndex, Boolean isHead) {
// 在行創(chuàng)建完成后添加序號列
Cell cell = row.createCell(0);
int rowNum = row.getRowNum();
if (rowNum == 0) {
cell.setCellValue(ExcelConstant.TITLE);
} else {
cell.setCellValue(rowNum);
}
}
@Override
public void afterRowDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
Integer relativeRowIndex, Boolean isHead) {
if (row.getLastCellNum() > 1) {
// 將自定義新增的序號列的樣式設置與默認的樣式一致
row.getCell(0).setCellStyle(row.getCell(1).getCellStyle());
}
}
}
afterRowCreate和afterRowDispose方法中的內(nèi)容很好理解，一個用于控制控制新增序號列的內(nèi)容，一個用于控制新增列的樣式。而beforeRowCreate中的內(nèi)容則稍微復雜，主要用于給新增的序號列空出位置。同時，由于beforeRowCreate會在每次創(chuàng)建行時均會被調(diào)用，但是原始的存儲頭部信息的Map只需要修改一次，因此這里通過使用init變量控制只會修改一次。
思路
通過查看com.alibaba.excel.write.executor.ExcelWriteAddExecutor類中的addOneRowOfDataToExcel方法源碼，可以看到在新增行的前后會分別調(diào)用beforeRowCreate和afterRowCreate方法，并且在一行數(shù)據(jù)添加完成后會調(diào)用afterRowDispose，這也是上述攔截器生效的原理，源碼如下：
private void addOneRowOfDataToExcel(Object oneRowData, int n, int relativeRowIndex,
Map<Integer, Field> sortedAllFiledMap) {
// 行數(shù)據(jù)為空, 直接返回
if (oneRowData == null) {
return;
}
// 創(chuàng)建數(shù)據(jù)行對象, 同時分別在創(chuàng)建行前后調(diào)用攔截器
WriteHandlerUtils.beforeRowCreate(writeContext, n, relativeRowIndex, Boolean.FALSE);
Row row = WorkBookUtil.createRow(writeContext.writeSheetHolder().getSheet(), n);
WriteHandlerUtils.afterRowCreate(writeContext, row, relativeRowIndex, Boolean.FALSE);
// 將實體數(shù)據(jù)內(nèi)容填充到行中
if (oneRowData instanceof List) {
addBasicTypeToExcel((List) oneRowData, row, relativeRowIndex);
} else {
// 下面會繼續(xù)查看這個方法
addJavaObjectToExcel(oneRowData, row, relativeRowIndex, sortedAllFiledMap);
}
// 行創(chuàng)建完成后, 調(diào)用相應攔截器
WriteHandlerUtils.afterRowDispose(writeContext, row, relativeRowIndex, Boolean.FALSE);
}
而之所以我們修改headMap和contentMap的內(nèi)容就可以實現(xiàn)最終效果，只需要繼續(xù)查看該類中addJavaObjectToExcel方法的代碼即可知道原因：
private void addJavaObjectToExcel(Object oneRowData, Row row, int relativeRowIndex,
Map<Integer, Field> sortedAllFiledMap) {
WriteHolder currentWriteHolder = writeContext.currentWriteHolder();
// 將自己的實體數(shù)據(jù)映射到 beanMap
BeanMap beanMap = BeanMap.create(oneRowData);
Set<String> beanMapHandledSet = new HashSet<String>();
int cellIndex = 0;
// If it's a class it needs to be cast by type
if (HeadKindEnum.CLASS.equals(writeContext.currentWriteHolder().excelWriteHeadProperty().getHeadKind())) {
// 我們修改的就是這里的 headMap 和 contentPropertyMap 內(nèi)容
Map<Integer, Head> headMap = writeContext.currentWriteHolder().excelWriteHeadProperty().getHeadMap();
Map<Integer, ExcelContentProperty> contentPropertyMap =
writeContext.currentWriteHolder().excelWriteHeadProperty().getContentPropertyMap();
// 遍歷所有的列頭, 插入數(shù)據(jù)
for (Map.Entry<Integer, ExcelContentProperty> entry : contentPropertyMap.entrySet()) {
// 獲取 cell 的下標, 后續(xù)將內(nèi)容插入指定的列
cellIndex = entry.getKey();
ExcelContentProperty excelContentProperty = entry.getValue();
String name = excelContentProperty.getField().getName();
if (!beanMap.containsKey(name)) {
continue;
}
// 控制單元格的內(nèi)容
Head head = headMap.get(cellIndex);
WriteHandlerUtils.beforeCellCreate(writeContext, row, head, cellIndex,
relativeRowIndex, Boolean.FALSE);
Cell cell = WorkBookUtil.createCell(row, cellIndex);
WriteHandlerUtils.afterCellCreate(writeContext, cell, head, relativeRowIndex, Boolean.FALSE);
Object value = beanMap.get(name);
CellData cellData = converterAndSet(currentWriteHolder, excelContentProperty.getField().getType(),
cell, value, excelContentProperty, head, relativeRowIndex);
WriteHandlerUtils.afterCellDispose(writeContext, cellData, cell, head,
relativeRowIndex, Boolean.FALSE);
beanMapHandledSet.add(name);
}
}
// 省略了后面無關的內(nèi)容
}
其它
通過以上自定義的攔截器，就可以寫一個簡單的demo進行測試：
/**
* Excel 下載控制器
*
* @author butterfly
* @date 2021-09-05
*/
@RestController
public class ExcelController {
/**
* 添加序號列測試
*
* @param response response
*/
@GetMapping("/col")
public void col(HttpServletResponse response) {
try {
List<Student> students = getStudentList();
EasyExcel.write(response.getOutputStream(), Student.class)
.registerWriteHandler(new AddNoHandler())
.sheet()
.doWrite(students);
} catch (Exception e) {
System.out.println(ExcelConstant.DOWNLOAD_FAILED);
}
}
/**
* 生成學生列表
*
* @return 學生列表
*/
private List<Student> getStudentList() {
return Arrays.asList(
new Student("2021090101", "張三", 19),
new Student("2021090102", "李四", 18),
new Student("2021090103", "王二", 20)
);
}
}
然后是前端的測試代碼：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>文件下載測試</title>
<script src="https://cdn.staticfile.org/axios/0.21.2/axios.min.js"></script>
</head>
<body>
<button onclick="col()">添加序號列測試</button>
<script>
function col() {
download('http://localhost:8080/col', 'col.xlsx')
}
function download(url, name) {
axios({
url: url,
responseType: 'blob'
}).then((response) => {
const URL = window.URL.createObjectURL(response.data)
const tempLink = document.createElement('a')
tempLink.style.display = 'none'
tempLink.href = URL
tempLink.setAttribute('download', name)
if (typeof tempLink.download === 'undefined') {
tempLink.setAttribute('target', '_blank')
}
document.body.appendChild(tempLink)
tempLink.click()
document.body.removeChild(tempLink)
window.URL.revokeObjectURL(URL)
})
}
</script>
</body>
</html>
總結
以上便是實現(xiàn)動態(tài)添加自增序號列的一種思路，除此之外還可以通過在實體中添加序號這一個字段，然后修改列表的數(shù)據(jù)，或者只需要在afterRowCreate中設置序號數(shù)據(jù)即可，而不需要再修改頭部Map的數(shù)據(jù)。還有一種通過自定義模板，然后通過填充模板來實現(xiàn)同樣的效果，可以參考https://www.yuque.com/easyexcel/doc/fill，但是這兩種方法都需要對原有數(shù)據(jù)有所修改，或者需要增加定義模板的操作，這里不再介紹。
到此這篇關于Java使用EasyExcel動態(tài)添加自增序號列的文章就介紹到這了,更多相關Java EasyExcel動態(tài)添加自增序號列內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
相關文章
這篇文章主要介紹了spring是如何實現(xiàn)聲明式事務的,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-04-04
Mybatis-Plus條件構造器select方法返回指定字段方式
這篇文章主要介紹了Mybatis-Plus條件構造器select方法返回指定字段方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-06-06
這篇文章主要為大家詳細介紹了java身份證合法性校驗，并獲取并根據(jù)身份證號提取身份證相關信息，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-08-08
這篇文章主要介紹了Java代碼中去掉煩人的“!=null”，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-05-05
Spring使用@Autowired注解實現(xiàn)自動裝配方式
這篇文章主要介紹了Spring使用@Autowired注解實現(xiàn)自動裝配方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了java使用回溯法求解數(shù)獨示例,大家參考使用吧2014-01-01
這篇文章介紹了java中Class.forName的作用，有需要的朋友可以參考一下2013-11-11
log4j2優(yōu)越的性能其原因在于log4j2使用了LMAX,一個無鎖的線程間通信庫代替了,logback和log4j之前的隊列,并發(fā)性能大大提升,下面這篇文章主要給大家介紹了關于SpringBoot?2.x整合Log4j2日志的相關資料,需要的朋友可以參考下2022-10-10
這篇文章主要介紹了Java開發(fā)到底為什么要用 IoC 和 AOP，幫助大家更好的理解和學習使用Java，感興趣的朋友可以了解下2021-02-02
在Java中緩存是一種常用的性能優(yōu)化技術,用于在應用程序中加速訪問和查詢數(shù)據(jù)的速度,下面這篇文章主要給大家介紹了關于Java本地高性能緩存的幾種常見實現(xiàn)方式,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2024-07-07