refactor: FastExcelFactory (#454)

* reduce duplicate code

* add test

* add test

---------

Co-authored-by: ian zhang <[email protected]>

Author: weihubeats

fastexcel/src/main/java/cn/idev/excel/FastExcelFactory.java

@@ -12,7 +12,6 @@
 
 /**
  * Reader and writer factory class
- *
  */
 public class FastExcelFactory {
 
@@ -43,12 +42,7 @@ public static ExcelWriterBuilder write(File file) {
      * @return Excel writer builder
      */
     public static ExcelWriterBuilder write(File file, Class head) {
-        ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
-        excelWriterBuilder.file(file);
-        if (head != null) {
-            excelWriterBuilder.head(head);
-        }
-        return excelWriterBuilder;
+        return new ExcelWriterBuilder().file(file).headIfNotNull(head);
     }
 
     /**
@@ -69,12 +63,7 @@ public static ExcelWriterBuilder write(String pathName) {
      * @return Excel writer builder
      */
     public static ExcelWriterBuilder write(String pathName, Class head) {
-        ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
-        excelWriterBuilder.file(pathName);
-        if (head != null) {
-            excelWriterBuilder.head(head);
-        }
-        return excelWriterBuilder;
+        return new ExcelWriterBuilder().file(pathName).headIfNotNull(head);
     }
 
     /**
@@ -95,12 +84,7 @@ public static ExcelWriterBuilder write(OutputStream outputStream) {
      * @return Excel writer builder
      */
     public static ExcelWriterBuilder write(OutputStream outputStream, Class head) {
-        ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
-        excelWriterBuilder.file(outputStream);
-        if (head != null) {
-            excelWriterBuilder.head(head);
-        }
-        return excelWriterBuilder;
+        return new ExcelWriterBuilder().file(outputStream).headIfNotNull(head);
     }
 
     /**
@@ -140,14 +124,7 @@ public static ExcelWriterSheetBuilder writerSheet(String sheetName) {
      * @return Excel sheet writer builder.
      */
     public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName) {
-        ExcelWriterSheetBuilder excelWriterSheetBuilder = new ExcelWriterSheetBuilder();
-        if (sheetNo != null) {
-            excelWriterSheetBuilder.sheetNo(sheetNo);
-        }
-        if (sheetName != null) {
-            excelWriterSheetBuilder.sheetName(sheetName);
-        }
-        return excelWriterSheetBuilder;
+        return new ExcelWriterSheetBuilder().sheetNoIfNotNull(sheetNo).sheetNameIfNotNull(sheetName);
     }
 
     /**
@@ -166,11 +143,7 @@ public static ExcelWriterTableBuilder writerTable() {
      * @return Excel table writer builder.
      */
     public static ExcelWriterTableBuilder writerTable(Integer tableNo) {
-        ExcelWriterTableBuilder excelWriterTableBuilder = new ExcelWriterTableBuilder();
-        if (tableNo != null) {
-            excelWriterTableBuilder.tableNo(tableNo);
-        }
-        return excelWriterTableBuilder;
+        return new ExcelWriterTableBuilder().tableNoIfNotNull(tableNo);
     }
 
     /**
@@ -212,15 +185,7 @@ public static ExcelReaderBuilder read(File file, ReadListener readListener) {
      * @return Excel reader builder.
      */
     public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) {
-        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
-        excelReaderBuilder.file(file);
-        if (head != null) {
-            excelReaderBuilder.head(head);
-        }
-        if (readListener != null) {
-            excelReaderBuilder.registerReadListener(readListener);
-        }
-        return excelReaderBuilder;
+        return new ExcelReaderBuilder().file(file).headIfNotNull(head).registerReadListenerIfNotNull(readListener);
     }
 
     /**
@@ -253,15 +218,7 @@ public static ExcelReaderBuilder read(String pathName, ReadListener readListener
      * @return Excel reader builder.
      */
     public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) {
-        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
-        excelReaderBuilder.file(pathName);
-        if (head != null) {
-            excelReaderBuilder.head(head);
-        }
-        if (readListener != null) {
-            excelReaderBuilder.registerReadListener(readListener);
-        }
-        return excelReaderBuilder;
+        return new ExcelReaderBuilder().file(pathName).headIfNotNull(head).registerReadListenerIfNotNull(readListener);
     }
 
     /**
@@ -294,15 +251,10 @@ public static ExcelReaderBuilder read(InputStream inputStream, ReadListener read
      * @return Excel reader builder.
      */
     public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) {
-        ExcelReaderBuilder excelReaderBuilder = new ExcelReaderBuilder();
-        excelReaderBuilder.file(inputStream);
-        if (head != null) {
-            excelReaderBuilder.head(head);
-        }
-        if (readListener != null) {
-            excelReaderBuilder.registerReadListener(readListener);
-        }
-        return excelReaderBuilder;
+        return new ExcelReaderBuilder()
+                .file(inputStream)
+                .headIfNotNull(head)
+                .registerReadListenerIfNotNull(readListener);
     }
 
     /**
@@ -342,34 +294,21 @@ public static ExcelReaderSheetBuilder readSheet(String sheetName) {
      * @return Excel sheet reader builder.
      */
     public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName) {
-        ExcelReaderSheetBuilder excelReaderSheetBuilder = new ExcelReaderSheetBuilder();
-        if (sheetNo != null) {
-            excelReaderSheetBuilder.sheetNo(sheetNo);
-        }
-        if (sheetName != null) {
-            excelReaderSheetBuilder.sheetName(sheetName);
-        }
-        return excelReaderSheetBuilder;
+        return readSheet(sheetNo, sheetName, null);
     }
 
     /**
      * Build excel the 'readSheet'
-     * @param sheetNo Index of sheet,0 base.
+     *
+     * @param sheetNo   Index of sheet,0 base.
      * @param sheetName The name of sheet.
-     * @param numRows The number of rows to read, the default is all, start with 0.
+     * @param numRows   The number of rows to read, the default is all, start with 0.
      * @return
      */
     public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName, Integer numRows) {
-        ExcelReaderSheetBuilder excelReaderSheetBuilder = new ExcelReaderSheetBuilder();
-        if (sheetNo != null) {
-            excelReaderSheetBuilder.sheetNo(sheetNo);
-        }
-        if (sheetName != null) {
-            excelReaderSheetBuilder.sheetName(sheetName);
-        }
-        if (numRows != null) {
-            excelReaderSheetBuilder.numRows(numRows);
-        }
-        return excelReaderSheetBuilder;
+        return new ExcelReaderSheetBuilder()
+                .sheetNoIfNotNull(sheetNo)
+                .sheetNameIfNotNull(sheetName)
+                .numRowsIfNotNull(numRows);
     }
 }

