修复`table`、`sheet`中创建的拦截器不执行`workbook`事件的bug #1202

src/main/java/com/alibaba/excel/context/WriteContextImpl.java

@@ -111,7 +111,14 @@ public class WriteContextImpl implements WriteContext {
         if (selectSheetFromCache(writeSheet)) {
             return;
         }
+
+
         initCurrentSheetHolder(writeSheet);
+
+        // Workbook handler need to supplementary execution
+        WriteHandlerUtils.beforeWorkbookCreate(this, true);
+        WriteHandlerUtils.afterWorkbookCreate(this, true);
+
         // Initialization current sheet
         initSheet(writeType);
     }
@@ -201,8 +208,8 @@ public class WriteContextImpl implements WriteContext {
         if (currentWriteHolder.automaticMergeHead()) {
             addMergedRegionToCurrentSheet(excelWriteHeadProperty, newRowIndex);
         }
-        for (int relativeRowIndex = 0, i = newRowIndex; i < excelWriteHeadProperty.getHeadRowNumber() + newRowIndex;
-            i++, relativeRowIndex++) {
+        for (int relativeRowIndex = 0, i = newRowIndex; i < excelWriteHeadProperty.getHeadRowNumber()
+            + newRowIndex; i++, relativeRowIndex++) {
             WriteHandlerUtils.beforeRowCreate(this, newRowIndex, relativeRowIndex, Boolean.TRUE);
             Row row = WorkBookUtil.createRow(writeSheetHolder.getSheet(), i);
             WriteHandlerUtils.afterRowCreate(this, row, relativeRowIndex, Boolean.TRUE);
@@ -251,7 +258,15 @@ public class WriteContextImpl implements WriteContext {
             }
             return;
         }
+
         initCurrentTableHolder(writeTable);
+
+        // Workbook and sheet handler need to supplementary execution
+        WriteHandlerUtils.beforeWorkbookCreate(this, true);
+        WriteHandlerUtils.afterWorkbookCreate(this, true);
+        WriteHandlerUtils.beforeSheetCreate(this, true);
+        WriteHandlerUtils.afterSheetCreate(this, true);
+
         initHead(writeTableHolder.excelWriteHeadProperty());
     }
 

src/main/java/com/alibaba/excel/util/WriteHandlerUtils.java

@@ -2,6 +2,7 @@ package com.alibaba.excel.util;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.poi.ss.usermodel.Cell;
 import org.apache.poi.ss.usermodel.Row;
@@ -24,9 +25,13 @@ public class WriteHandlerUtils {
 
     private WriteHandlerUtils() {}
 
+
     public static void beforeWorkbookCreate(WriteContext writeContext) {
-        List<WriteHandler> handlerList =
-            writeContext.writeWorkbookHolder().writeHandlerMap().get(WorkbookWriteHandler.class);
+        beforeWorkbookCreate(writeContext, false);
+    }
+
+    public static void beforeWorkbookCreate(WriteContext writeContext, boolean runOwn) {
+        List<WriteHandler> handlerList = getHandlerList(writeContext, WorkbookWriteHandler.class, runOwn);
         if (handlerList == null || handlerList.isEmpty()) {
             return;
         }
@@ -38,8 +43,11 @@ public class WriteHandlerUtils {
     }
 
     public static void afterWorkbookCreate(WriteContext writeContext) {
-        List<WriteHandler> handlerList =
-            writeContext.writeWorkbookHolder().writeHandlerMap().get(WorkbookWriteHandler.class);
+        afterWorkbookCreate(writeContext, false);
+    }
+
+    public static void afterWorkbookCreate(WriteContext writeContext, boolean runOwn) {
+        List<WriteHandler> handlerList = getHandlerList(writeContext, WorkbookWriteHandler.class, runOwn);
         if (handlerList == null || handlerList.isEmpty()) {
             return;
         }
@@ -52,7 +60,7 @@ public class WriteHandlerUtils {
 
     public static void afterWorkbookDispose(WriteContext writeContext) {
         List<WriteHandler> handlerList =
-            writeContext.writeWorkbookHolder().writeHandlerMap().get(WorkbookWriteHandler.class);
+            writeContext.currentWriteHolder().writeHandlerMap().get(WorkbookWriteHandler.class);
         if (handlerList == null || handlerList.isEmpty()) {
             return;
         }
@@ -64,7 +72,11 @@ public class WriteHandlerUtils {
     }
 
     public static void beforeSheetCreate(WriteContext writeContext) {
-        List<WriteHandler> handlerList = writeContext.writeSheetHolder().writeHandlerMap().get(SheetWriteHandler.class);
+        beforeSheetCreate(writeContext, false);
+    }
+
+    public static void beforeSheetCreate(WriteContext writeContext, boolean runOwn) {
+        List<WriteHandler> handlerList = getHandlerList(writeContext, SheetWriteHandler.class, runOwn);
         if (handlerList == null || handlerList.isEmpty()) {
             return;
         }
@@ -76,8 +88,13 @@ public class WriteHandlerUtils {
         }
     }
 
+
     public static void afterSheetCreate(WriteContext writeContext) {
-        List<WriteHandler> handlerList = writeContext.writeSheetHolder().writeHandlerMap().get(SheetWriteHandler.class);
+        afterSheetCreate(writeContext, false);
+    }
+
+    public static void afterSheetCreate(WriteContext writeContext, boolean runOwn) {
+        List<WriteHandler> handlerList = getHandlerList(writeContext, SheetWriteHandler.class, runOwn);
         if (handlerList == null || handlerList.isEmpty()) {
             return;
         }
@@ -208,4 +225,15 @@ public class WriteHandlerUtils {
             writeContext.writeWorkbookHolder().getWriteWorkbook().getWriteHandler().row(row.getRowNum(), row);
         }
     }
+
+    private static List<WriteHandler> getHandlerList(WriteContext writeContext, Class<? extends WriteHandler> clazz,
+        boolean runOwn) {
+        Map<Class<? extends WriteHandler>, List<WriteHandler>> writeHandlerMap;
+        if (runOwn) {
+            writeHandlerMap = writeContext.currentWriteHolder().ownWriteHandlerMap();
+        } else {
+            writeHandlerMap = writeContext.currentWriteHolder().writeHandlerMap();
+        }
+        return writeHandlerMap.get(WorkbookWriteHandler.class);
+    }
 }

src/main/java/com/alibaba/excel/write/metadata/holder/AbstractWriteHolder.java

@@ -64,9 +64,14 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
      */
     private ExcelWriteHeadProperty excelWriteHeadProperty;
     /**
-     * Write handler for workbook
+     * Write handler
      */
     private Map<Class<? extends WriteHandler>, List<WriteHandler>> writeHandlerMap;
+    /**
+     * Own write handler.Created in the sheet in the workbook interceptors will not be executed because the workbook to
+     * create an event long past. So when initializing sheet, supplementary workbook event.
+     */
+    private Map<Class<? extends WriteHandler>, List<WriteHandler>> ownWriteHandlerMap;
     /**
      * Use the default style.Default is true.
      */
@@ -177,21 +182,22 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
         List<WriteHandler> handlerList = new ArrayList<WriteHandler>();
 
         // Initialization Annotation
-        initAnnotationConfig(handlerList);
+        initAnnotationConfig(handlerList, writeBasicParameter);
 
         if (writeBasicParameter.getCustomWriteHandlerList() != null
             && !writeBasicParameter.getCustomWriteHandlerList().isEmpty()) {
             handlerList.addAll(writeBasicParameter.getCustomWriteHandlerList());
         }
 
+        this.ownWriteHandlerMap = sortAndClearUpHandler(handlerList);
+
         Map<Class<? extends WriteHandler>, List<WriteHandler>> parentWriteHandlerMap = null;
         if (parentAbstractWriteHolder != null) {
             parentWriteHandlerMap = parentAbstractWriteHolder.getWriteHandlerMap();
         } else {
             handlerList.addAll(DefaultWriteHandlerLoader.loadDefaultHandler(useDefaultStyle));
         }
-
-        this.writeHandlerMap = sortAndClearUpHandler(handlerList, parentWriteHandlerMap);
+        this.writeHandlerMap = sortAndClearUpAllHandler(handlerList, parentWriteHandlerMap);
 
         // Set converterMap
         if (parentAbstractWriteHolder == null) {
@@ -279,10 +285,13 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
         });
     }
 
-    protected void initAnnotationConfig(List<WriteHandler> handlerList) {
+    protected void initAnnotationConfig(List<WriteHandler> handlerList, WriteBasicParameter writeBasicParameter) {
         if (!HeadKindEnum.CLASS.equals(getExcelWriteHeadProperty().getHeadKind())) {
             return;
         }
+        if (writeBasicParameter.getClazz() == null) {
+            return;
+        }
         Map<Integer, Head> headMap = getExcelWriteHeadProperty().getHeadMap();
         boolean hasColumnWidth = false;
         boolean hasStyle = false;
@@ -308,7 +317,6 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
 
         dealRowHigh(handlerList);
         dealOnceAbsoluteMerge(handlerList);
-
     }
 
     private void dealStyle(List<WriteHandler> handlerList) {
@@ -376,9 +384,9 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
         handlerList.add(columnWidthStyleStrategy);
     }
 
-    protected Map<Class<? extends WriteHandler>, List<WriteHandler>> sortAndClearUpHandler(
-        List<WriteHandler> handlerList, Map<Class<? extends WriteHandler>, List<WriteHandler>> parentHandlerMap) {
 
+    protected Map<Class<? extends WriteHandler>, List<WriteHandler>> sortAndClearUpAllHandler(
+        List<WriteHandler> handlerList, Map<Class<? extends WriteHandler>, List<WriteHandler>> parentHandlerMap) {
         // add
         if (parentHandlerMap != null) {
             List<WriteHandler> parentWriteHandler = parentHandlerMap.get(WriteHandler.class);
@@ -386,7 +394,11 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
                 handlerList.addAll(parentWriteHandler);
             }
         }
+        return sortAndClearUpHandler(handlerList);
+    }
 
+    protected Map<Class<? extends WriteHandler>, List<WriteHandler>> sortAndClearUpHandler(
+        List<WriteHandler> handlerList) {
         // sort
         Map<Integer, List<WriteHandler>> orderExcelWriteHandlerMap = new TreeMap<Integer, List<WriteHandler>>();
         for (WriteHandler handler : handlerList) {
@@ -480,6 +492,15 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
         this.writeHandlerMap = writeHandlerMap;
     }
 
+    public Map<Class<? extends WriteHandler>, List<WriteHandler>> getOwnWriteHandlerMap() {
+        return ownWriteHandlerMap;
+    }
+
+    public void setOwnWriteHandlerMap(
+        Map<Class<? extends WriteHandler>, List<WriteHandler>> ownWriteHandlerMap) {
+        this.ownWriteHandlerMap = ownWriteHandlerMap;
+    }
+
     public ExcelWriteHeadProperty getExcelWriteHeadProperty() {
         return excelWriteHeadProperty;
     }
@@ -554,6 +575,11 @@ public abstract class AbstractWriteHolder extends AbstractHolder implements Writ
         return getWriteHandlerMap();
     }
 
+    @Override
+    public Map<Class<? extends WriteHandler>, List<WriteHandler>> ownWriteHandlerMap() {
+        return getOwnWriteHandlerMap();
+    }
+
     @Override
     public boolean needHead() {
         return getNeedHead();

src/main/java/com/alibaba/excel/write/metadata/holder/WriteHolder.java

@@ -28,6 +28,13 @@ public interface WriteHolder extends ConfigurationHolder {
      */
     Map<Class<? extends WriteHandler>, List<WriteHandler>> writeHandlerMap();
 
+    /**
+     * create your own write handler.
+     *
+     * @return
+     */
+    Map<Class<? extends WriteHandler>, List<WriteHandler>> ownWriteHandlerMap();
+
     /**
      * Is to determine if a field needs to be ignored
      *

src/main/java/com/alibaba/excel/write/style/AbstractCellStyleStrategy.java

@@ -11,6 +11,7 @@ import com.alibaba.excel.metadata.CellData;
 import com.alibaba.excel.metadata.Head;
 import com.alibaba.excel.write.handler.CellWriteHandler;
 import com.alibaba.excel.write.handler.SheetWriteHandler;
+import com.alibaba.excel.write.handler.WorkbookWriteHandler;
 import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
 import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
 import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
@@ -20,7 +21,7 @@ import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;
  *
  * @author Jiaju Zhuang
  */
-public abstract class AbstractCellStyleStrategy implements CellWriteHandler, SheetWriteHandler, NotRepeatExecutor {
+public abstract class AbstractCellStyleStrategy implements CellWriteHandler, WorkbookWriteHandler, NotRepeatExecutor {
     boolean hasInitialized = false;
 
     @Override
@@ -60,16 +61,21 @@ public abstract class AbstractCellStyleStrategy implements CellWriteHandler, She
     }
 
     @Override
-    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
+    public void beforeWorkbookCreate() {
 
     }
 
     @Override
-    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
+    public void afterWorkbookCreate(WriteWorkbookHolder writeWorkbookHolder) {
         initCellStyle(writeWorkbookHolder.getWorkbook());
         hasInitialized = true;
     }
 
+    @Override
+    public void afterWorkbookDispose(WriteWorkbookHolder writeWorkbookHolder) {
+
+    }
+
     /**
      * Initialization cell style
      *

src/test/java/com/alibaba/easyexcel/test/temp/simple/DemoData1.java

@@ -0,0 +1,27 @@
+package com.alibaba.easyexcel.test.temp.simple;
+
+import java.util.Date;
+
+import org.apache.poi.ss.usermodel.FillPatternType;
+
+import com.alibaba.excel.annotation.ExcelIgnore;
+import com.alibaba.excel.annotation.ExcelProperty;
+import com.alibaba.excel.annotation.write.style.HeadStyle;
+
+import lombok.Data;
+
+@Data
+public class DemoData1 {
+    @ExcelProperty("字符串标题")
+    @HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 42)
+    private String string;
+    @ExcelProperty("日期标题")
+    private Date date;
+    @ExcelProperty("数字标题")
+    private Double doubleData;
+    /**
+     * 忽略这个字段
+     */
+    @ExcelIgnore
+    private String ignore;
+}

src/test/java/com/alibaba/easyexcel/test/temp/simple/DemoData2.java

@@ -0,0 +1,27 @@
+package com.alibaba.easyexcel.test.temp.simple;
+
+import java.util.Date;
+
+import org.apache.poi.ss.usermodel.FillPatternType;
+
+import com.alibaba.excel.annotation.ExcelIgnore;
+import com.alibaba.excel.annotation.ExcelProperty;
+import com.alibaba.excel.annotation.write.style.HeadStyle;
+
+import lombok.Data;
+
+@Data
+public class DemoData2 {
+    @ExcelProperty("字符串标题")
+    @HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 42)
+    private String string;
+    @ExcelProperty("日期标题")
+    private Date date;
+    @ExcelProperty("数字标题")
+    private Double doubleData;
+    /**
+     * 忽略这个字段
+     */
+    @ExcelIgnore
+    private String ignore;
+}

src/test/java/com/alibaba/easyexcel/test/temp/simple/Wirte.java

@@ -14,6 +14,9 @@ import com.alibaba.easyexcel.test.core.large.LargeData;
 import com.alibaba.easyexcel.test.demo.write.DemoData;
 import com.alibaba.easyexcel.test.util.TestFileUtil;
 import com.alibaba.excel.EasyExcel;
+import com.alibaba.excel.ExcelWriter;
+import com.alibaba.excel.write.metadata.WriteSheet;
+import com.alibaba.excel.write.metadata.WriteTable;
 import com.alibaba.fastjson.JSON;
 
 import net.sf.cglib.beans.BeanMap;
@@ -75,6 +78,23 @@ public class Wirte {
 
     }
 
+    @Test
+    public void tableWrite() {
+        String fileName = TestFileUtil.getPath() + "tableWrite" + System.currentTimeMillis() + ".xlsx";
+        // 这里直接写多个table的案例了，如果只有一个 也可以直一行代码搞定，参照其他案例
+        // 这里 需要指定写用哪个class去写
+        ExcelWriter excelWriter = EasyExcel.write(fileName).build();
+        // 把sheet设置为不需要头 不然会输出sheet的头 这样看起来第一个table 就有2个头了
+        WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
+        // 这里必须指定需要头，table 会继承sheet的配置，sheet配置了不需要，table 默认也是不需要
+        WriteTable writeTable0 = EasyExcel.writerTable(0).head(DemoData1.class).build();
+        // 第一次写入会创建头
+        excelWriter.write(data(), writeSheet, writeTable0);
+        // 第二次写如也会创建头，然后在第一次的后面写入数据
+        /// 千万别忘记finish 会帮忙关闭流
+        excelWriter.finish();
+    }
+
     private List<List<String>> head() {
         List<List<String>> list = new ArrayList<List<String>>();
         List<String> head0 = new ArrayList<String>();

update.md

@@ -5,6 +5,7 @@
 * 新增支持自定义转换器 入参可以为空 实现`NullableObjectConverter` 即可  [Issue #1084](https://github.com/alibaba/easyexcel/issues/1084)
 * 修复xls丢失结束标记的情况下 会漏读最后一行
 * 修复填充的时候 多次`forceNewRow` 空指针的bug [Issue #1201](https://github.com/alibaba/easyexcel/issues/1201)
+* 修复`table`、`sheet`中创建的拦截器不执行`workbook`事件的bug [Issue #1202](https://github.com/alibaba/easyexcel/issues/1202)
 
 # 2.2.0-beta2
 * 修复最长匹配策略不同表格会有影响的bug [Issue #1010](https://github.com/alibaba/easyexcel/issues/1010)