Merge pull request #328 from liaochong/Hotfix/3.11.6

Hotfix/3.11.6

Author: liaochong

example/pom.xml

@@ -43,7 +43,7 @@
         <dependency>
             <groupId>com.github.liaochong</groupId>
             <artifactId>myexcel</artifactId>
-            <version>3.11.4</version>
+            <version>3.11.6</version>
         </dependency>
         <dependency>
             <groupId>org.apache.poi</groupId>

pom.xml

@@ -11,7 +11,7 @@
 
     <groupId>com.github.liaochong</groupId>
     <artifactId>myexcel</artifactId>
-    <version>3.11.5</version>
+    <version>3.11.6</version>
     <packaging>jar</packaging>
 
     <name>myexcel</name>
@@ -22,10 +22,9 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <java.version>1.8</java.version>
-        <poi.version>4.1.1</poi.version>
+        <poi.version>4.1.2</poi.version>
         <jsoup.version>1.14.2</jsoup.version>
         <lombok.version>1.18.10</lombok.version>
-        <slf4j-api.version>1.7.26</slf4j-api.version>
         <beetl.version>2.9.9</beetl.version>
         <velocity.version>1.7</velocity.version>
         <freemarker.version>2.3.23</freemarker.version>
@@ -51,11 +50,6 @@
             <artifactId>jsoup</artifactId>
             <version>${jsoup.version}</version>
         </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>${slf4j-api.version}</version>
-        </dependency>
         <dependency>
             <groupId>com.ibeetl</groupId>
             <artifactId>beetl</artifactId>

src/main/java/com/github/liaochong/myexcel/core/AbstractReadHandler.java

@@ -82,6 +82,11 @@ abstract class AbstractReadHandler<T> {
      */
     private int titleRowNum = -1;
 
+    /**
+     * is blank row
+     */
+    protected boolean isBlankRow;
+
     public AbstractReadHandler(boolean readCsv,
                                List<T> result,
                                SaxExcelReader.ReadConfig<T> readConfig) {
@@ -188,6 +193,7 @@ protected void newRow(int rowNum) {
         currentRow.setRowNum(rowNum);
         obj = newInstance.get();
         prevColNum = -1;
+        isBlankRow = true;
     }
 
     protected void setRecordAsNull() {
@@ -198,6 +204,7 @@ protected void handleField(Integer colNum, String content) {
         if (obj == null || colNum < 0) {
             return;
         }
+        isBlankRow = false;
         content = readConfig.getTrim().apply(content);
         if (readConfig.getRowFilter().test(currentRow)) {
             fieldHandler.accept(colNum, content);
@@ -216,6 +223,15 @@ protected void handleField(Integer colNum, String content) {
     }
 
     protected void handleResult() {
+        if (isBlankRow) {
+            if (readConfig.isStopReadingOnBlankRow()) {
+                throw new StopReadException();
+            }
+            // 忽略空白行
+            if (readConfig.isIgnoreBlankRow()) {
+                return;
+            }
+        }
         this.initFieldMap();
         if (!readConfig.getRowFilter().test(currentRow)) {
             return;

src/main/java/com/github/liaochong/myexcel/core/SaxExcelReader.java

@@ -124,6 +124,16 @@ public SaxExcelReader<T> readAllSheet() {
         return this;
     }
 
+    public SaxExcelReader<T> ignoreBlankRow() {
+        this.readConfig.ignoreBlankRow = true;
+        return this;
+    }
+
+    public SaxExcelReader<T> stopReadingOnBlankRow() {
+        this.readConfig.stopReadingOnBlankRow = true;
+        return this;
+    }
+
     public SaxExcelReader<T> startSheet(BiConsumer<String, Integer> startSheetConsumer) {
         this.readConfig.startSheetConsumer = startSheetConsumer;
         return this;
@@ -350,6 +360,14 @@ public static final class ReadConfig<T> {
         };
 
         private boolean readAllSheet;
+        /**
+         * 是否忽略空白行，默认为否
+         */
+        private boolean ignoreBlankRow = false;
+        /**
+         * 是否在遇到空白行时停止读取
+         */
+        private boolean stopReadingOnBlankRow = false;
 
         private BiConsumer<String, Integer> startSheetConsumer = (sheetName, sheetIndex) -> {
             log.info("Start read excel, sheet:{},index:{}", sheetName, sheetIndex);
@@ -470,5 +488,21 @@ public BiConsumer<String, Integer> getStartSheetConsumer() {
         public void setStartSheetConsumer(BiConsumer<String, Integer> startSheetConsumer) {
             this.startSheetConsumer = startSheetConsumer;
         }
+
+        public boolean isIgnoreBlankRow() {
+            return ignoreBlankRow;
+        }
+
+        public void setIgnoreBlankRow(boolean ignoreBlankRow) {
+            this.ignoreBlankRow = ignoreBlankRow;
+        }
+
+        public boolean isStopReadingOnBlankRow() {
+            return stopReadingOnBlankRow;
+        }
+
+        public void setStopReadingOnBlankRow(boolean stopReadingOnBlankRow) {
+            this.stopReadingOnBlankRow = stopReadingOnBlankRow;
+        }
     }
 }

src/main/java/com/github/liaochong/myexcel/core/XSSFSaxReadHandler.java

@@ -30,14 +30,6 @@ class XSSFSaxReadHandler<T> extends AbstractReadHandler<T> implements XSSFSheetX
 
     private static final Logger log = org.slf4j.LoggerFactory.getLogger(XSSFSaxReadHandler.class);
     private int count;
-    /**
-     * blank row count
-     */
-    private int blankCount;
-    /**
-     * is blank row
-     */
-    private boolean isBlank;
 
     public XSSFSaxReadHandler(
             List<T> result,
@@ -48,23 +40,17 @@ public XSSFSaxReadHandler(
     @Override
     public void startRow(int rowNum) {
         newRow(rowNum);
-        isBlank = true;
     }
 
     @Override
     public void endRow(int rowNum) {
-        if (isBlank) {
-            blankCount++;
-            return;
-        }
         handleResult();
         count++;
     }
 
     @Override
     public void cell(String cellReference, String formattedValue,
                      XSSFComment comment) {
-        isBlank = false;
         if (cellReference == null) {
             return;
         }
@@ -74,6 +60,6 @@ public void cell(String cellReference, String formattedValue,
 
     @Override
     public void endSheet() {
-        log.info("Import completed, total number of rows {},{} blank rows filtered.", count, blankCount);
+        log.info("Import completed, total number of rows {}.", count);
     }
 }

src/main/java/com/github/liaochong/myexcel/core/XSSFSheetXMLHandler.java

@@ -97,6 +97,7 @@ enum xssfDataType {
     private String formatString;
     private final DataFormatter formatter;
     private int rowNum;
+    private int preRowNum = -1;
     private int nextRowNum;      // some sheets do not have rowNums, Excel can read them so we should try to handle them correctly as well
     private String cellRef;
     private boolean formulasNotResults;
@@ -224,7 +225,14 @@ public void startElement(String uri, String localName, String qName,
             } else {
                 rowNum = nextRowNum;
             }
+            if (rowNum - 1 != preRowNum) {
+                for (int blankRowNum = preRowNum + 1; blankRowNum < rowNum; blankRowNum++) {
+                    output.startRow(blankRowNum);
+                    output.endRow(blankRowNum);
+                }
+            }
             output.startRow(rowNum);
+            this.preRowNum = rowNum;
         }
         // c => cell
         else if ("c".equals(localName)) {