快捷導(dǎo)航

Java應(yīng)用EasyExcel工具類(lèi)

更新時(shí)間：2021年05月07日 11:44:43 作者：legendaryhaha

這篇文章主要介紹了Java應(yīng)用EasyExcel工具類(lèi),文中有非常詳細(xì)的代碼示例,對(duì)正在學(xué)習(xí)java的小伙伴們有一定的幫助,需要的朋友可以參考下

一、前言

關(guān)于EasyExcel，它對(duì)poi做了進(jìn)一步的封裝，使得整個(gè)編寫(xiě)流程更加的面向?qū)ο蟆：锰幝?，我認(rèn)為流程上更加清晰即易懂、可讀性更好，壞處的話(huà)，則是操作上沒(méi)有原生的方式那么靈活。

二、導(dǎo)入

StudentVo為實(shí)體類(lèi), 注意實(shí)體中的各個(gè)屬性要和excel按順序一一對(duì)應(yīng)，建議都用String類(lèi)型，真正插入時(shí)，才去做轉(zhuǎn)換
ImportExcelListener 類(lèi)為真正處理數(shù)據(jù)的類(lèi)
CommonService 只是一個(gè)Spring的service bean，用來(lái)執(zhí)行curd操作

 private CommonService commonService;
    public void importExcel(MultipartFile file) throws IOException {
    // HEAD_ROW_NUMBER為Excel中的頭部行數(shù), 這里的關(guān)于ImportExcelListener的構(gòu)造方法中HEAD_ROW_NUMBER參數(shù)可以根據(jù)需要決定傳或者不傳
        EasyExcel.read(file.getInputStream(), StudentVo.class, new ImportExcelListener<StudentVo>(HEAD_ROW_NUMBER, commonService)).sheet().headRowNumber(HEAD_ROW_NUMBER).doRead();
    }

ImportExcelListener 類(lèi)如下，這里根據(jù)實(shí)際需要，可以不用泛型。

public class ImportExcelListener<T> extends AnalysisEventListener<T> {
        /**
         * 每隔BATCH_COUNT條存儲(chǔ)數(shù)據(jù)庫(kù) 然后清理list ，方便內(nèi)存回收
         */
        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;
        }

        /**
         * 這個(gè)每一條數(shù)據(jù)解析都會(huì)來(lái)調(diào)用
         */
        @Override
        public void invoke(T data, AnalysisContext context) {
            // 這里也可以將data轉(zhuǎn)為對(duì)應(yīng)實(shí)體, 然后做一些參數(shù)校驗(yàn)
            Integer rowNum = context.readRowHolder().getRowIndex();
           log.info("當(dāng)前解析的數(shù)據(jù)為第{}行", rowNum);
          
            list.add(data);
            // 批量保存, 防止一次性數(shù)據(jù)過(guò)多, 內(nèi)存溢出
            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();
        }
    }

如果對(duì)導(dǎo)入的數(shù)據(jù)沒(méi)啥特別處要求且數(shù)據(jù)量也不多，也可以直接采用如下這種方式：

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

三、導(dǎo)出

無(wú)需映射實(shí)體對(duì)象, 實(shí)際運(yùn)用中查出來(lái)數(shù)據(jù)后, 需要自己去遍歷組裝成List<List<?>>的二維類(lèi)型，表示第幾行第幾列。

public void test() throws FileNotFoundException {
        File file = new File("E:\\work-grandview\\測(cè)試.xlsx");
        // 創(chuàng)建writerBuilder對(duì)象，自動(dòng)調(diào)整列寬
        ExcelWriter excelWriter = EasyExcel.write(new FileOutputStream(file))
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
                .autoCloseStream(Boolean.TRUE)
                .build();

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

        // 生成導(dǎo)出內(nèi)容;
        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);
        }


        // 寫(xiě)入文件
        excelWriter.write(content, writeSheet);
        // 關(guān)閉文件流
        excelWriter.finish();
    }

在這里插入圖片描述

通過(guò)EasyExcel提供的注解，將實(shí)體映射到對(duì)應(yīng)列中：

@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\\測(cè)試.xlsx");
        // 創(chuàng)建writerBuilder對(duì)象，自動(dòng)調(diào)整列寬
        ExcelWriter excelWriter = EasyExcel.write(new FileOutputStream(file))
                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
                .autoCloseStream(Boolean.TRUE)
                .build();

        // 生成導(dǎo)出內(nèi)容;
        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);
        }
		// 創(chuàng)建sheet, 設(shè)置0號(hào)表, 實(shí)際運(yùn)用中可能得創(chuàng)建多張, 可以遍歷數(shù)據(jù), 每滿(mǎn)足n條就創(chuàng)建i號(hào)sheet表
        WriteSheet writeSheet = EasyExcel.writerSheet(0,"導(dǎo)出數(shù)據(jù)").build();
        // 設(shè)置表頭
        writeSheet.setClazz(content.get(0).getClass());
        // 寫(xiě)入文件
        excelWriter.write(content, writeSheet);
        excelWriter.finish();

    }

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

在這里插入圖片描述