easyexcel使用详解（来自阿里巴巴员工的总结，很详细）

浅浅的花香味﹌ 2023-10-01 17:38 4阅读 0赞

此篇博客是记录自己学习easyexcel中收集到的资料。

建议下载github地址，直接看使用案列。  
[1、easyexcelgithub地址][1_easyexcelgithub]  
[2、easyexcel使用文档][2_easyexcel]  
在单元测试模块：read,web,write三个目录中分有详细的使用。其中web中表格上传，下载。

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LyP5Yqg54m56YGH5LiK6KW_5p-a_size_18_color_FFFFFF_t_70_g_se_x_16]

# 文件上传 #

## UploadDataListener ##

package com.alibaba.easyexcel.test.demo.web;
 
 import java.util.List;
 
 import com.alibaba.excel.context.AnalysisContext;
 import com.alibaba.excel.read.listener.ReadListener;
 import com.alibaba.excel.util.ListUtils;
 import com.alibaba.fastjson.JSON;
 
 import lombok.extern.slf4j.Slf4j;
 
 /**
 * 模板的读取类
 *
 * @author Jiaju Zhuang
 */
 // 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
 @Slf4j
 public class UploadDataListener implements ReadListener<UploadData> {
 
 /**
 * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
 */
 private static final int BATCH_COUNT = 5;
 private List<UploadData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
 /**
 * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
 */
 private UploadDAO uploadDAO;
 
 public UploadDataListener() {
 
 // 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
 uploadDAO = new UploadDAO();
 }
 
 /**
 * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
 *
 * @param uploadDAO
 */
 public UploadDataListener(UploadDAO uploadDAO) {
 
 this.uploadDAO = uploadDAO;
 }
 
 /**
 * 这个每一条数据解析都会来调用
 *
 * @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()}
 * @param context
 */
 @Override
 public void invoke(UploadData data, AnalysisContext context) {
 
 log.info("解析到一条数据:{}", JSON.toJSONString(data));
 cachedDataList.add(data);
 // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
 if (cachedDataList.size() >= BATCH_COUNT) {
 
 saveData();
 // 存储完成清理 list
 cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
 }
 }
 
 /**
 * 所有数据解析完成了 都会来调用
 *
 * @param context
 */
 @Override
 public void doAfterAllAnalysed(AnalysisContext context) {
 
 // 这里也要保存数据，确保最后遗留的数据也存储到数据库
 saveData();
 log.info("所有数据解析完成！");
 }
 
 /**
 * 加上存储数据库
 */
 private void saveData() {
 
 log.info("{}条数据，开始存储数据库！", cachedDataList.size());
 uploadDAO.save(cachedDataList);
 log.info("存储数据库成功！");
 }
 }

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

# 文件下载 #

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

data()数据

private List<DownloadData> data() {
 
 List<DownloadData> list = ListUtils.newArrayList();
 for (int i = 0; i < 10; i++) {
 
 DownloadData data = new DownloadData();
 data.setString("字符串" + 0);
 data.setDate(new Date());
 data.setDoubleData(0.56);
 list.add(data);
 }
 return list;
 }

[1_easyexcelgithub]: https://github.com/alibaba/easyexcel
[2_easyexcel]: https://www.yuque.com/easyexcel/doc/easyexcel
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5LyP5Yqg54m56YGH5LiK6KW_5p-a_size_18_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/dc738a8771784bbfa019b232078b6d80.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5LyP5Yqg54m56YGH5LiK6KW_5p-a,size_18,color_FFFFFF,t_70,g_se,x_16