简介
EasyExcel是阿里巴巴开源的一个excel处理框架,以使用简单、节省内存著称。EasyExcel能大大减少占用内存的主要原因是在解析Excel时没有将文件数据一次性全部加载到内存中,而是从磁盘上一行行读取数据,逐个解析。
特点
- Java领域解析、生成Excel比较有名的框架有Apache poi、jxl等。但他们都存在一个严重的问题就是非常的耗内存。如果你的系统并发量不大的话可能还行,但是一旦并发上来后一定会OOM或者JVM频繁的full gc。
- EasyExcel采用一行一行的解析模式,并将一行的解析结果以观察者的模式通知处理(AnalysisEventListener)
- EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。
使用步骤
- pom中引入xml相关依赖
<dependencies>
<!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.1.1</version>
</dependency>
</dependencies>
- 创建实体类(需要和excel表格对应)
@Data
public class Stu {
//设置表头名称
@ExcelProperty("学生编号")
private int sno;
//设置表头名称
@ExcelProperty("学生姓名")
private String sname;
}
- 实现写操作
- 创建方法循环设置要添加到Excel的数据
//循环设置要添加的数据,最终封装到list集合中 private static List<Stu> data() { List<Stu> list = new ArrayList<Stu>(); for (int i = 0; i < 10; i++) { Stu data = new Stu(); data.setSno(i); data.setSname("张三"+i); list.add(data); } return list; } - 实现最终的添加操作
public static void main(String[] args) throws Exception { // 写法1 String fileName = "F:\\11.xlsx"; // 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭 // 如果这里想使用03 则 传入excelType参数即可 EasyExcel.write(fileName, Stu.class).sheet("写入方法").doWrite(this.data()); }
- 创建方法循环设置要添加到Excel的数据
- 实现读操作
- 创建实体类(加上index)
@Data public class Stu { //设置表头名称 //设置列对应的属性 @ExcelProperty(value = "学生编号",index = 0) private int sno; //设置表头名称 //设置列对应的属性 @ExcelProperty(value = "学生姓名",index = 1) private String sname; } - 创建读取操作的监听器
public class ExcelListener extends AnalysisEventListener<Stu> { //创建list集合封装最终的数据 List<Stu> list = new ArrayList<Stu>(); //一行一行去读取excle内容 @Override public void invoke(Stu user, AnalysisContext analysisContext) { System.out.println("***"+user); list.add(user); } //读取excel表头信息 @Override public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) { System.out.println("表头信息:"+headMap); } //读取完成后执行 @Override public void doAfterAllAnalysed(AnalysisContext analysisContext) { } } - 调用实现最终的读取
public static void main(String[] args) throws Exception { String fileName = "F:\\11.xlsx";//指定读取文件路径 // 这里 需要指定读用哪个class去读,然后读取第一个sheet 文件流会自动关闭 EasyExcel.read(fileName, Stu.class, new ExcelListener()).sheet().doRead(); }
- 创建实体类(加上index)
响应浏览器下载表格(对象->Excel)
@GetMapping("/exportData")
public void exportData(HttpServletResponse response) {
OutputStream outputStream = null;
try {
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");
List<Subject> subjects = baseMapper.selectList(null);//查询数据库
List<SubjectEeVo> subjectEeVos = new ArrayList<>();//创建需要输出的表格对应实体类的集合
//把数据库查询出的数据,装填到表格实体类的集合中
for (Subject subject : subjects) {
SubjectEeVo subjectEeVo = new SubjectEeVo();
BeanUtils.copyProperties(subject,subjectEeVo);
subjectEeVos.add(subjectEeVo);
}
//获取输出流
outputStream = response.getOutputStream();
//使用EasyExcel中的api进行输出到客户端
EasyExcel.write(outputStream, SubjectEeVo.class)
.sheet()
.doWrite(subjectEeVos);
} catch (Exception e) {
e.printStackTrace();
}finally {
try {
//关闭输出流
if (outputStream!=null){
outputStream.close();
}
} catch (IOException ioException) {
ioException.printStackTrace();
}
}
}
浏览器请求导入表格(Excel->对象)
- 创建EasyExcel监听器
@Component
public class SubjectListener extends AnalysisEventListener<SubjectEeVo> {
@Autowired
private SubjectMapper subjectMapper;
//一行一行读,从第二行开始,默认第一行为表头
@Override
public void invoke(SubjectEeVo subjectEeVo, AnalysisContext analysisContext) {
Subject subject = new Subject();
BeanUtils.copyProperties(subjectEeVo,subject);
subjectMapper.insert(subject);
}
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
}
}
- 使用api进行导入
@GetMapper("/importData")
public void importData(MultipartFile file) {
try {
EasyExcel.read(file.getInputStream(),SubjectEeVo.class,subjectListener)//subjectListener需要在该类中进行自动装配
.sheet()
.doRead();
} catch (IOException ioException) {
throw new ExcelException(20001,"文件导入错误,请重试!");
}
}