【EasyExcel】复杂导出操作-自界说颜色样式等（版本3.1.x） ...

---

前言

   本文简单先容阿里的EasyExcel的复杂导出操作，包括自界说样式，根据数据合并单元格等。
  点击查看EasyExcel官方文档

---

一、自界说拦截器

要实现复杂导出，靠现有的拦截器怕是不大够用，EasyExcel 已经有提供部分像是 自界说样式的策略HorizontalCellStyleStrategy

通过源码，我们不难发现其原理正是实现了拦截器接口，使用了afterCellDispose方法，在数据写入单元格后会调用该方法，因此，需要举行复杂操作，我们需要自界说拦截器，在afterCellDispose方法举行逻辑处置惩罚，此中我们可以通过context参数获取到表，行，列及单元格数据等信息：

二、自界说操作

1.自界说颜色

   由于WriteCellStyle 及CellStyle接口的设置单元格配景颜色方法setFillForegroundColor不支持自界说颜色，我在网上找了半天，以及询问阿里自家ai助手通义得到的答案都是往里塞一个XSSFColor这样的答案，但这个方法传参是一个short类型的index呀，是预设好的颜色，内里也没有找到其他重载方法。（这里针对的是导出xlsx文件）
  

而真正可以自界说颜色的是XSSFCellStyle类，XSSFCellStyle实现CellStyle接口，并重载了该方法，于是我们只需要在workbook.createCellStyle()的时间将其强转为XSSFCellStyle：

1. // 将背景设置成浅蓝色
2. XSSFColor customColor = new XSSFColor(new java.awt.Color(181, 198, 234), null);
3. XSSFCellStyle style = (XSSFCellStyle)workbook.createCellStyle();
4. style.setFillForegroundColor(customColor);
5. style.setFillPattern(FillPatternType.SOLID_FOREGROUND);
6. cell.setCellStyle(style);

复制代码

  在idea我们可以使用 ctrl + alt + 鼠标点击接口，来查看接口的全部实现类（HSSF是针对xls的）：
  

然而在我们自界说的拦截器中，操作当前单元格样式时会无法见效，这是由于在3.1.x版本后有一个FillStyleCellWriteHandler拦截器，他会把OriginCellStyle和WriteCellStyle合并，会已WriteCellStyle样式为主，他的order是50000，而我们自界说的拦截器默认是0，因此我们修改的样式会被覆盖。

解决方法很简单，我们可以在我们的自界说拦截器重写order方法，将其值设置大于50000即可

1.   @Override
2.   public int order() {
3.       return 50001;
4.   }

复制代码

如果你没有使用自界说拦截器（如HorizontalCellStyleStrategy ）以及没有设置WriteCellStyle 样式，则还可以将ignoreFillStyle置为true，

1. @Override
2. public void afterCellDispose(CellWriteHandlerContext context) {
3.          context.setIgnoreFillStyle(true);
4.          // 做其他样式操作
5. }

复制代码

2.合并单元格

