java使用EasyExcel實現Sheet的復制與填充

更新時間：2023年10月08日 08:22:37 作者：酸奶小肥陽

EasyExcel是一個非常有用的工具,它提供了強大的模板填充功能,可以輕松解決各種業(yè)務需求,本文主要為大家介紹了如何使用EasyExcel實現模板Sheet復制與填充,需要的可以參考下

當在后端開發(fā)中處理Excel業(yè)務時，EasyExcel是一個非常有用的工具，它提供了強大的模板填充功能，可以輕松解決各種業(yè)務需求。在本文中，我將首先簡要介紹EasyExcel模板填充功能的基本用法，然后提供一種根據業(yè)務需要執(zhí)行多份復制與填充的實用方案。

EasyExcel模板填充功能的基本用法

使用EasyExcel的[模板填充功能]與[簡單寫]相比，可以diy工作表(sheet)的樣式，讓生成的excel更加美觀且不必花費更多的開發(fā)時間。

使用簡單寫完成一個Excel報表

1.創(chuàng)建Java類，方便構建數據映射到Excel中；在類中使用注解配置單元格格式和標題

@ExcelProperty: 設置excel中標題名稱

@ColumnWidth: 設置單元格的寬度

@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
public class CatDTO {
    @ExcelProperty(value = "姓名")
    private String name;
    @ExcelProperty(value = "品種")
    @ColumnWidth(15)
    private String breed;
    @ExcelProperty(value = "年齡")
    private Double age;
    @ExcelProperty(value = "描述")
    @ColumnWidth(30)
    private String desc;
}

2.使用EasyExcel提供的Write API，將數據寫入Excel中。

@SpringBootTest
class DemoApplicationTests {
    @Test
    void writeTest1() {
        String fileName = "write-" + System.currentTimeMillis() + ".xlsx";
        // 構建數據
        List<CatDTO> catWriteData = List.of(
                CatDTO.builder().name("肥貓").breed("銀漸層").age(1.2).desc("每天吃吃睡睡睡睡睡").build(),
                CatDTO.builder().name("虎妞").breed("德文卷毛貓").age(0.6).desc("活潑好動無敵可愛愛粘人").build()
        );
        EasyExcel.write(fileName, CatDTO.class).sheet().doWrite(catWriteData);
    }
}

生成效果

使用模板填充完成一個Excel報表

1.創(chuàng)建Java類

@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
public class CatFillDTO {
    private String name;
    private String breed;
    private Double age;
    private String desc;
}

2.構建模板，在數據填充所在列上，填上與之對應的實體類屬性名；

3.使用EasyExcel提供的Fill API，獲取模板文件，寫入數據。

@SpringBootTest
class DemoApplicationTests {
    @Test
    void fillTest1() {
        String fileName = "fill-" + System.currentTimeMillis() + ".xlsx";
        // 構建數據
        List<CatFillDTO> catFillData = List.of(
                CatFillDTO.builder().name("肥貓").breed("銀漸層").age(1.2).desc("每天吃吃睡睡睡睡睡").build(),
                CatFillDTO.builder().name("虎妞").breed("德文卷毛貓").age(0.6).desc("活潑好動無敵可愛愛粘人").build()
        );
        FileUtil.touch(fileName);
        // 加載模板
        InputStream resourceAsStream = ResourceUtil.getStreamSafe("temp/cat-template.xlsx");
        // 生成工作簿對象
        ExcelWriter excelWriter = EasyExcel.write(fileName).withTemplate(resourceAsStream).build();
        // 生成工作表對象
        WriteSheet writeSheet = EasyExcel.writerSheet().build();
        // 多組數據填充需要另起一行時 forceNewRow(true)
        FillConfig fillConfig = FillConfig.builder().forceNewRow(true).build();
        // 多組數據填充 List<實體類> 對象
        excelWriter.fill(catFillData, fillConfig, writeSheet);
        // 關閉excelWriter
        excelWriter.finish();
    }
}

4.生成效果

