Easypoi實現excel多sheet表匯入匯出功能

阿新 • • 發佈：2020-10-25

Easypoi簡化了開發中對文件的匯入匯出實現，並不像poi那樣都要寫大段工具類來搞定文件的讀寫。

第一步引入Easypoi依賴

        <!-- 匯出檔案工具 EasyPoi實現Excel讀寫管理測試用例  -->
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-spring-boot-starter</artifactId>
            <version>4.2.0</version>
        </dependency>

Easypoi的註解使用說明（存留檢視即可）
第二步定義對應表格頭資料物件實體類(註解的使用可以查閱上面的按需使用即可)

@Setter
@Getter
@ToString
public class LoginCaseDto {
    @Excel(name = "flag(0是反向，1是正向)",orderNum = "1",width = 20)
    private String flag;
    @Excel(name = "urlid(訪問id)",orderNum = "2",width = 20)
    private String urlid;
    @Excel(name = "name(登入賬號)",orderNum = "3",width = 20)
    private String name;
    @Excel(name = "pwd(登入密碼)",orderNum = "4",width = 20)
    private String pwd;
    @Excel(name = "desc(期望提示語)",orderNum = "5",width = 40)
    private String desc;
    @Excel(name = "actual(實際測試結果)",orderNum = "6",width = 40 )
    private String actual;
    @Excel(name = "urlpath(被測路徑)",orderNum = "7",width = 40 )
    private String urlpath;
}

public class LoginUrlDto {
    @Excel(name = "id（訪問測試型別）",orderNum = "1",width = 20)
    private String id;
    @Excel(name = "type(請求型別)",orderNum = "2",width = 20)
    private String type;
    @Excel(name = "url(訪問地址)",orderNum = "3",width = 40)
    private String url;
}

第三步：封裝Easypoi工具類（網上查了很多但是並不完整，這裡補充下）

參考文章
關鍵封裝工具類多sheet匯入方法

  /**
     * 功能描述：根據接收的Excel檔案來匯入多個sheet,根據索引可返回一個集合
     * @param filePath   匯入檔案路徑
     * @param sheetIndex  匯入sheet索引
     * @param titleRows  表標題的行數
     * @param headerRows 表頭行數
     * @param pojoClass  Excel實體類
     * @return
     */
    public static <T> List<T> importExcel(String filePath,int sheetIndex,Integer titleRows, Integer headerRows, Class<T> pojoClass) {
        // 根據file得到Workbook,主要是要根據這個物件獲取,傳過來的excel有幾個sheet頁
        ImportParams params = new ImportParams();
        // 第幾個sheet頁
        params.setStartSheetIndex(sheetIndex);
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
        } catch (NoSuchElementException e) {
            throw new RuntimeException("模板不能為空");
        } catch (Exception e) {
            e.printStackTrace();
        }
        return list;
    }

excel匯入示例（直接傳入sheet索引獲取對應的sheet表）
多sheet表匯出方法使用(需要把匯入的多sheet表資料轉成list集合獲取新資料後呼叫該方法重新寫入)

  /**
     * 功能描述：把同一個表格多個sheet測試結果重新輸出，如果後續增加多個List<Map<String, Object>>物件，需要後面繼續追加
     * @ExcelEntiry sheet表格對映的實體物件
     * @return
     */
    public static String exportSheet( Object...objects){
        Workbook workBook = null;
        try {
            // 建立引數物件（用來設定excel得sheet得內容等資訊）
            ExportParams deptExportParams = new ExportParams();
            // 設定sheet得名稱
            deptExportParams.setSheetName("登入用例");
            // 設定sheet表頭名稱
            deptExportParams.setTitle("測試用例");
            // 建立sheet1使用得map
            Map<String, Object> deptExportMap = new HashMap<>();
            // title的引數為ExportParams型別，目前僅僅在ExportParams中設定了sheetName
            deptExportMap.put("title", deptExportParams);
            // 模版匯出對應得實體型別
            deptExportMap.put("entity", LoginCaseDto.class);
            // sheet中要填充得資料
            deptExportMap.put("data", objects[0]);
            ExportParams empExportParams = new ExportParams();
            empExportParams.setTitle("被測RUL路徑");
            empExportParams.setSheetName("被測url");
            // 建立sheet2使用得map
            Map<String, Object> empExportMap = new HashMap<>();
            empExportMap.put("title", empExportParams);
            empExportMap.put("entity", LoginUrlDto.class);
            empExportMap.put("data", objects[1]);
            // 將sheet1、sheet2使用得map進行包裝
            List<Map<String, Object>> sheetsList = new ArrayList<>();
            sheetsList.add(deptExportMap);
            sheetsList.add(empExportMap);
            // 執行方法
            workBook = EasyPoiUtil.exportExcel(sheetsList, ExcelType.HSSF);
            //String fileName = URLEncoder.encode("test", "UTF-8");
            String filepath = (String) LoadStaticConfigUtil.getCommonYml( "testcaseexcel.cases");
            FileOutputStream fos = new FileOutputStream(filepath);
            workBook.write(fos);
            fos.close();
        }catch (Exception e){
            e.printStackTrace();
        }finally {
            if(workBook != null) {
                try {
                    workBook.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return "success";
    }

最後即可獲取新的測試結果表格。
專案原始碼地址傳送門

更多測試技術分享、學習資源以及一些其他福利可關注公眾號：【Coding測試】獲取：