1. ```java
2. @Override
3. public void afterCellDispose(CellWriteHandlerContext context) {
4.          // 判断当前为表头，不执行操作
5.      if (isHead) {
6.             log.info("\r\n当前为表头, 不执行操作");
7.             return;
8.      }
9.      // 获取当前单元格
10.      context.getCell()
11.      // 当前 Sheet
12.      Sheet sheet = cell.getSheet();
13.      // 当前单元格所在行索引
14.      int rowIndexCurr = cell.getRowIndex();
15.      // 当前单元格所在列索引
16.      int columnIndex = cell.getColumnIndex();
17.      // 当前单元格所在行的上一行索引
18.      int rowIndexPrev = rowIndexCurr - 1;
19.      // 当前单元格所在行的 Row 对象
20.      Row rowCurr = cell.getRow();
21.      // 当前单元格所在行的上一行 Row 对象
22.      Row rowPrev = sheet.getRow(rowIndexPrev);
23.      // 当前单元格的上一行同列单元格
24.      Cell cellPrev = rowPrev.getCell(columnIndex);
25.          // 合并同列不同行的相邻两个单元格
26.      sheet.addMergedRegion(new CellRangeAddress(rowIndexPrev, rowIndexCurr,columnIndex, columnIndex));
27.          
28. }

复制代码

需要注意的是，如果要合并的单元格已经被其他单元格合并过，则不能直接使用这个合并方法，需要先解除合并，再举行组合合并：

1. // 从 Sheet 中，获取所有合并区域
2. List<CellRangeAddress> mergedRegions = sheet.getMergedRegions();
3. // 判断是否合并过
4. boolean merged = false;
5. // 遍历合并区域集合
6. for (int i = 0; i < mergedRegions.size(); i++) {
7.      CellRangeAddress cellAddresses = mergedRegions.get(i);
8.      // 判断 cellAddress 的范围是否是从 rowIndexPrev 到 cell.getColumnIndex()
9.      if (cellAddresses.isInRange(rowIndexPrev, cell.getColumnIndex())) {
10.          // 解除合并
11.          sheet.removeMergedRegion(i);
12.          // 设置范围最后一行，为当前行
13.          cellAddresses.setLastRow(rowIndexCurr);
14.          // 重新进行合并
15.          sheet.addMergedRegion(cellAddresses);
16.          merged = true;
17.          break;
18.      }
19. }
20. // merged=false，表示当前单元格为第一次合并
21. if (!merged) {
22.      CellRangeAddress cellAddresses = new CellRangeAddress(rowIndexPrev, rowIndexCurr, cell.getColumnIndex(), cell.getColumnIndex());
23.      sheet.addMergedRegion(cellAddresses);
24. }

复制代码

三、复杂操作示例

自界说拦截器代码如下（示例）：
1.实体(使用了注解式样式)：

1. package com.mhqs.demo.tool.easyExcel.entity;
4. import com.alibaba.excel.annotation.ExcelProperty;
5. import com.alibaba.excel.annotation.write.style.ColumnWidth;
6. import com.alibaba.excel.annotation.write.style.ContentFontStyle;
7. import com.alibaba.excel.annotation.write.style.HeadFontStyle;
8. import com.alibaba.excel.annotation.write.style.HeadRowHeight;
9. import lombok.Data;
10. import lombok.EqualsAndHashCode;
12. import java.math.BigDecimal;
14. /**
15. * 账单实体类
16. * @author 棉花
17. * */
18. @Data
19. @EqualsAndHashCode(callSuper = false)
20. @HeadFontStyle(fontHeightInPoints = 10)
21. @HeadRowHeight(27)
22. @ColumnWidth(13)
23. @ContentFontStyle(fontName = "宋体",fontHeightInPoints = 11)
24. public class DemoEntity extends EasyExcelEntity {
26.     @ExcelProperty({"账期"})
27.     private String settlePeriod;
29.     @ExcelProperty({"服务商"})
30.     private String stockCreatorMchid;
32.     @ExcelProperty({"地区"})
33.     private String place;
35.     @ExcelProperty({"金额（元）"})
36.     private BigDecimal consumeAmount;
38.     public DemoEntity(String settlePeriod, String stockCreatorMchid,String place, BigDecimal consumeAmount){
39.         this.settlePeriod = settlePeriod;
40.         this.stockCreatorMchid = stockCreatorMchid;
41.         this.place = place;
42.         this.consumeAmount = consumeAmount;
43.     }
45. }

复制代码

2.自界说拦截器

1. package com.mhqs.demo.tool.easyExcel.handler;
3. import com.alibaba.excel.EasyExcel;
4. import com.alibaba.excel.ExcelWriter;
5. import com.alibaba.excel.metadata.Head;
6. import com.alibaba.excel.metadata.data.WriteCellData;
7. import com.alibaba.excel.util.StyleUtil;
8. import com.alibaba.excel.write.handler.CellWriteHandler;
9. import com.alibaba.excel.write.metadata.WriteSheet;
10. import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
11. import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
12. import com.alibaba.excel.write.metadata.style.WriteCellStyle;
13. import com.mhqs.demo.tool.easyExcel.entity.DemoEntity;
14. import org.apache.poi.ss.usermodel.*;
15. import org.apache.poi.ss.util.CellRangeAddress;
16. import org.apache.poi.xssf.usermodel.XSSFCellStyle;
17. import org.apache.poi.xssf.usermodel.XSSFColor;
19. import java.math.BigDecimal;
20. import java.util.*;
22. /**
23. * @author bcb
24. * 账单导出样式处理
25. */
26. public class CustomCellWriteHandler implements CellWriteHandler {
28.     /**
29.      * 自定义颜色
30.      */
31.     private final java.awt.Color color;
32.     /**
33.      * 自定义颜色样式
34.      */
35.     private CellStyle colorfulCellStyle;
36.     /**
37.      * 自定义特殊金额样式
38.      */
39.     private CellStyle specialCellStyle;
40.     /**
41.      * 头样式
42.      */
43.     private final WriteCellStyle headWriteCellStyle;
45.     /**
46.      * 内容样式
47.      */
48.     private final WriteCellStyle contentWriteCellStyle;
50.     /**
51.      * 头样式(可自定义颜色)
52.      */
53.     private CellStyle headCellStyle;
55.     /**
56.      * 内容样式(可自定义颜色)
57.      */
58.     private CellStyle contentCellStyle;
60.     public CustomCellWriteHandler(WriteCellStyle headWriteCellStyle,WriteCellStyle contentWriteCellStyle, java.awt.Color color) {
61.         this.headWriteCellStyle = headWriteCellStyle;
62.         this.contentWriteCellStyle = contentWriteCellStyle;
63.         this.color = color;
64.     }
66.     @Override
67.     public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {
68.         // 在创建单元格之前的操作（如果需要）
69.         Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
70.         if (colorfulCellStyle == null) {
71.             colorfulCellStyle = createColorfulCellStyle(workbook);
72.         }
73.         // 合并样式（以WriteCellStyle为主）
74.         headCellStyle = StyleUtil.buildCellStyle(workbook, colorfulCellStyle, headWriteCellStyle);
75.         contentCellStyle = StyleUtil.buildCellStyle(workbook, workbook.createCellStyle(), contentWriteCellStyle);
77.     }
78.     /*
79.     * 创建自定义颜色样式
80.     */
81.     private CellStyle createColorfulCellStyle(Workbook workbook) {
82.         XSSFColor customColor = new XSSFColor(color, null);
83.         XSSFCellStyle style = (XSSFCellStyle)workbook.createCellStyle();
84.         // 设置自定义颜色
85.         style.setFillForegroundColor(customColor);
86.         style.setFillPattern(FillPatternType.SOLID_FOREGROUND);
87.         // 设置边框
88.         style.setBorderTop(BorderStyle.THIN);
89.         style.setBorderBottom(BorderStyle.THIN);
90.         style.setBorderLeft(BorderStyle.THIN);
91.         style.setBorderRight(BorderStyle.THIN);
92.         // 设置垂直对齐方式
93.         style.setVerticalAlignment(VerticalAlignment.CENTER);
94.         // 设置水平对齐方式
95.         style.setAlignment(HorizontalAlignment.CENTER);
96.         return style;
97.     }
99.     /*
100.      * 创建自定义特殊金额样式
101.      */
102.     private CellStyle createSpecialCellStyle(Workbook workbook) {
103.         if (specialCellStyle == null) {
104.             XSSFCellStyle style = (XSSFCellStyle)createColorfulCellStyle(workbook);
105.             Font font = workbook.createFont();
106.             // 字体加粗
107.             font.setBold(true);
108.             style.setFont(font);
109.             specialCellStyle = style;
110.         }
111.         return specialCellStyle;
112.     }
115.     /**
116.      * 在 Cell 写入后处理
117.      *
118.      * @param writeSheetHolder
119.      * @param writeTableHolder
120.      * @param cellDataList
121.      * @param cell               当前 Cell
122.      * @param head
123.      * @param relativeRowIndex   表格内容行索引，从除表头的第一行开始，索引为0
124.      * @param isHead             是否是表头，true表头，false非表头
125.      */
126.     @Override
127.     public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
128.                                  List<WriteCellData<?>> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
129.         // 当前 Sheet
130.         Sheet sheet = cell.getSheet();
131.         // 判断当前为表头，执行对应样式操作
132.         if (isHead) {
133.             cell.setCellStyle(headCellStyle);
134.         } else {
135.             cell.setCellStyle(contentCellStyle);
136.         }
137.         // 判断当前为表头，不执行操作
138.         if (isHead || relativeRowIndex == 0) {
139.             return;
140.         }
141.         int columnIndex = cell.getColumnIndex();
142.         // 当前 Cell 所在行索引
143.         int rowIndexCurr = cell.getRowIndex();
144.         // 当前 Cell 所在行的上一行索引
145.         int rowIndexPrev = rowIndexCurr - 1;
146.         // 当前 Cell 所在行的 Row 对象
147.         Row rowCurr = cell.getRow();
148.         // 当前 Cell 所在行的上一行 Row 对象
149.         Row rowPrev = sheet.getRow(rowIndexPrev);
150.         // 当前单元格的上一行同列单元格
151.         Cell cellPrev = rowPrev.getCell(columnIndex);
152.         // 当前单元格的值
153.         Object cellValueCurr = cell.getCellType() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
154.         if (columnIndex == 3 && cellValueCurr != null && (double)cellValueCurr > 200) {
155.             // 判断金额大于200就设置特定颜色并加粗，并将上一列同一行的数据也设置特定颜色
156.             CellStyle cellStyle = createSpecialCellStyle(sheet.getWorkbook());
157.             cell.setCellStyle(cellStyle);
158.             // 当前单元格的同行上一列单元格
159.             Cell cellPreC = rowCurr.getCell(columnIndex - 1);
160.             cellPreC.setCellStyle(colorfulCellStyle);
162.         }
163.         // 上面单元格的值
164.         Object cellValuePrev = cellPrev.getCellType() == CellType.STRING ? cellPrev.getStringCellValue() : cellPrev.getNumericCellValue();
165.         /*
166.          * 只判断前两列相同行数据
167.          */
168.         if (columnIndex != 0 && columnIndex != 1) {
169.             return;
170.         }
171.         // 判断当前单元格与上面单元格是否相等，不相等不执行操作
172.         if (!cellValueCurr.equals(cellValuePrev)) {
173.             return;
174.         }
175.         /*
176.          * 当第一列上下两个单元格不一样时，说明不是一个账期数据
177.          */
178.         if (!rowPrev.getCell(0).getStringCellValue().equals(rowCurr.getCell(0).getStringCellValue())) {
179.             return;
180.         }
181.         // 从 Sheet 中，获取所有合并区域
182.         List<CellRangeAddress> mergedRegions = sheet.getMergedRegions();
183.         // 是否合并过
184.         boolean merged = false;
185.         // 遍历合并区域集合
186.         for (int i = 0; i < mergedRegions.size(); i++) {
187.             CellRangeAddress cellAddresses = mergedRegions.get(i);
188.             //判断 cellAddress 的范围是否是从 rowIndexPrev 到 cell.getColumnIndex()
189.             if (cellAddresses.isInRange(rowIndexPrev, columnIndex)) {
190.                 // 从集合中移除
191.                 sheet.removeMergedRegion(i);
192.                 // 设置范围最后一行，为当前行
193.                 cellAddresses.setLastRow(rowIndexCurr);
194.                 // 重新添加到 Sheet 中
195.                 sheet.addMergedRegion(cellAddresses);
196.                 // 已完成合并
197.                 merged = true;
198.                 break;
199.             }
200.         }
201.         // merged=false，表示当前单元格为第一次合并
202.         if (!merged) {
203.             CellRangeAddress cellAddresses = new CellRangeAddress(rowIndexPrev, rowIndexCurr, columnIndex, columnIndex);
204.             sheet.addMergedRegion(cellAddresses);
205.         }
206.     }
208.     /**
209.      * 获取当前处理器优先级
210.      */
211.     @Override
212.     public int order() {
213.         return 50001;
214.     }
217. }

复制代码

3.代码

3.   public static void main(String[] args) {
5.       String fileName = "D:\\temp\\账单.xlsx";
6.       // 设置 Cell 样式
7.       WriteCellStyle writeCellStyle = new WriteCellStyle();
8.       // 设置垂直对齐方式
9.       writeCellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
10.       // 设置水平对齐方式
11.       writeCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
12.       // 设置边框
13.       writeCellStyle.setBorderTop(BorderStyle.THIN);
14.       writeCellStyle.setBorderBottom(BorderStyle.THIN);
15.       writeCellStyle.setBorderLeft(BorderStyle.THIN);
16.       writeCellStyle.setBorderRight(BorderStyle.THIN);
17.       // 自定义颜色
18.       java.awt.Color color = new java.awt.Color(181, 198, 234);
19.       List<DemoEntity> dataList = new ArrayList<>();
20.       for (int i = 0; i < 5; i++) {
21.           dataList.add(new DemoEntity("202301","服务商" + i%2,"地区" + i,new BigDecimal(i * 100)));
22.       }
23.       dataList.sort(Comparator.comparing(DemoEntity::getSettlePeriod).thenComparing(DemoEntity::getStockCreatorMchid));
25.       ExcelWriter excelWriter = EasyExcel.write(fileName, DemoEntity.class).build();
26.       WriteSheet writeSheet = EasyExcel.writerSheet(0, "账单")
27.               .registerWriteHandler(new CustomCellWriteHandler(null,writeCellStyle,color))
28.               .build();
29.       excelWriter.write(dataList, writeSheet);
30.         // 需要多sheet则可以继续
31.         // WriteSheet writeSheet2 = EasyExcel.writerSheet(1, "第二个sheet")
33.       excelWriter.finish();
34.   }

复制代码

4.终极效果

待续…

---

参考文章：
easyexcel 3.1.0+，设置RBG配景颜色
EasyExcel导出多sheet并设置单元格样式
EasyExcel的CellWriteHandler注入CellStyle不见效

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。