Excel 导入与导出是项目中经常用到的功能,在 Java 中常用 poi 实现 Excel 的导入与导出。由于 poi 占用内存较大,在高并发下很容易发生 OOM 或者频繁 fullgc,阿里基于 poi 开源了 EasyExcel 项目。
除了节约内存,EasyExcel 还简化了 API,通过注解映射 Excel 单元格与对象字段之间的关系,简单的几行代码就能搞定复杂的导入导出功能了。
需求:用户上传excel学生成绩表后,表格中有学号、学生姓名,要求根据学号查询学生的成绩并导出excel表格。
- 导入依赖坐标
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.1.2</version>
</dependency>
2.创建对应的数据模型,该数据模型与操作的excel表格一致
@Data
@ColumnWidth(30) //该注解表示该该对象导出的每一列所占长度为30个单位
public class Student {
@ExcelProperty("姓名")
@ColumnWidth(15) //该列占15个单位
private String name;
@ExcelProperty("学号")
private String id;
@ExcelProperty("成绩")
private String grades;
}
- 创建监听器
- 在监听器中,invoke()方法会在解析每行数据时被调用,我们在其中判断学号是否为空,如果不为空,则将学号添加到学号列表中。
- doAfterAllAnalysed()方法会在所有数据解析完成后被调用,你可以在其中对学号列表进行后续处理。
public class StudentListener extends AnalysisEventListener<Student> {
private List<String> studentNoList = new ArrayList<>();
@Override
public void invoke(Student student, AnalysisContext analysisContext) {
if (StringUtils.isNotBlank(student.getId())) {
studentNoList.add(student.getId());
}
}
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
// 所有数据解析完成后的操作,例如对学号列表进行处理
}
public List<String> getStudentNoList() {
return studentNoList;
}
}
4.查询对应成绩并导出到excel表,通过附件下载
String exportFileName = null;
List<Student> studentGragesList = new ArrayList<>();
List<String> exportCheckedColumns = new ArrayList<>();
@PostMapping("/getStudentList")
public Map<String, Object> getBatchStudentGrades(@RequestParam(value = "file") MultipartFile rawFile, @RequestParam("checkedColumns") List<String> checkedColumns) {
studentGragesList.clear();
exportCheckedColumns = checkedColumns.stream().collect(Collectors.toList());
try{
// 创建监听器
StudentListener studentListener = new StudentListener();
// 读取excel文件,由监听器进行处理
EasyExcel.read(rawFile.getInputStream(), student.class, studentListener).sheet().doRead();
//获取由监听器处理后的学号列表
List<String> StudentNoList = studentListener.getStudentNoList();
//连接数据库后进行成绩查询,获取学生成绩集合
...
studentGragesList = ....
// 获取当前时间
LocalDateTime currentTime = LocalDateTime.now();
String formattedTime = currentTime.format(DateTimeFormatter.ofPattern("yyyyMMddHHmmss"));
int i = rawFile.getOriginalFilename().indexOf(".");
exportFileName = rawFile.getOriginalFilename().substring(0,i) + formattedTime + ".xlsx";
String exportPath = "D://";
//1. 直接导出到用户电脑
EasyExcel.write(exportPath + exportFileName, Student.class).sheet("成绩统计").doWrite(studentGragesList);
}catch(Exception e){
e.printStack();
}
}
通过附件形式下载excel文件
@GetMapping("/exportStudentExcelFile")
public void exportStudentExcelFile(HttpServletResponse response) throws IOException {
response.setContentType("application/vnd.ms-excel");
response.setHeader("Content-Disposition", "attachment; filename=" + new String(exportFileName.getBytes(),"ISO8859-1")); //通过”ISO8859-1"编码附件名,让通过附件形式下载的中文文件名不乱码
EasyExcel.write(response.getOutputStream(), Student.class)
.includeColumnFieldNames(exportColumns) //设置导出的excel列
.sheet("成绩统计")
.doWrite(studentGragesList);
}