qidao123.com技术社区-IT企服评测·应用市场

标题: Easyexcel（6-单位格合并） [打印本页]

---

作者: 饭宝    时间: 2025-3-8 16:14
标题: Easyexcel（6-单位格合并）
注解

@ContentLoopMerge

用于设置合并单位格的注解，作用于字段上

• eachRow：每隔几行合并
  
• columnExtend：合并列的下标
  

1. @AllArgsConstructor
2. @NoArgsConstructor
3. @Data
4. public class User {
6.     @ContentLoopMerge(eachRow = 2, columnExtend = 1)
7.     @ExcelProperty(value = "用户Id")
8.     private Integer userId;
10.     @ExcelProperty(value = "姓名")
11.     private String name;
13.     @ExcelProperty(value = "手机")
14.     private String phone;
16.     @ExcelProperty(value = "邮箱")
17.     private String email;
19.     @ExcelProperty(value = "创建时间")
20.     private Date createTime;
21. }

复制代码

@OnceAbsoluteMerge

用于指定位置的单位格合并，作用于类上

• firstRowIndex：第一行下标
  
• lastRowIndex：最后一行下标
  
• firstColumnIndex：第一列下标
  
• lastColumnIndex：最后一列下标
  

1. @OnceAbsoluteMerge(firstColumnIndex = 0, lastColumnIndex = 0, firstRowIndex = 1, lastRowIndex = 2)
2. @AllArgsConstructor
3. @NoArgsConstructor
4. @Data
5. public class User {
7.     @ExcelProperty(value = "用户Id")
8.     private Integer userId;
10.     @ExcelProperty(value = "姓名")
11.     private String name;
13.     @ExcelProperty(value = "手机")
14.     private String phone;
16.     @ExcelProperty(value = "邮箱")
17.     private String email;
19.     @ExcelProperty(value = "创建时间")
20.     private Date createTime;
21. }

复制代码

类方法

LoopMergeStrategy

源码查看

1. public class LoopMergeStrategy implements RowWriteHandler {
3.     // 每隔几行合并
4.     private final int eachRow;
6.     // 合并几列
7.     private final int columnExtend;
9.     // 合并列
10.     private final int columnIndex;
12.     public LoopMergeStrategy(int eachRow, int columnIndex) {
13.         this(eachRow, 1, columnIndex);
14.     }
16.     public LoopMergeStrategy(int eachRow, int columnExtend, int columnIndex) {
17.         if (eachRow < 1) {
18.             throw new IllegalArgumentException("EachRows must be greater than 1");
19.         }
20.         if (columnExtend < 1) {
21.             throw new IllegalArgumentException("ColumnExtend must be greater than 1");
22.         }
23.         if (columnExtend == 1 && eachRow == 1) {
24.             throw new IllegalArgumentException("ColumnExtend or eachRows must be greater than 1");
25.         }
26.         if (columnIndex < 0) {
27.             throw new IllegalArgumentException("ColumnIndex must be greater than 0");
28.         }
29.         this.eachRow = eachRow;
30.         this.columnExtend = columnExtend;
31.         this.columnIndex = columnIndex;
32.     }
34.     public LoopMergeStrategy(LoopMergeProperty loopMergeProperty, Integer columnIndex) {
35.         this(loopMergeProperty.getEachRow(), loopMergeProperty.getColumnExtend(), columnIndex);
36.     }
38.     @Override
39.     public void afterRowDispose(RowWriteHandlerContext context) {
40.         // 判断是否为表头
41.         if (context.getHead() || context.getRelativeRowIndex() == null) {
42.             return;
43.         }
44.         // 循环进行单元格合并
45.         if (context.getRelativeRowIndex() % eachRow == 0) {
46.             CellRangeAddress cellRangeAddress = new CellRangeAddress(context.getRowIndex(),
47.                 context.getRowIndex() + eachRow - 1,
48.                 columnIndex, columnIndex + columnExtend - 1);
49.             context.getWriteSheetHolder().getSheet().addMergedRegionUnsafe(cellRangeAddress);
50.         }
51.     }
52. }

复制代码

根本使用

通过 registerWriteHandler 方法设置单位格合并策略，用于指定某几列每相差几行进行单位格合并

• 指定单列合并
  

1. @GetMapping("/download1")
2. public void download1(HttpServletResponse response) {
3.     try {
4.         response.setContentType("application/vnd.ms-excel");
5.         response.setCharacterEncoding("utf-8");
6.         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
7.         String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
8.         response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");
10.         User user1 = new User();
11.         user1.setUserId(123);
12.         user1.setName("as");
13.         user1.setPhone("15213");
14.         user1.setEmail("5456");
15.         user1.setCreateTime(new Date());
17.         User user2 = new User();
18.         user2.setUserId(123);
19.         user2.setName("asbnm");
20.         user2.setPhone("15213");
21.         user2.setEmail("5456");
22.         user2.setCreateTime(new Date());
24.         User user3 = new User();
25.         user3.setUserId(123);
26.         user3.setName("as");
27.         user3.setPhone("46543213");
28.         user3.setEmail("5456");
29.         user3.setCreateTime(new Date());
30.         
31.         // 第1列每隔2行合并一次
32.         LoopMergeStrategy loopMergeStrategy = new LoopMergeStrategy(2, 0);
33.         EasyExcel.write(response.getOutputStream(), User.class)
34.                 .registerWriteHandler(loopMergeStrategy)
35.                 .sheet("模板")
36.                 .doWrite(Arrays.asList(user1, user2, user3));
37.     } catch (Exception e) {
38.         e.printStackTrace();
39.     }
40. }

复制代码

• 指定多列合并
  

1. @GetMapping("/download1")
2. public void download1(HttpServletResponse response) {
3.     try {
4.         response.setContentType("application/vnd.ms-excel");
5.         response.setCharacterEncoding("utf-8");
6.         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
7.         String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
8.         response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");
10.         User user1 = new User();
11.         user1.setUserId(123);
12.         user1.setName("as");
13.         user1.setPhone("15213");
14.         user1.setEmail("5456");
15.         user1.setCreateTime(new Date());
17.         User user2 = new User();
18.         user2.setUserId(123);
19.         user2.setName("asbnm");
20.         user2.setPhone("15213");
21.         user2.setEmail("5456");
22.         user2.setCreateTime(new Date());
24.         User user3 = new User();
25.         user3.setUserId(123);
26.         user3.setName("as");
27.         user3.setPhone("46543213");
28.         user3.setEmail("5456");
29.         user3.setCreateTime(new Date());
30.         // 第2列开始每隔2行合并一次，从第2列开始的两列进行合并
31.         LoopMergeStrategy loopMergeStrategy = new LoopMergeStrategy(2, 2, 2);
32.         EasyExcel.write(response.getOutputStream(), User.class)
33.                 .registerWriteHandler(loopMergeStrategy)
34.                 .sheet("模板")
35.                 .doWrite(Arrays.asList(user1, user2, user3));
36.     } catch (Exception e) {
37.         e.printStackTrace();
38.     }
39. }

复制代码

OnceAbsoluteMergeStrategy

源码查看

1. public class OnceAbsoluteMergeStrategy implements SheetWriteHandler {
3.     // 第一行
4.     private final int firstRowIndex;
6.     // 最后一行
7.     private final int lastRowIndex;
9.     // 第一列
10.     private final int firstColumnIndex;
12.     // 最后一列
13.     private final int lastColumnIndex;
15.     public OnceAbsoluteMergeStrategy(int firstRowIndex, int lastRowIndex, int firstColumnIndex, int lastColumnIndex) {
16.         if (firstRowIndex < 0 || lastRowIndex < 0 || firstColumnIndex < 0 || lastColumnIndex < 0) {
17.             throw new IllegalArgumentException("All parameters must be greater than 0");
18.         }
19.         this.firstRowIndex = firstRowIndex;
20.         this.lastRowIndex = lastRowIndex;
21.         this.firstColumnIndex = firstColumnIndex;
22.         this.lastColumnIndex = lastColumnIndex;
23.     }
25.     public OnceAbsoluteMergeStrategy(OnceAbsoluteMergeProperty onceAbsoluteMergeProperty) {
26.         this(onceAbsoluteMergeProperty.getFirstRowIndex(), onceAbsoluteMergeProperty.getLastRowIndex(),
27.             onceAbsoluteMergeProperty.getFirstColumnIndex(), onceAbsoluteMergeProperty.getLastColumnIndex());
28.     }
30.     @Override
31.     public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
32.         CellRangeAddress cellRangeAddress =
33.             new CellRangeAddress(firstRowIndex, lastRowIndex, firstColumnIndex, lastColumnIndex);
34.         writeSheetHolder.getSheet().addMergedRegionUnsafe(cellRangeAddress);
35.     }
36. }

复制代码

根本使用

通过 registerWriteHandler 方法设置单位格合并策略，用于指定一个区域内的单位格进行合并

