Java應用EasyExcel工具類

Posted on by

一、前言

關於EasyExcel，它對poi做瞭進一步的封裝，使得整個編寫流程更加的面向對象。好處嘛，我認為流程上更加清晰即易懂、可讀性更好，壞處的話，則是操作上沒有原生的方式那麼靈活。

二、導入

  • StudentVo為實體類, 註意實體中的各個屬性要和excel按順序一 一對應，建議都用String類型，真正插入時，才去做轉換
  • ImportExcelListener 類為真正處理數據的類
  • CommonService 隻是一個Spring的service bean，用來執行curd操作
 private CommonService commonService;
    public void importExcel(MultipartFile file) throws IOException {
    // HEAD_ROW_NUMBER為Excel中的頭部行數, 這裡的關於ImportExcelListener的構造方法中HEAD_ROW_NUMBER參數可以根據需要決定傳或者不傳
        EasyExcel.read(file.getInputStream(), StudentVo.class, new ImportExcelListener<StudentVo>(HEAD_ROW_NUMBER, commonService)).sheet().headRowNumber(HEAD_ROW_NUMBER).doRead();
    }

ImportExcelListener 類如下，這裡根據實際需要，可以不用泛型。

public class ImportExcelListener<T> extends AnalysisEventListener<T> {
        /**
         * 每隔BATCH_COUNT條存儲數據庫 然後清理list ，方便內存回收
         */
        private static final int BATCH_COUNT = 500;
        private int headRowNum;
        private CommonService commonService;
        private List<T> list = new ArrayList<>();

        public ImportExcelListener(int headRowNumber, CommonService commonService) {
            this.headRowNum = headRowNumber;
            this.commonService = commonService;
        }

        /**
         * 這個每一條數據解析都會來調用
         */
        @Override
        public void invoke(T data, AnalysisContext context) {
            // 這裡也可以將data轉為對應實體, 然後做一些參數校驗
            Integer rowNum = context.readRowHolder().getRowIndex();
           log.info("當前解析的數據為第{}行", rowNum);
          
            list.add(data);
            // 批量保存, 防止一次性數據過多, 內存溢出
            if (list.size() >= BATCH_COUNT) {
                // 保存
                commonService.save(list);
                list.clear();
            }
        }


        // 在解析之後, 也要記得再判斷是否為空, 不為空要保存一下
        @Override
        public void doAfterAllAnalysed(AnalysisContext context) {
            if (CollectionUtils.isEmpty(list)) {
                return;
            }
            commonService.save(list);
            list.clear();
        }
    }

如果對導入的數據沒啥特別處要求且數據量也不多，也可以直接采用如下這種方式：

List<Object> data = null;
        try {
            data = EasyExcelFactory.read(file.getInputStream()).sheet().doReadSync();
        } catch (IOException e) {
            log.error("讀取失敗", e);
            throw new BusinessException("讀取失敗");
        }
        // 保存操作
        // ...

三、導出

  • 無需映射實體對象, 實際運用中查出來數據後, 需要自己去遍歷組裝成List<List<?>>的二維類型，表示第幾行第幾列。
public void test() throws FileNotFoundException {
        File file = new File("E:\\work-grandview\\測試.xlsx");
        // 創建writerBuilder對象，自動調整列寬
        ExcelWriter excelWriter = EasyExcel.write(new FileOutputStream(file))
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
                .autoCloseStream(Boolean.TRUE)
                .build();

        //  List<List<?>>類型, 二維數據, 表示第幾行第幾列, 設置表頭內容
        List<List<String>> titleList = new ArrayList<>();
        titleList.add(Arrays.asList("名稱", "key", "value"));
        int sheetNum = 0;
        WriteSheet writeSheet = EasyExcel.writerSheet(sheetNum,"導出數據").build();
        excelWriter.write(titleList, writeSheet);

        // 生成導出內容;
        List<List<Object>> content = new ArrayList<>();
        // 10行3列
        for (int i = 0; i < 10; i++) {
            List<Object> dataList = new ArrayList<>();
            for (int j = 0; j < 3; j++) {
                dataList.add(j);
            }
            content.add(dataList);
        }


        // 寫入文件
        excelWriter.write(content, writeSheet);
        // 關閉文件流
        excelWriter.finish();
    }

在這裡插入圖片描述

  • 通過EasyExcel提供的註解，將實體映射到對應列中：
@Data
 public class VO {
        @ExcelProperty(value = "姓名", index = 0)
        int name;
        @ExcelProperty(value = "key", index = 1)
        int key;
        @ExcelProperty(value = "value", index = 2)
        int value;
    }

@Test
    public void test() throws FileNotFoundException {
        File file = new File("E:\\work-grandview\\測試.xlsx");
        // 創建writerBuilder對象，自動調整列寬
        ExcelWriter excelWriter = EasyExcel.write(new FileOutputStream(file))
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
                .autoCloseStream(Boolean.TRUE)
                .build();

        // 生成導出內容;
        List<VO> content = new ArrayList<>();
        // 10行3列
        for (int i = 0; i < 10; i++) {
            VO vo = new VO();
            vo.setKey(i);
            vo.setName(i);
            vo.setValue(i);
           content.add(vo);
        }
		// 創建sheet, 設置0號表, 實際運用中可能得創建多張, 可以遍歷數據, 每滿足n條就創建i號sheet表
        WriteSheet writeSheet = EasyExcel.writerSheet(0,"導出數據").build();
        // 設置表頭
        writeSheet.setClazz(content.get(0).getClass());
        // 寫入文件
        excelWriter.write(content, writeSheet);
        excelWriter.finish();

    }

一開始創建後，莫名奇妙多瞭個this0 列 ， 後 來 想 瞭 想 ， 原 來 我 的 實 體 類 是 T e s t 類 的 內 部 類 來 著 ， 而 ‘ c o n t e n t . g e t ( 0 ) . g e t C l a s s ( ) ‘ 拿 到 的 是 一 個 代 理 類 T e s t 0列，在設置表頭時，同時被處理為屬性值瞭。在將VO類寫到外部後解決。

在這裡插入圖片描述

在這裡插入圖片描述

到此這篇關於Java應用EasyExcel工具類的文章就介紹到這瞭,更多相關Java EasyExcel工具類內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：