easyExcel 读写excel表格

EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。

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

官方文档: https://www.yuque.com/easyexcel/doc/easyexcel

1. 导入maven依赖

依赖地址

https://mvnrepository.com/artifact/com.alibaba/easyexcel

2. 简单写出excel

2.1 准备pojo类

以User类为例, @ExcelProperty注解是声明表格对应的列信息, value是列名, index是索引(从0开始)

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @ExcelProperty(value = "姓名", index = 0)
    private String name;
    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;
    @ExcelProperty(value = "生日", index = 2)
    private Date birth;
}

2.2 写出

// 假设为数据库层对象
@Autowired
private UserDao userDao;

// 写出excel文件方法
public void writeExcelForUserList() {
    // 保存文件路径
    String fileName = "d:\user.xlsx";
    // 查数据, 查询所有用户
    List<User> users = userDao.getUsers();
    /** 写出到文件
      * 参数fileName为文件输出路径
      * User.class为实体类字节码对象
      * sheet中的参数为表的sheet名
      * doWrite的参数为实体类集合对象
      */
    EasyExcel.write(fileName, User.class).sheet("用户表").doWrite(users);
}

3. 简单读取excel

假如我们读取上面生成的excel表格, pojo依赖依旧使用的上面的实体类User

3.1 监听器

读取excel需要先写一个监听器继承AnalysisEventListener, 泛型最好指定对应的实体类

注意, 此监听器不能被spring管理, 使用的时候只能new

public class UserExcelListener extends AnalysisEventListener<User> {

    /**
     * 一行一行的读取excel中的内容 (此方法必写)
     */
    @Override
    public void invoke(User user, AnalysisContext analysisContext) {
        System.out.println("user: " + user);
    }

    /**
     * 读取表头内容
     */
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        super.invokeHeadMap(headMap, context);
        System.out.println("headMap: " + headMap);
    }

    /**
     * 读取完成之后执行 (此方法必写)
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        System.out.println("read ok");
    }

}

3.2 读取

public void readExcelForUserList() {
    // 读取文件的路径
    String fileName = "d:\user.xlsx";
    // 执行读取
    /**
      * fileName参数为读取文件的路径
      * User.class为对应的实体类
      * new UserExcelListener是上面写的监听器
      */
    EasyExcel.read(fileName, User.class, new UserExcelListener()).sheet().doRead();
}

4. WEB 上传和下载

4.1 下载

/**
  * 文件下载（失败了会返回一个有部分数据的Excel）
  * <p>1. 创建excel对应的实体对象 参照{@link DownloadData}
  * <p>2. 设置返回的 参数
  * <p>3. 直接写，这里注意，finish的时候会自动关闭OutputStream,当然你外面再关闭流问题不大
  */
@GetMapping("download")
public void download(HttpServletResponse response) throws IOException {
    // 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
    String fileName = URLEncoder.encode("测试", "UTF-8");
    response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
    EasyExcel.write(response.getOutputStream(), DownloadData.class).sheet("模板").doWrite(data());
}

4.2 上传

/**
  * 文件上传
  * <p>1. 创建excel对应的实体对象 参照{@link UploadData}
  * <p>2. 由于默认一行行的读取excel，所以需要创建excel一行一行的回调监听器，参照{@link UploadDataListener}
  * <p>3. 直接读即可
  */
@PostMapping("upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {
    EasyExcel.read(file.getInputStream(), UploadData.class, new UploadDataListener(uploadDAO)).sheet().doRead();
    return "success";
}