1. @GetMapping("/download2")
2. public void download2(HttpServletResponse response) {
3.     try {
4.         response.setContentType("application/vnd.ms-excel");
5.         response.setCharacterEncoding("utf-8");
6.         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
7.         String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
8.         response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");
10.         User user1 = new User();
11.         user1.setUserId(123);
12.         user1.setName("as");
13.         user1.setPhone("15213");
14.         user1.setEmail("5456");
15.         user1.setCreateTime(new Date());
17.         User user2 = new User();
18.         user2.setUserId(123);
19.         user2.setName("asbnm");
20.         user2.setPhone("15213");
21.         user2.setEmail("5456");
22.         user2.setCreateTime(new Date());
24.         User user3 = new User();
25.         user3.setUserId(123);
26.         user3.setName("as");
27.         user3.setPhone("46543213");
28.         user3.setEmail("5456");
29.         user3.setCreateTime(new Date());
30.         // 从第1行第3列合并到第3行第3列
31.         OnceAbsoluteMergeStrategy onceAbsoluteMergeStrategy = new OnceAbsoluteMergeStrategy(0, 2, 2, 2);
32.         EasyExcel.write(response.getOutputStream(), User.class)
33.                 .registerWriteHandler(onceAbsoluteMergeStrategy)
34.                 .sheet("模板")
35.                 .doWrite(Arrays.asList(user1, user2, user3));
36.     } catch (Exception e) {
37.         e.printStackTrace();
38.     }
39. }

复制代码

合并单位格工具类

AbstractMergeStrategy

根本思路

• 继续 AbstractMergeStrategy 抽象合并策略，重写 merge 方法
  
• 传入要合并的数据列表，循环判定上下行是否是相同的数据，如果是则为同一个组，否则为另一个组，使用 List 生存每个组的数目
  
• 单位格渲染时，循环遍历每个组的值后，计算要合并的单位格的上下标
  

使用

1. /**
2. * 自定义合并策略 该类继承了AbstractMergeStrategy抽象合并策略，需要重写merge()方法
3. */
4. public class CustomMergeStrategy extends AbstractMergeStrategy {
6.     /**
7.      * 分组，每几行合并一次
8.      */
9.     private List<Integer> exportFieldGroupCountList;
11.     /**
12.      * 目标合并列index
13.      */
14.     private Integer targetColumnIndex;
16.     /**
17.      * 需要开始合并单元格的首行index
18.      */
19.     private Integer rowIndex;
21.     public CustomMergeStrategy(List<String> exportDataList, Integer targetColumnIndex, Integer rowIndex) {
22.         this.exportFieldGroupCountList = getGroupCountList(exportDataList, rowIndex);
23.         this.targetColumnIndex = targetColumnIndex;
24.         this.rowIndex = rowIndex;
25.     }
27.     // 该方法将目标列根据值是否相同连续可合并，存储可合并的行数
28.     private List<Integer> getGroupCountList(List<String> exportDataList, Integer rowIndex) {
29.         if (CollectionUtils.isEmpty(exportDataList)) {
30.             return new ArrayList<>();
31.         }
33.         List<Integer> groupCountList = new ArrayList<>();
34.         int count = 1;
35.         for (int i = rowIndex + 1, len = exportDataList.size(); i < len; i++) {
36.             // 判断上一列和当前列的值是否相同
37.             if (exportDataList.get(i).equals(exportDataList.get(i - 1))) {
38.                 count++;
39.             } else {
40.                 groupCountList.add(count);
41.                 count = 1;
42.             }
43.         }
44.         // 处理完最后一条后
45.         groupCountList.add(count);
46.         return groupCountList;
47.     }
49.     @Override
50.     protected void merge(Sheet sheet, Cell cell, Head head, Integer relativeRowIndex) {
51.         if (null == rowIndex) {
52.             rowIndex = cell.getRowIndex();
53.         }
54.         // 仅从首行以及目标列的单元格开始合并，忽略其他
55.         if (cell.getRowIndex() == rowIndex + 1 && cell.getColumnIndex() == targetColumnIndex) {
56.             mergeGroupColumn(sheet);
57.         }
58.     }
60.     private void mergeGroupColumn(Sheet sheet) {
61.         int rowCount = rowIndex + 1;
62.         for (Integer count : exportFieldGroupCountList) {
63.             if (count == 1) {
64.                 rowCount += count;
65.                 continue;
66.             }
67.             // 合并单元格
68.             CellRangeAddress cellRangeAddress = new CellRangeAddress(rowCount, rowCount + count - 1, targetColumnIndex, targetColumnIndex);
69.             sheet.addMergedRegionUnsafe(cellRangeAddress);
70.             rowCount += count;
71.         }
72.     }
73. }

复制代码

• 从首行开始合并单位格
  

