• EasyExcel复杂表头导出（一对多）升级版

    一、前言

            在之前写的 EasyExcel复杂表头导出（一对多）的博客的结尾，受限于当时的能力和精力，留下一些问题及展望。现在写下此博客，目的就是解决之前遗留的问题。

            背景介绍，见上述链接指向的博客，这里主要通过自定义拦截器的形式来完美解决。

    二、导出功能的实现

    2.1 Entity 对象

    1. import com.alibaba.excel.annotation.ExcelProperty;
    2. import com.alibaba.excel.annotation.write.style.ColumnWidth;
    3. import com.alibaba.excel.annotation.write.style.ContentRowHeight;
    4. import com.alibaba.excel.annotation.write.style.HeadRowHeight;
    5. import com.alibaba.excel.annotation.write.style.HeadStyle;
    6. import com.alibaba.excel.converters.string.StringImageConverter;
    7. import lombok.AllArgsConstructor;
    8. import lombok.Data;
    9. import lombok.EqualsAndHashCode;
    10. import lombok.NoArgsConstructor;
    11. import java.net.URL;
    12.  
    13. @Data
    14. @EqualsAndHashCode
    15. @HeadRowHeight(30)
    16. @ContentRowHeight(80)
    17. @ColumnWidth(15)
    18. @HeadStyle(fillForegroundColor = 44)
    19. @NoArgsConstructor
    20. @AllArgsConstructor
    21. class Customer {
    22.  
    23.     @ExcelProperty({"客户编号"})
    24.     private String userCode;
    25.  
    26.     @ExcelProperty({"客户名称"})
    27.     private String userName;
    28.  
    29.     @ColumnWidth(25)
    30.     @ExcelProperty({"客户所在地址"})
    31.     private String address;
    32.  
    33.     @ExcelProperty({"联系人信息", "联系人姓名"})
    34.     private String personName;
    35.  
    36.     @ExcelProperty({"联系人信息", "联系电话"})
    37.     private String telephone;
    38.  
    39.     @ExcelProperty({"图片"})
    40.     private URL picture;
    41.  
    42.     /**
    43.      * 你也可以通过字符串的形式来保存图片，具体说明见注意事项3.1
    44.      */
    45.     //@ExcelProperty(converter = StringImageConverter.class, value = {"本地图片"})
    46.     //private String localPic;
    47. }

    2.2 Controller 层

    1. @PostMapping("/exportExcel")
    2. @ApiOperation("导出Excel")
    3. public void exportExcel(HttpServletResponse response) throws Exception {
    4. 	// 查询需要导出的数据
    5. 	List result = getData();
    6.  
    7. 	// 1设置表头样式
    8. 	WriteCellStyle headStyle = new WriteCellStyle();
    9. 	// 1.1设置表头数据居中
    10. 	headStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
    11.  
    12. 	// 2设置表格内容样式
    13. 	WriteCellStyle bodyStyle = new WriteCellStyle();
    14. 	// 2.1设置表格内容水平居中
    15. 	bodyStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
    16. 	// 2.2设置表格内容垂直居中
    17. 	bodyStyle.setVerticalAlignment(VerticalAlignment.CENTER);
    18.  
    19. 	// 3设置表格sheet样式
    20. 	WriteSheet sheet = EasyExcel.writerSheet("客户信息").head(Customer.class).sheetNo(1).build();
    21. 	// 4拿到表格处理对象
    22. 	ExcelWriter writer = EasyExcel.write(response.getOutputStream()).needHead(true).excelType(ExcelTypeEnum.XLSX)
    23.             // 设置需要待合并的行和列。参数1：数值数组，指定需要合并的列；参数2：数值，指定从第几行开始合并
    24. 			.registerWriteHandler(new ExcelMergeCellHandler(new int[]{0, 1, 2, 5}, 0))
    25.             // 设置单元格的风格样式
    26. 			.registerWriteHandler(new HorizontalCellStyleStrategy(headStyle, bodyStyle))
    27. 			.build();
    28.  
    29. 	// 5写入excel数据
    30. 	writer.write(result, sheet);
    31. 	// 6通知浏览器以附件的形式下载处理，设置返回头要注意文件名有中文
    32. 	response.setHeader("Content-disposition", "attachment;filename=" + new String("客户信息表".getBytes("gb2312"), "ISO8859-1") + ".xlsx");
    33. 	response.setContentType("multipart/form-data");
    34. 	response.setCharacterEncoding("utf-8");
    35. 	writer.finish();
    36. }

    2.3 自定义拦截器（ExcelMergeCellHandler）

    1. import com.alibaba.excel.metadata.Head;
    2. import com.alibaba.excel.metadata.data.WriteCellData;
    3. import com.alibaba.excel.write.handler.CellWriteHandler;
    4. import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
    5. import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
    6. import lombok.AllArgsConstructor;
    7. import lombok.Data;
    8. import lombok.NoArgsConstructor;
    9. import org.apache.poi.ss.usermodel.Cell;
    10. import org.apache.poi.ss.usermodel.CellType;
    11. import org.apache.poi.ss.usermodel.Sheet;
    12. import org.apache.poi.ss.util.CellRangeAddress;
    13.  
    14. import java.util.List;
    15.  
    16. /**
    17.  * @author DaHuaJia
    18.  * @Description 自定义单元格合并处理Handler类
    19.  * @Date 2022-08-18 19:25:58
    20.  */
    21. @Data
    22. @NoArgsConstructor
    23. @AllArgsConstructor
    24. public class ExcelMergeCellHandler implements CellWriteHandler {
    25.     // 需要合并的列，从0开始算
    26.     private int[] mergeColIndex;
    27.     // 从指定的行开始合并，从0开始算
    28.     private int mergeRowIndex;
    29.  
    30.     /**
    31.      * 在单元格上的所有操作完成后调用，遍历每一个单元格，判断是否需要向上合并
    32.      */
    33.     @Override
    34.     public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
    35.         // 获取当前单元格行下标
    36.         int currRowIndex = cell.getRowIndex();
    37.         // 获取当前单元格列下标
    38.         int currColIndex = cell.getColumnIndex();
    39.         // 判断是否大于指定行下标，如果大于则判断列是否也在指定的需要的合并单元列集合中
    40.         if (currRowIndex > mergeRowIndex) {
    41.             for (int i = 0; i < mergeColIndex.length; i++) {
    42.                 if (currColIndex == mergeColIndex[i]) {
    43.                     /**
    44.                      * 获取列表数据的唯一标识。不同集合的数据即使数值相同也不合并
    45.                      * 注意：我这里的唯一标识为客户编号（Customer.userCode），在第一列，即下标为0。大家需要结合业务逻辑来做修改
    46.                      */
    47.                     // 获取当前单元格所在的行数据的唯一标识
    48.                     Object currCode = cell.getRow().getCell(0).getStringCellValue();
    49.                     // 获取当前单元格的正上方的单元格所在的行数据的唯一标识
    50.                     Object preCode = cell.getSheet().getRow(currRowIndex - 1).getCell(0).getStringCellValue();
    51.                     // 判断两条数据的是否是同一集合，只有同一集合的数据才能合并单元格
    52.                     if(preCode.equals(currCode)){
    53.                         // 如果都符合条件，则向上合并单元格
    54.                         mergeWithPrevRow(writeSheetHolder, cell, currRowIndex, currColIndex);
    55.                         break;
    56.                     }
    57.                 }
    58.             }
    59.         }
    60.     }
    61.  
    62.     /**
    63.      * 当前单元格向上合并
    64.      *
    65.      * @param writeSheetHolder 表格处理句柄
    66.      * @param cell             当前单元格
    67.      * @param currRowIndex     当前行
    68.      * @param currColIndex     当前列
    69.      */
    70.     private void mergeWithPrevRow(WriteSheetHolder writeSheetHolder, Cell cell, int currRowIndex, int currColIndex) {
    71.         // 获取当前单元格数值
    72.         Object currData = cell.getCellTypeEnum() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
    73.         // 获取当前单元格正上方的单元格对象
    74.         Cell preCell = cell.getSheet().getRow(currRowIndex - 1).getCell(currColIndex);
    75.         // 获取当前单元格正上方的单元格的数值
    76.         Object preData = preCell.getCellTypeEnum() == CellType.STRING ? preCell.getStringCellValue() : preCell.getNumericCellValue();
    77.  
    78.         // 将当前单元格数值与其正上方单元格的数值比较
    79.         if (preData.equals(currData)) {
    80.             Sheet sheet = writeSheetHolder.getSheet();
    81.             List mergeRegions = sheet.getMergedRegions();
    82.             // 当前单元格的正上方单元格是否是已合并单元格
    83.             boolean isMerged = false;
    84.             for (int i = 0; i < mergeRegions.size() && !isMerged; i++) {
    85.                 CellRangeAddress address = mergeRegions.get(i);
    86.                 // 若上一个单元格已经被合并，则先移出原有的合并单元，再重新添加合并单元
    87.                 if (address.isInRange(currRowIndex - 1, currColIndex)) {
    88.                     sheet.removeMergedRegion(i);
    89.                     address.setLastRow(currRowIndex);
    90.                     sheet.addMergedRegion(address);
    91.                     isMerged = true;
    92.                 }
    93.             }
    94.             // 若上一个单元格未被合并，则新增合并单元
    95.             if (!isMerged) {
    96.                 CellRangeAddress cellRangeAddress = new CellRangeAddress(currRowIndex - 1, currRowIndex, currColIndex, currColIndex);
    97.                 sheet.addMergedRegion(cellRangeAddress);
    98.             }
    99.         }
    100.     }
    101. }

    2.4 getDate方法（用于模拟service层拿到的数据）

    1. public static List getData() throws Exception {
    2. 	List data = new ArrayList<>();
    3.  
    4. 	Customer customer = new Customer("JiangXi", "江西电信公司", "江西省南昌市东湖区", "张三", "12345678910", new URL("https://m.360buyimg.com/babel/jfs/t1/221733/11/14107/61280/62fde84dE467522ce/79bbd42aa93f5a83.jpg"));
    5. 	data.add(customer);
    6. 	Customer customer2 = new Customer("JiangXi", "江西电信公司", "江西省南昌市东湖区", "李四", "15848563521", new URL("https://m.360buyimg.com/babel/jfs/t1/221733/11/14107/61280/62fde84dE467522ce/79bbd42aa93f5a83.jpg"));
    7. 	data.add(customer2);
    8.  
    9. 	Customer customer3 = new Customer("GuangDong", "广东电信公司", "广东省广州市花都区", "小明", "15847953624", new URL("https://m.360buyimg.com/babel/jfs/t1/215924/36/19623/23344/62baa985E4df523c6/4893237860b306d6.jpg"));
    10. 	data.add(customer3);
    11. 	Customer customer4 = new Customer("GuangDong", "广东电信公司", "广东省广州市天河区", "小红", "16849531548", new URL("https://m.360buyimg.com/babel/jfs/t1/189640/15/26493/35837/62baa97eE6abda209/461f91e682d0e81a.jpg"));
    12. 	data.add(customer4);
    13. 	Customer customer5 = new Customer("GuangDong", "广东电信公司", "广东省广州市天河区", "小华", "16985632481", new URL("https://m.360buyimg.com/babel/jfs/t1/189640/15/26493/35837/62baa97eE6abda209/461f91e682d0e81a.jpg"));
    14. 	data.add(customer5);
    15.  
    16. 	Customer customer6 = new Customer("BeiJing", "北京电信公司", "北京市东城区", "姜维", "16598645874", new URL("https://m.360buyimg.com/babel/jfs/t1/31481/11/16081/24873/62baa97dE6f3991d0/94ae13d66b9bbfdd.jpg"));
    17. 	data.add(customer6);
    18.  
    19. 	return data;
    20. }

    2.5 效果

     三、注意事项

    3.1 图片导出问题

    对于图片的导出，其字段可以有多种数据类型，官网就介绍了5种（File、InputStream、String、byte[]、URL、WriteCellData）。这里简要介绍一下String 和 URL。

    1、String 类型

    1. /**
    2. *  如果图片地址通过String类型保存，则需要加一个自带的类型转换器（StringImageConverter）
    3. */
    4. @ExcelProperty(converter = StringImageConverter.class, value = {"本地图片"})
    5. private String localPic;

    2、URL类型 

    1. @ExcelProperty({"网络图片"})
    2. private URL picture;

            经过测试发现，String类型只能保存本地图片地址，如果保存网络图片地址，则会导致图片无法下载。原因则是EasyExcel会把“//” 转换成 “\”，导致地址错误。

            因此，可以约定String类型用于保存本地图片地址，URL类型用于保存网络图片地址。

    3.2 图片单元格合并问题

            图片类型单元格无法做到相同的图片合并单元格，主要是因为无法通过单元格对象拿到图片的序列化值。

    3.3 表格样式

            表格的样式既可以表格样式类（例如：WriteCellStyle）来设置，也可以通过注解（例如：@HeadStyle）来设置，两者互补，不冲突。

  • 相关阅读:
    python 执行cmd命令，输出日志的几种写法
    服务器部署 CentOS、VeraCrypt、Docker、主从MySQL、Redis、备份等
    【信号隐藏-数字水印】基于小波变换算法DWT结合离散余弦变换DCT实现音频数字水印嵌入提取附matlab代码
    前端求职难？那是你没看见这个
    成都理工大学_Python程序设计_第8章
    【eslint 插件开发】禁用 location 跳转外部链接
    Java18知多少
    【Redis7】--3.Redis持久化
    Vue+ECharts实现可视化地图
    基于一种交互式的光伏组件特性曲线算法（Matlab代码实现）
  • 原文地址：https://blog.csdn.net/qq_41057885/article/details/126411957