可以看出，使用模板填充可以省去在代碼中配置字段名稱、單元格大小等配置，在實現復雜的Excel樣式或美觀修飾上更有優(yōu)勢；

根據業(yè)務需要執(zhí)行多份復制與填充的方案

在處理Excel時，你或許會遇到這樣的問題。使用指定模板填充數據，數據根據某個特征進行劃分，分別填進不同的工作表(sheet)中，這樣，我們需要根據業(yè)務的需求，來生成相應的模板表數量，再分別填充上數據。

實現思路

使用POI API加載模板文件為Workbook對象
使用POI中的cloneSheet API復制相應數量的模板工作表
將復制好數量的工作簿文件轉換成輸入流，以便在EasyExcel withTemplate API中使用
使用EasyExcel fill API填充數據。

(直接上業(yè)務代碼，實現的功能為模板表1不執(zhí)行復制，只進行填充，模板表2進行復制并填充)

@Service
@Slf4j
@RequiredArgsConstructor
public class SpeakerServiceImpl implements ISpeakerService {
   /**
    * 填充模板文件
    *
    * @param sheet1Data sheet1數據
    * @param promptMap  提示地圖
    * @return {@code File}
    */
   public File fillTemplateFile(
           CustomSpeakerDemandExcelDTO sheet1Data, Map<String, List<CustomSpeakerPromptDTO>> promptMap) {
      try {
         // 構建模板
         byte[] asInputStream = this.buildTemplateFile(promptMap);
         // 創(chuàng)建臨時導出文件
         File temporaryFile = Files.createTempFile("speaker_task_", ".xlsx").toFile();
         // easyExcel API 根據is作為模板填充數據，并寫入臨時文件temporaryFile
         ExcelWriter excelWriter = EasyExcel.write(temporaryFile)
                 .withTemplate(new ByteArrayInputStream(asInputStream))
                 .build();
         // 填充模板1的sheet
         WriteSheet writeSheet1 = EasyExcel.writerSheet(0).build();
         excelWriter.fill(sheet1Data, writeSheet1);
         // 填充模板2的多個sheet
         int sheetIndex = 1;
         for (String key : promptMap.keySet()) {
            WriteSheet writeSheet = EasyExcel.writerSheet(sheetIndex).build();
            // 寫入數據到當前sheet
            List<CustomSpeakerPromptDTO> prompt = promptMap.get(key);
            excelWriter.fill(prompt, writeSheet);
            sheetIndex++;
         }
         excelWriter.finish();
         return temporaryFile;
      } catch (IOException e) {
         throw new RuntimeException(e);
      }
   }
   /**
    * 構建模板文件
    *
    * @param promptMap 提示地圖
    * @return {@code byte[]}
    * @throws IOException ioexception
    */
   public byte[] buildTemplateFile(Map<String, List<CustomSpeakerPromptDTO>> promptMap) throws IOException {
      // 加載模板文件
      InputStream templateStream = ResourceUtil.getStreamSafe("temp/speaker-task-template.xlsx");
      Workbook workbook = WorkbookFactory.create(templateStream);
      // 設置模板sheet數量, 需要復制promptMap.size()-1 次工作表2
      boolean first = true;
      for (String key : promptMap.keySet()) {
         if (first) {
            // 第一組數據可以直接使用當前模板，不需要進行復制
            workbook.setSheetName(1, key);
         } else {
            // 復制模板到新工作表,并設置表名
            Sheet newSheet = workbook.cloneSheet(1);
            workbook.setSheetName(workbook.getSheetIndex(newSheet), key);
         }
         first = false;
      }
      ByteArrayOutputStream ops = new ByteArrayOutputStream();
      workbook.write(ops);
      byte[] byteArray = ops.toByteArray();
      // 原文件流后續(xù)已不使用，此處關閉
      templateStream.close();
      ops.close();
      return byteArray;
   }
}

以上就是java使用EasyExcel實現Sheet的復制與填充的詳細內容，更多關于java EasyExcel的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: