Java使用EasyExcel動態添加自增序號列

Posted on by

前言

本文將介紹如何通過使用EasyExcel自定義攔截器實現在最終的Excel文件中新增一列自增的序號列，最終的效果如下：

此外，本文所使用的完整代碼示例已上傳到GitHub。

實現

本文主要是通過自定義一個繼承AbstractRowWriteHandler的攔截器來實現在最終導出的結果中新增序號列，通過修改源碼中保存頭部標題的Map內容來給自己添加的序號列留出位置，先展示最終的代碼： 

/**
 * 自定義 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, 將其中的內容均右移一位, 給新增的序列號預留為第一列
   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) {
  // 在行創建完成後添加序號列
  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方法中的內容很好理解，一個用於控制控制新增序號列的內容，一個用於控制新增列的樣式。而beforeRowCreate中的內容則稍微復雜，主要用於給新增的序號列空出位置。同時，由於beforeRowCreate會在每次創建行時均會被調用，但是原始的存儲頭部信息的Map隻需要修改一次，因此這裡通過使用init變量控制隻會修改一次。

思路

通過查看com.alibaba.excel.write.executor.ExcelWriteAddExecutor類中的addOneRowOfDataToExcel方法源碼，可以看到在新增行的前後會分別調用beforeRowCreate和afterRowCreate方法，並且在一行數據添加完成後會調用afterRowDispose，這也是上述攔截器生效的原理，源碼如下： 

private void addOneRowOfDataToExcel(Object oneRowData, int n, int relativeRowIndex,
                                    Map<Integer, Field> sortedAllFiledMap) {
    // 行數據為空, 直接返回
    if (oneRowData == null) {
        return;
    }
    // 創建數據行對象, 同時分別在創建行前後調用攔截器
    WriteHandlerUtils.beforeRowCreate(writeContext, n, relativeRowIndex, Boolean.FALSE);
    Row row = WorkBookUtil.createRow(writeContext.writeSheetHolder().getSheet(), n);
    WriteHandlerUtils.afterRowCreate(writeContext, row, relativeRowIndex, Boolean.FALSE);
    // 將實體數據內容填充到行中
    if (oneRowData instanceof List) {
        addBasicTypeToExcel((List) oneRowData, row, relativeRowIndex);
    } else {
        // 下面會繼續查看這個方法
        addJavaObjectToExcel(oneRowData, row, relativeRowIndex, sortedAllFiledMap);
    }
    // 行創建完成後, 調用相應攔截器
    WriteHandlerUtils.afterRowDispose(writeContext, row, relativeRowIndex, Boolean.FALSE);
}

而之所以我們修改headMap和contentMap的內容就可以實現最終效果，隻需要繼續查看該類中addJavaObjectToExcel方法的代碼即可知道原因： 

private void addJavaObjectToExcel(Object oneRowData, Row row, int relativeRowIndex,
                                  Map<Integer, Field> sortedAllFiledMap) {
        WriteHolder currentWriteHolder = writeContext.currentWriteHolder();
     // 將自己的實體數據映射到 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 內容
            Map<Integer, Head> headMap = writeContext.currentWriteHolder().excelWriteHeadProperty().getHeadMap();
            Map<Integer, ExcelContentProperty> contentPropertyMap =
                writeContext.currentWriteHolder().excelWriteHeadProperty().getContentPropertyMap();
            // 遍歷所有的列頭, 插入數據
            for (Map.Entry<Integer, ExcelContentProperty> entry : contentPropertyMap.entrySet()) {
                // 獲取 cell 的下標, 後續將內容插入指定的列
                cellIndex = entry.getKey();
                ExcelContentProperty excelContentProperty = entry.getValue();
                String name = excelContentProperty.getField().getName();
                if (!beanMap.containsKey(name)) {
                    continue;
                }
                // 控制單元格的內容
                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);
            }
        }
        // 省略瞭後面無關的內容
    }

其它

通過以上自定義的攔截器，就可以寫一個簡單的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>

總結

以上便是實現動態添加自增序號列的一種思路，除此之外還可以通過在實體中添加序號這一個字段，然後修改列表的數據，或者隻需要在afterRowCreate中設置序號數據即可，而不需要再修改頭部Map的數據。還有一種通過自定義模板，然後通過填充模板來實現同樣的效果，可以參考https://www.yuque.com/easyexcel/doc/fill，但是這兩種方法都需要對原有數據有所修改，或者需要增加定義模板的操作，這裡不再介紹。

到此這篇關於Java使用EasyExcel動態添加自增序號列的文章就介紹到這瞭,更多相關Java EasyExcel動態添加自增序號列內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：