集成easyExcel

引用easyExcel作者的一段话:

Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,能够原本一个3M的excel用POI sax依然需要100M左右内存降低到KB级别,并且再大的excel不会出现内存溢出,03版依赖POI的sax模式。在上层做了模型转换的封装,让使用者更加简单方便

项目github地址

一、导包

 
    com.alibaba
    easyexcel
    1.1.2-beta5

二、常见名词解释

名词 解释
workbook 工作簿,03版xls,07版本xlsx
sheet 一个工作区间,03版最多65535行 07版最多1048576行
ROW 一行
column 一列
cell 单元格
range 区域
comment 单元格内容
Font 字体样式
headLineMun 表头占几行
table 表格

三、写excel

写excel表格主要用到ExcelWriter

构造函数说明:

 public ExcelWriter(OutputStream outputStream, ExcelTypeEnum typeEnum,boolean needHead) {
        this(outputStream, typeEnum, needHead);
    }
参数 说明
outputStream 文件/响应输出流
typeEnum 文件类型,用于区分excel03和07版本
needHead 布尔类型,是否写入表头,可不填,默认为ture
将数据写入本地文件(无模板)
 try (OutputStream out = new FileOutputStream("noHeader.xlsx");){
            //获取ExcelWriter
            ExcelWriter writer = EasyExcelFactory.getWriter(out);
            Sheet sheet = new Sheet(1, 0);
            sheet.setSheetName("第一个sheet");
            //List> 写入数据的形式为二维数组
            List> data = new ArrayList<>();
            for (int i = 0; i < 10; i++) {
                List item = new ArrayList<>();
                item.add("item0" + i);
                item.add("item1" + i);
                item.add("item2" + i);
                data.add(item);
            }
            //将数据一次写入sheet
            writer.write0(data, sheet);
            writer.finish();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }

结果如下图:


集成easyExcel_第1张图片
图片
将数据写入文件(有模板)

编写模板类

/**模板类需要继承BaseRowModel
 * @author by Crux
 * @Date 2019/8/6 9:52
 */
 @Data
public class Model extends BaseRowModel {

    @ExcelProperty(value ="test0",index = 0)
    private String name;

    @ExcelProperty(value ="test1",index = 1)
    private String price;
}

按模板写入数据(表头)

public void writeWithHeader() {
        try (OutputStream out = new FileOutputStream("noHeader.xlsx");) {

            ExcelWriter writer = EasyExcelFactory.getWriter(out);
            Sheet sheet = new Sheet(1, 3, Model.class);
            sheet.setSheetName("第一个sheet");
            List> data = new ArrayList<>();
            for (int i = 0; i < 3; i++) {
                List item = new ArrayList<>();
                item.add("item0" + i);
                item.add("item1" + i);
                data.add(item);
            }
            sheet.setStartRow(0);
            writer.write0(data, sheet);
            writer.finish();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

@ExcelProperty value参数为表头 index表头的顺序(不重复,不覆盖)

集成easyExcel_第2张图片
image

四、读Excel

写excel表格主要用到ExcelReader

带模板读取

模板类使用上文中Model.class

 public void readByModel() {
        try(FileInputStream fileInputStream = new FileInputStream("header.xlsx")) {
            ReadEventListener readEventListener = new ReadEventListener<>();
            //小于1000行采取一次性读取
            //List data = EasyExcelFactory.read(inputStream, new Sheet(1, 0));
            //大于1000行控制一次性读取大小
            EasyExcelFactory.readBySax(fileInputStream, new Sheet(1, 1, Model.class), readEventListener);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

 
 
读取sheet
    public void read() {
        try( FileInputStream fileInputStream = new FileInputStream("header.xlsx")) {
            ExcelListener excelListener = new ExcelListener();
            ExcelReader excelReader = EasyExcelFactory.getReader(fileInputStream, excelListener);
            //获取sheeet列表
            List sheets = excelReader.getSheets();
            for (Sheet sheet : sheets) {
                if (sheet.getSheetNo() == 1) {
                    excelReader.read(sheet);
                } else if (sheet.getSheetNo() == 2) {
                    //同一表头 不再统计
                    sheet.setHeadLineMun(1);
                    sheet.setClazz(TotalAmont.class);
                    excelReader.read(sheet);
                } else if (sheet.getSheetNo() == 3) {
                    sheet.setHeadLineMun(1);
                    sheet.setClazz(TotalAmont.class);
                    excelReader.read(sheet);
                }
            }
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

五、提供web下载

 @RequestMapping(value = "/export",method = RequestMethod.GET)
    public void getExcel(@RequestParam("file_name")String fileName, HttpServletRequest request, HttpServletResponse response){
        try (  ServletOutputStream out = response.getOutputStream()){
            response.setContentType("multipart/form-data");
            response.setCharacterEncoding("utf-8");
            //设置返回头为附件形式,并提供下载文件名
            response.setHeader("Content-disposition","attachment;filename="+URLEncoder.encode(fileName,"utf-8")+".xlsx");
            ExcelWriter writer = new ExcelWriter(out,ExcelTypeEnum.XLSX,true);
            //提供excel表头模板
            Sheet sheet = new Sheet(1,0,TotalAmont.class);
            sheet.setSheetName("第一个");
            //写入数据,数据格式为List>
            writer.write0(null,sheet);
            writer.write1(null,new  Sheet(1,1,Model.class));
            writer.finish();
            out.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

六、注意事项

  • @ExcelProperty注解 不支持localDate
  • model和excel表格的映射实际上是字段@ExcelProperty参数index的一一映射
  • ExcelReader 读excel类,所有读操作来源于此类
  • ExcelWriter 写excel类,所有写操作来源于此类
  • EasyExcelFactory 可以通过此类去选择读写方式
  • 写excel,在同一sheet中写入两次数据,后写入者无效
  • 该组件主要优化excel导入导出功能,其他excel操作(如追加,求合等)需自行实现

七、组件使用常规操作(流程)

excel 导入
集成easyExcel_第3张图片
image.png

easyExcel按行读取时,每读一行,都会出发监听类中的invoke方法,需要在此处进行数据解析和处理(存入数据库)

excel 导出
集成easyExcel_第4张图片
image.png

out.flush() 是把缓冲区的内容强制的写出

你可能感兴趣的:(集成easyExcel)