🐛 fixed export columns are not uniform

Author: hellokaton

src/main/java/io/github/biezhi/excel/plus/utils/ExcelUtils.java

@@ -35,31 +35,32 @@ public static String getSheetName(Object item) {
         return excelSheet.value();
     }
 
-    public static List<String> getWriteFieldNames(Class<?> type) {
+    public static List<Pair<Integer, String>> getWriteFieldNames(Class<?> type) {
         List<Field>                 fields = getAndSaveFields(type);
-        List<Pair<String, Integer>> pairs  = new ArrayList<>(fields.size());
+        List<Pair<Integer, String>> pairs  = new ArrayList<>(fields.size());
 
         for (Field field : fields) {
             ExcelField excelField = field.getAnnotation(ExcelField.class);
             if (null != excelField) {
-                Pair<String, Integer> pair = new Pair<>();
-                pair.setK(excelField.columnName());
+                Pair<Integer, String> pair = new Pair<>();
+                pair.setV(excelField.columnName());
 
                 WriteField writeField = field.getAnnotation(WriteField.class);
                 if (null != writeField && writeField.order() != Constant.DEFAULT_ORDER) {
-                    pair.setV(writeField.order());
+                    pair.setK(writeField.order());
                 } else {
                     if (excelField.order() != Constant.DEFAULT_ORDER) {
-                        pair.setV(excelField.order());
+                        pair.setK(excelField.order());
                     } else {
                         System.err.println(String.format("[%s.%s] order config error, %s", type.getName(), field.getName(), TIP_MSG));
                     }
                 }
                 pairs.add(pair);
             }
         }
-        pairs.sort(Comparator.comparingInt(Pair::getV));
-        return pairs.stream().map(Pair::getK).collect(Collectors.toList());
+//        pairs.sort(Comparator.comparingInt(Pair::getV));
+//        return pairs.stream().map(Pair::getK).collect(Collectors.toList());
+        return pairs;
     }
 
     public static String getColumnValue(Object item, int order) {

src/main/java/io/github/biezhi/excel/plus/writer/ExcelWriter.java

@@ -3,6 +3,7 @@
 import io.github.biezhi.excel.plus.enums.ExcelType;
 import io.github.biezhi.excel.plus.exception.ExcelException;
 import io.github.biezhi.excel.plus.utils.ExcelUtils;
+import io.github.biezhi.excel.plus.utils.Pair;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
 import org.apache.poi.hssf.util.HSSFColor;
 import org.apache.poi.ss.usermodel.*;
@@ -13,6 +14,7 @@
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * Exporter interface
@@ -25,10 +27,10 @@ public interface ExcelWriter {
     /**
      * Default Export method
      *
-     * @param exporter
-     * @param outputStream
-     * @param <T>
-     * @throws ExcelException
+     * @param exporter     Exporter Object
+     * @param outputStream OutputStream
+     * @param <T>          Java Type
+     * @throws ExcelException thrown when exporting Excel to an exception
      */
     default <T> void export(Exporter<T> exporter, OutputStream outputStream) throws ExcelException {
         Collection<T> data = exporter.getData();
@@ -41,14 +43,14 @@ default <T> void export(Exporter<T> exporter, OutputStream outputStream) throws
             Workbook  workbook;
             CellStyle headerStyle;
             CellStyle columnStyle = null;
-            CellStyle rowStyle    = null;
 
             T data0 = data.iterator().next();
             // Set Excel header
-            Iterator<T>  iterator   = data.iterator();
-            List<String> fieldNames = ExcelUtils.getWriteFieldNames(data0.getClass());
-            int          cols       = fieldNames.size();
-            int          startRow   = exporter.startRow();
+            Iterator<T> iterator = data.iterator();
+
+            List<Pair<Integer, String>> writeFieldNames = ExcelUtils.getWriteFieldNames(data0.getClass());
+
+            int startRow = exporter.startRow();
 
             if (null != exporter.getTemplatePath()) {
                 InputStream in = ExcelWriter.class.getClassLoader().getResourceAsStream(exporter.getTemplatePath());
@@ -63,17 +65,18 @@ default <T> void export(Exporter<T> exporter, OutputStream outputStream) throws
                 } else {
                     headerStyle = defaultHeaderStyle(workbook);
                 }
-
                 if (null != exporter.getColumnStyle()) {
                     columnStyle = exporter.getColumnStyle().apply(workbook);
                 } else {
                     columnStyle = defaultColumnStyle(workbook);
                 }
 
-                this.writeRowHead(headerStyle, sheet, fieldNames, cols);
+                this.writeRowHead(headerStyle, sheet, writeFieldNames);
             }
 
-            this.writeRows(sheet, columnStyle, rowStyle, iterator, cols, startRow);
+            List<Integer> columnIndexes = writeFieldNames.stream().map(Pair::getK).collect(Collectors.toList());
+
+            this.writeRows(sheet, columnStyle, null, iterator, startRow, columnIndexes);
 
             workbook.write(outputStream);
             outputStream.flush();
@@ -83,26 +86,46 @@ default <T> void export(Exporter<T> exporter, OutputStream outputStream) throws
         }
     }
 
-    default void writeRowHead(CellStyle headerStyle, Sheet sheet, List<String> fieldNames, int cols) {
+    /**
+     * Write the header row to Sheet.
+     *
+     * @param headerStyle header row cell style
+     * @param sheet       work sheet
+     * @param columnNames column names
+     */
+    default void writeRowHead(CellStyle headerStyle, Sheet sheet, List<Pair<Integer, String>> columnNames) {
         Row rowHead = sheet.createRow(0);
-        for (int col = 0; col < cols; col++) {
-            Cell cell = rowHead.createCell(col);
+        columnNames.forEach(pair -> {
+            Integer colIndex   = pair.getK();
+            String  columnName = pair.getV();
+            Cell    cell       = rowHead.createCell(colIndex);
             if (null != headerStyle) {
                 cell.setCellStyle(headerStyle);
             }
-            cell.setCellValue(fieldNames.get(col));
-            sheet.autoSizeColumn(col);
-        }
+            cell.setCellValue(columnName);
+        });
     }
 
-    default <T> void writeRows(Sheet sheet, CellStyle columnStyle, CellStyle rowStyle, Iterator<T> iterator, int cols, int startRow) {
+    /**
+     * Write line data
+     *
+     * @param sheet       work sheet
+     * @param columnStyle each column style in the row.
+     * @param rowStyle    row style
+     * @param iterator    row data iterator
+     * @param startRow    from the beginning of the line, the default is 1
+     * @param <T>         Java Type
+     */
+    default <T> void writeRows(Sheet sheet, CellStyle columnStyle, CellStyle rowStyle, Iterator<T> iterator, int startRow, List<Integer> columnIndexes) {
         for (int rowNum = startRow; iterator.hasNext(); rowNum++) {
             T   item = iterator.next();
             Row row  = sheet.createRow(rowNum);
             if (null != rowStyle) {
                 row.setRowStyle(rowStyle);
             }
-            for (int col = 0; col < cols; col++) {
+            Iterator<Integer> colIt = columnIndexes.iterator();
+            while (colIt.hasNext()) {
+                int    col   = colIt.next();
                 Cell   cell  = row.createCell(col);
                 String value = ExcelUtils.getColumnValue(item, col);
                 if (null != columnStyle) {
@@ -117,8 +140,8 @@ default <T> void writeRows(Sheet sheet, CellStyle columnStyle, CellStyle rowStyl
     /**
      * The default Excel header style.
      *
-     * @param workbook
-     * @return
+     * @param workbook Excel workbook
+     * @return header row cell style
      */
     default CellStyle defaultHeaderStyle(Workbook workbook) {
         CellStyle headerStyle = workbook.createCellStyle();
@@ -143,8 +166,8 @@ default CellStyle defaultHeaderStyle(Workbook workbook) {
     /**
      * The default Excel column style.
      *
-     * @param workbook
-     * @return
+     * @param workbook Excel workbook
+     * @return row column cell style
      */
     default CellStyle defaultColumnStyle(Workbook workbook) {
         CellStyle cellStyle = workbook.createCellStyle();
@@ -164,9 +187,9 @@ default CellStyle defaultColumnStyle(Workbook workbook) {
     /**
      * Export excel
      *
-     * @param exporter
-     * @param <T>
-     * @throws ExcelException
+     * @param exporter Exporter Object
+     * @param <T>      Java Type
+     * @throws ExcelException thrown when exporting Excel to an exception
      */
     <T> void export(Exporter<T> exporter) throws ExcelException;
 

src/test/java/io/github/biezhi/excel/plus/Examples.java

@@ -69,10 +69,10 @@ public void testExport() throws ExcelException {
 
     private List<CardSecret> buildCardSecrets() {
         List<CardSecret> cardSecrets = new ArrayList<>();
-        cardSecrets.add(new CardSecret(1, "vlfdzepjmlz2y43z7er4", new BigDecimal("20")));
-        cardSecrets.add(new CardSecret(2, "rasefq2rzotsmx526z6g", new BigDecimal("10")));
-        cardSecrets.add(new CardSecret(2, "2ru44qut6neykb2380wt", new BigDecimal("50")));
-        cardSecrets.add(new CardSecret(1, "srcb4c9fdqzuykd6q4zl", new BigDecimal("15")));
+        cardSecrets.add(new CardSecret(1, "vlfdzepjmlz2y43z7er4", new BigDecimal("20"), true));
+        cardSecrets.add(new CardSecret(2, "rasefq2rzotsmx526z6g", new BigDecimal("10"), true));
+        cardSecrets.add(new CardSecret(2, "2ru44qut6neykb2380wt", new BigDecimal("50"), false));
+        cardSecrets.add(new CardSecret(1, "srcb4c9fdqzuykd6q4zl", new BigDecimal("15"), true));
         return cardSecrets;
     }
 

src/test/java/io/github/biezhi/excel/plus/converter/UsedTypeConverter.java

@@ -0,0 +1,14 @@
+package io.github.biezhi.excel.plus.converter;
+
+public class UsedTypeConverter implements Converter<Boolean> {
+
+    @Override
+    public String write(Boolean value) {
+        return value ? "已使用" : "未使用";
+    }
+
+    @Override
+    public Boolean read(String value) {
+        return "已使用".equals(value);
+    }
+}

src/test/java/io/github/biezhi/excel/plus/model/CardSecret.java

@@ -2,6 +2,7 @@
 
 import io.github.biezhi.excel.plus.annotation.ExcelField;
 import io.github.biezhi.excel.plus.converter.CardTypeConverter;
+import io.github.biezhi.excel.plus.converter.UsedTypeConverter;
 
 import java.io.Serializable;
 import java.math.BigDecimal;
@@ -27,14 +28,18 @@ public class CardSecret implements Serializable {
     @ExcelField(order = 3, columnName = "过期时间", datePattern = "yyyy年MM月dd日")
     private Date expiredDate;
 
+    @ExcelField(order = 5, columnName = "使用情况", convertType = UsedTypeConverter.class)
+    private Boolean used;
+
     public CardSecret() {
     }
 
-    public CardSecret(Integer cardType, String secret, BigDecimal amount) {
+    public CardSecret(Integer cardType, String secret, BigDecimal amount, boolean used) {
         this.cardType = cardType;
         this.secret = secret;
         this.amount = amount;
         this.expiredDate = new Date();
+        this.used = used;
     }
 
     public Integer getCardType() {
@@ -69,13 +74,22 @@ public void setExpiredDate(Date expiredDate) {
         this.expiredDate = expiredDate;
     }
 
+    public Boolean getUsed() {
+        return used;
+    }
+
+    public void setUsed(Boolean used) {
+        this.used = used;
+    }
+
     @Override
     public String toString() {
         return "CardSecret{" +
                 "cardType='" + new CardTypeConverter().write(this.cardType) + '\'' +
                 ", secret='" + secret + '\'' +
                 ", amount=" + amount +
                 ", expiredDate=" + expiredDate +
+                ", used='" + new UsedTypeConverter().write(this.used) + '\'' +
                 '}';
     }
 }