feat: Introduced Workbook constant for maximum sheet name length validation (#658)

* feat: Introduced Workbook constant for maximum sheet name length validation

* test: Added a longer sheet name to the existing sheet name list

* refactor: reorganize import statements in ExcelWriterSheetBuilder

* test: add sheet name length validation test case

Author: delei

fesod/src/main/java/org/apache/fesod/excel/write/builder/ExcelWriterSheetBuilder.java

@@ -22,16 +22,19 @@
 import java.util.Collection;
 import java.util.Objects;
 import java.util.function.Supplier;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.fesod.excel.ExcelWriter;
 import org.apache.fesod.excel.exception.ExcelGenerateException;
 import org.apache.fesod.excel.write.metadata.WriteSheet;
 import org.apache.fesod.excel.write.metadata.fill.FillConfig;
+import org.apache.poi.ss.usermodel.Workbook;
 
 /**
  * Build sheet
  *
  *
  */
+@Slf4j
 public class ExcelWriterSheetBuilder extends AbstractExcelWriterParameterBuilder<ExcelWriterSheetBuilder, WriteSheet> {
     private ExcelWriter excelWriter;
     /**
@@ -73,13 +76,13 @@ public ExcelWriterSheetBuilder sheetNoIfNotNull(Integer sheetNo) {
      * @return
      */
     public ExcelWriterSheetBuilder sheetName(String sheetName) {
-        writeSheet.setSheetName(sheetName);
+        writeSheet.setSheetName(sensitiveSheetName(sheetName));
         return this;
     }
 
     public ExcelWriterSheetBuilder sheetNameIfNotNull(String sheetName) {
         if (Objects.nonNull(sheetName)) {
-            writeSheet.setSheetName(sheetName);
+            writeSheet.setSheetName(sensitiveSheetName(sheetName));
         }
         return this;
     }
@@ -136,4 +139,31 @@ public ExcelWriterTableBuilder table(Integer tableNo) {
     protected WriteSheet parameter() {
         return writeSheet;
     }
+
+    /**
+     * Processes worksheet names to ensure they comply with MS Excel's length limitations.
+     * <p>
+     * If the provided sheet name exceeds the maximum allowed length defined by
+     * {@link Workbook#MAX_SENSITIVE_SHEET_NAME_LEN}, it will be truncated to fit within
+     * the limit. A warning message is logged when truncation occurs, as the original
+     * sheet name will not be available in scenarios such as formula references.
+     * </p>
+     *
+     * @param sheetName the original worksheet name to process
+     * @return the processed sheet name that complies with Excel's length restrictions
+     */
+    private String sensitiveSheetName(String sheetName) {
+        if (sheetName.length() > Workbook.MAX_SENSITIVE_SHEET_NAME_LEN) {
+            String trimmedSheetName = sheetName.substring(0, Workbook.MAX_SENSITIVE_SHEET_NAME_LEN);
+
+            // we still need to warn about the trimming as the original sheet name won't be available
+            // e.g. when referenced by formulas
+            log.warn(
+                    "Sheet '{}' will be added with a trimmed name '{}' for MS Excel compliance.",
+                    sheetName,
+                    trimmedSheetName);
+            return trimmedSheetName;
+        }
+        return sheetName;
+    }
 }

fesod/src/test/java/org/apache/fesod/excel/writesheet/WriteSheetTest.java

@@ -31,6 +31,7 @@
 import org.apache.fesod.excel.support.ExcelTypeEnum;
 import org.apache.fesod.excel.util.TestFileUtil;
 import org.apache.fesod.excel.write.metadata.WriteSheet;
+import org.apache.poi.ss.usermodel.Workbook;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -106,8 +107,8 @@ private Map<Integer, Integer> initSheetDataSizeList(List<Integer> sheetNoList) {
     }
 
     private void testSheetOrderWithSheetName(ExcelTypeEnum excelTypeEnum) {
-        List<String> sheetNameList = Arrays.asList("Sheet1", "Sheet2", "Sheet3");
-        List<Integer> sheetNoList = Arrays.asList(0, 1, 2);
+        List<String> sheetNameList = Arrays.asList("Sheet1", "Sheet2", "Sheet3", "Sheet111112222233333444445555566666");
+        List<Integer> sheetNoList = Arrays.asList(0, 1, 2, 3);
 
         Map<Integer, Integer> dataMap = initSheetDataSizeList(sheetNoList);
         File testFile = TestFileUtil.createNewFile("writesheet/write-sheet-order-name" + excelTypeEnum.getValue());
@@ -136,6 +137,16 @@ private void testSheetOrderWithSheetName(ExcelTypeEnum excelTypeEnum) {
             excelWriter.write(dataList(dataMap.get(sheetNo)), writeSheet);
             Assertions.assertEquals(
                     sheetNo, excelWriter.writeContext().writeSheetHolder().getSheetNo());
+
+            sheetNo = 3;
+            writeSheet =
+                    FastExcel.writerSheet(sheetNo, sheetNameList.get(sheetNo)).build();
+            excelWriter.write(dataList(dataMap.get(sheetNo)), writeSheet);
+            Assertions.assertEquals(
+                    sheetNameList.get(sheetNo).substring(0, Workbook.MAX_SENSITIVE_SHEET_NAME_LEN),
+                    excelWriter.writeContext().writeSheetHolder().getSheetName());
+            Assertions.assertEquals(
+                    sheetNo, excelWriter.writeContext().writeSheetHolder().getSheetNo());
         }
 
         for (int i = 0; i < sheetNoList.size(); i++) {