1.EasyExcel是什么?
EasyExcel是一个基于Java的简单、省内存的读写Excel的阿里开源项目在尽可能节约内存的情况下支持读写百M的Excel。
2.EasyExcel能用在哪里?
项目中涉及到Excel文件,CVS文件大多数的读写操作(导入导出),均可以使用!
3.为什么选用EasyExcel解析excel?
4.如何使用?
阿里官方文档:EasyExcel官方文档 - 基于Java的Excel处理工具 | Easy Excel 官网
步骤:
1.环境搭建:
①创建SpringBoot的maven工程
②引入相关依赖jar--还有Lombok
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>最新版本</version>
</dependency>
③参考官网API完成功能
package com.wjy.entity;
import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Emp {
@ExcelProperty(value = "姓名")
private String name;
@ExcelProperty(value = "年龄")
private Integer age;
@ExcelProperty(value = "性别")
private String sex;
@ExcelIgnore
private String job;
}
4.1EasyExcel写操作--导出
@Test
void writer() {
String fileName = "D:\\Program Files\\Project\\EasyExcel\\myEasyExcel.xlsx";
// 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭
// 如果这里想使用03 则 传入excelType参数即可
List<Emp> data = new ArrayList<>();
data.add(new Emp("gyh",18,"男","项目经理"));
data.add(new Emp("wjy",18,"女","总经理"));
EasyExcel.write(fileName, Emp.class).sheet("模板").doWrite(data);
}
package com.wjy.controller;
import com.alibaba.excel.EasyExcel;
import com.wjy.entity.Emp;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
@RestController
public class WriterController {
/**
* 文件下载(失败了会返回一个有部分数据的Excel)
* <p>
* 1. 创建excel对应的实体对象 参照{@link Emp}
* <p>
* 2. 设置返回的 参数
* <p>
* 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");
List<Emp> data = new ArrayList<>();
data.add(new Emp("gyh",18,"男","项目经理"));
data.add(new Emp("wjy",18,"女","总经理"));
EasyExcel.write(response.getOutputStream(), Emp.class).sheet("模板").doWrite(data);
}
}
4.1EasyExceld读操作--导入
package com.wjy;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.wjy.dao.DemoDAO;
import com.wjy.entity.Emp;
import java.util.List;
// 有个很重要的点 DemoDataListener 不能被spring管理,要每次读取excel都要new,然后里面用到spring可以构造方法传进去
public class DemoDataListener implements ReadListener<Emp> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<Emp> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private DemoDAO demoDAO;
public DemoDataListener() {
// 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
demoDAO = new DemoDAO();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param demoDAO
*/
public DemoDataListener(DemoDAO demoDAO) {
this.demoDAO = demoDAO;
}
/**
* 这个每一条数据解析都会来调用
*
* @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()}
* @param context
*/
@Override
public void invoke(Emp data, AnalysisContext context) {
System.out.println("解析到一条数据:"+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();
System.out.println("所有数据解析完成!");
}
/**
* 加上存储数据库
*/
private void saveData() {
System.out.println(cachedDataList.size()+"条数据,开始存储数据库!");
demoDAO.save(cachedDataList);
System.out.println("存储数据库成功!");
}
}
package com.wjy.dao;
import com.wjy.entity.Emp;
import java.util.List;
/**
* 假设这个是你的DAO存储。当然还要这个类让spring管理,当然你不用需要存储,也不需要这个类。
**/
public class DemoDAO {
public void save(List<Emp> list) {
// 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
}
}
@Test
void reader() {
String fileName = "D:\\Program Files\\Project\\EasyExcel\\myEasyExcel.xlsx";
EasyExcel.read(fileName, Emp.class, new DemoDataListener()).sheet().doRead();
}
package com.wjy.controller;
import com.alibaba.excel.EasyExcel;
import com.wjy.DemoDataListener;
import com.wjy.dao.DemoDAO;
import com.wjy.entity.Emp;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
@RestController
public class ReadController {
/**
* 文件上传
* <p>
* 1. 创建excel对应的实体对象 参照{@link }
* <p>
* 2. 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照{@link }
* <p>
* 3. 直接读即可
*/
@PostMapping("/upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {
EasyExcel.read(file.getInputStream(), Emp.class, new DemoDataListener()).sheet().doRead();
return "success";
}
}