fastexcel/src/main/java/cn/idev/excel/metadata/AbstractParameterBuilder.java

@@ -5,6 +5,7 @@
 import cn.idev.excel.util.ListUtils;
 import java.util.List;
 import java.util.Locale;
+import java.util.Objects;
 
 /**
  * ExcelBuilder
@@ -34,6 +35,13 @@ public T head(Class<?> clazz) {
         return self();
     }
 
+    public T headIfNotNull(Class<?> clazz) {
+        if (Objects.nonNull(clazz)) {
+            parameter().setClazz(clazz);
+        }
+        return self();
+    }
+
     /**
      * Custom type conversions override the default.
      *

fastexcel/src/main/java/cn/idev/excel/read/builder/AbstractExcelReaderParameterBuilder.java

@@ -4,6 +4,7 @@
 import cn.idev.excel.read.listener.ReadListener;
 import cn.idev.excel.read.metadata.ReadBasicParameter;
 import cn.idev.excel.util.ListUtils;
+import java.util.Objects;
 
 /**
  * Build ExcelBuilder
@@ -57,4 +58,14 @@ public T registerReadListener(ReadListener<?> readListener) {
         parameter().getCustomReadListenerList().add(readListener);
         return self();
     }
+
+    public T registerReadListenerIfNotNull(ReadListener<?> readListener) {
+        if (Objects.nonNull(readListener)) {
+            if (parameter().getCustomReadListenerList() == null) {
+                parameter().setCustomReadListenerList(ListUtils.newArrayList());
+            }
+            parameter().getCustomReadListenerList().add(readListener);
+        }
+        return self();
+    }
 }

fastexcel/src/main/java/cn/idev/excel/read/builder/ExcelReaderSheetBuilder.java

@@ -6,6 +6,7 @@
 import cn.idev.excel.exception.ExcelGenerateException;
 import cn.idev.excel.read.metadata.ReadSheet;
 import java.util.List;
+import java.util.Objects;
 
 /**
  * Build sheet
@@ -39,6 +40,13 @@ public ExcelReaderSheetBuilder sheetNo(Integer sheetNo) {
         return this;
     }
 
+    public ExcelReaderSheetBuilder sheetNoIfNotNull(Integer sheetNo) {
+        if (Objects.nonNull(sheetNo)) {
+            readSheet.setSheetNo(sheetNo);
+        }
+        return this;
+    }
+
     /**
      * sheet name
      *
@@ -50,6 +58,13 @@ public ExcelReaderSheetBuilder sheetName(String sheetName) {
         return this;
     }
 
+    public ExcelReaderSheetBuilder sheetNameIfNotNull(String sheetName) {
+        if (Objects.nonNull(sheetName)) {
+            readSheet.setSheetName(sheetName);
+        }
+        return this;
+    }
+
     /**
      * numRows
      *
@@ -61,6 +76,13 @@ public ExcelReaderSheetBuilder numRows(Integer numRows) {
         return this;
     }
 
+    public ExcelReaderSheetBuilder numRowsIfNotNull(Integer numRows) {
+        if (Objects.nonNull(numRows)) {
+            readSheet.setNumRows(numRows);
+        }
+        return this;
+    }
+
     public ReadSheet build() {
         return readSheet;
     }

fastexcel/src/main/java/cn/idev/excel/write/builder/ExcelWriterSheetBuilder.java

@@ -5,6 +5,7 @@
 import cn.idev.excel.write.metadata.WriteSheet;
 import cn.idev.excel.write.metadata.fill.FillConfig;
 import java.util.Collection;
+import java.util.Objects;
 import java.util.function.Supplier;
 
 /**
@@ -39,6 +40,13 @@ public ExcelWriterSheetBuilder sheetNo(Integer sheetNo) {
         return this;
     }
 
+    public ExcelWriterSheetBuilder sheetNoIfNotNull(Integer sheetNo) {
+        if (Objects.nonNull(sheetNo)) {
+            writeSheet.setSheetNo(sheetNo);
+        }
+        return this;
+    }
+
     /**
      * sheet name
      *
@@ -50,6 +58,13 @@ public ExcelWriterSheetBuilder sheetName(String sheetName) {
         return this;
     }
 
+    public ExcelWriterSheetBuilder sheetNameIfNotNull(String sheetName) {
+        if (Objects.nonNull(sheetName)) {
+            writeSheet.setSheetName(sheetName);
+        }
+        return this;
+    }
+
     public WriteSheet build() {
         return writeSheet;
     }

fastexcel/src/main/java/cn/idev/excel/write/builder/ExcelWriterTableBuilder.java

@@ -5,6 +5,7 @@
 import cn.idev.excel.write.metadata.WriteSheet;
 import cn.idev.excel.write.metadata.WriteTable;
 import java.util.Collection;
+import java.util.Objects;
 import java.util.function.Supplier;
 
 /**
@@ -43,6 +44,13 @@ public ExcelWriterTableBuilder tableNo(Integer tableNo) {
         return this;
     }
 
+    public ExcelWriterTableBuilder tableNoIfNotNull(Integer tableNo) {
+        if (Objects.nonNull(tableNo)) {
+            writeTable.setTableNo(tableNo);
+        }
+        return this;
+    }
+
     public WriteTable build() {
         return writeTable;
     }