1. @GetMapping("/download3")
2. public void download3(HttpServletResponse response) {
3.     try {
4.         response.setContentType("application/vnd.ms-excel");
5.         response.setCharacterEncoding("utf-8");
6.         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
7.         String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
8.         response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");
10.         User user1 = new User();
11.         user1.setUserId(123);
12.         user1.setName("as");
13.         user1.setPhone("15213");
14.         user1.setEmail("5456");
15.         user1.setCreateTime(new Date());
17.         User user2 = new User();
18.         user2.setUserId(123);
19.         user2.setName("asbnm");
20.         user2.setPhone("15213");
21.         user2.setEmail("5456");
22.         user2.setCreateTime(new Date());
24.         User user3 = new User();
25.         user3.setUserId(123);
26.         user3.setName("as");
27.         user3.setPhone("46543213");
28.         user3.setEmail("5456");
29.         user3.setCreateTime(new Date());
31.         List<User> userList = Arrays.asList(user1, user2, user3);
32.         CustomMergeStrategy customMergeStrategy = new CustomMergeStrategy(userList.stream().map(e ->
33.                 String.valueOf(e.getUserId())).collect(Collectors.toList()), 0, 0);
34.         EasyExcel.write(response.getOutputStream(), User.class)
35.                 .registerWriteHandler(customMergeStrategy)
36.                 .sheet("模板")
37.                 .doWrite(userList);
38.     } catch (Exception e) {
39.         e.printStackTrace();
40.     }
41. }

复制代码

• 从指定行开始合并单位格
  

1. @GetMapping("/download3")
2. public void download3(HttpServletResponse response) {
3.     try {
4.         response.setContentType("application/vnd.ms-excel");
5.         response.setCharacterEncoding("utf-8");
6.         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
7.         String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
8.         response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xls");
10.         User user1 = new User();
11.         user1.setUserId(123);
12.         user1.setName("as");
13.         user1.setPhone("15213");
14.         user1.setEmail("5456");
15.         user1.setCreateTime(new Date());
17.         User user2 = new User();
18.         user2.setUserId(123);
19.         user2.setName("asbnm");
20.         user2.setPhone("15213");
21.         user2.setEmail("5456");
22.         user2.setCreateTime(new Date());
24.         User user3 = new User();
25.         user3.setUserId(123);
26.         user3.setName("as");
27.         user3.setPhone("46543213");
28.         user3.setEmail("5456");
29.         user3.setCreateTime(new Date());
31.         List<User> userList = Arrays.asList(user1, user2, user3);
32.         CustomMergeStrategy customMergeStrategy = new CustomMergeStrategy(userList.stream().map(e ->
33.                 String.valueOf(e.getUserId())).collect(Collectors.toList()), 0, 1);
34.         EasyExcel.write(response.getOutputStream(), User.class)
35.                 .registerWriteHandler(customMergeStrategy)
36.                 .sheet("模板")
37.                 .doWrite(userList);
38.     } catch (Exception e) {
39.         e.printStackTrace();
40.     }
41. }

复制代码

CellWriteHandler

根本思路

• 实现 CellWriteHandler 类的 afterCellDispose 方法，在每个单位格完全创建完之后执行合并单位格操作
  
• 判定当前列是否为要合并的列，且当前行是否已经到达要操作的行数
  
• 如果是，则判定上一行和当前行的数据是否一致，且序号是否一致
  
• 如果是，则进行合并单位格操作，如果上一行已经被合并过了，则进行移除，然后再重新合并单位格
  

使用

[code]/** * excel合并单位格导出工具类 */public class EasyExcelUtil implements CellWriteHandler {    /**     * 需要合并的列     */    private int[] mergeColumnIndex;    /**     * 从哪一行开始合并     */    private int mergeRowIndex;    public EasyExcelUtil() {    }    public EasyExcelUtil(int mergeRowIndex, int[] mergeColumnIndex) {        this.mergeRowIndex = mergeRowIndex;        this.mergeColumnIndex = mergeColumnIndex;    }    /**     * 创建每个单位格之前执行     *     * @param writeSheetHolder     * @param writeTableHolder     * @param row     * @param head     * @param columnIndex     * @param relativeRowIndex     * @param isHead     */    @Override    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,                                 Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {        CellWriteHandler.super.beforeCellCreate(writeSheetHolder, writeTableHolder, row, head, columnIndex, relativeRowIndex, isHead);    }    /**     * 每个单位格数据内容渲染之后执行     *     * @param writeSheetHolder     * @param writeTableHolder     * @param cellData     * @param cell     * @param head     * @param relativeRowIndex     * @param isHead     */    @Override    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, WriteCellData cellData,                                       Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {        CellWriteHandler.super.afterCellDataConverted(writeSheetHolder, writeTableHolder, cellData, cell, head, relativeRowIndex, isHead);    }    /**     * 每个单位格完全创建完之后执行     *     * @param writeSheetHolder     * @param writeTableHolder     * @param cellDataList     * @param cell     * @param head     * @param relativeRowIndex     * @param isHead     */    @Override    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List

---

欢迎光临 qidao123.com技术社区-IT企服评测·应用市场 (https://dis.qidao123.com/)

Powered by Discuz! X3.4