SpringBoot集成EasyExcel实现Excel文件导入/出
一,添加依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>最新版本</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
二,创建实体类
@ExcelProperty的属性 | 说明 |
---|---|
value | 按列名去匹配Excel数据,如果名字重复,会导致只有一个实体类字段读取到数据 |
index | 按列的下标去匹配Excel数据 |
不建议index和name同时用,要么一个对象只用index,要么一个对象只用name去匹配
@Data
@NoArgsConstructor
@AllArgsConstructor
public class EasyExcelEntity {
@ExcelProperty("姓名")
private String name;
@ExcelProperty("年龄")
private int age;
@ExcelProperty("性别")
private String sex;
}
三,读数据
(1)创建读的监听器
@Slf4j
public class ReadExcelListener implements ReadListener<EasyExcelEntity> {
private static final int BATCH_NUM = 100;
private List<EasyExcelEntity> cachedData = ListUtils.newArrayListWithExpectedSize(BATCH_NUM);
/**
* 读出Excel文件中的数据并放入cachedData
*/
@Override
public void invoke(EasyExcelEntity easyExcelEntity, AnalysisContext analysisContext) {
cachedData.add(easyExcelEntity);
if (cachedData.size() >= BATCH_NUM) {
handlerData();
cachedData = ListUtils.newArrayListWithExpectedSize(BATCH_NUM);
}
}
/**
* 所有数据解析完成了都会来调用
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
if (cachedData.size() != 0)
handlerData();
log.info("所有数据解析完成!");
}
/**
* 在转换异常获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则继续读取下一行
*/
@Override
public void onException(Exception exception, AnalysisContext context) {
log.error("解析失败,但是继续解析下一行:{}", exception.getMessage());
// 如果是某一个单元格的转换异常,能获取到具体行号
// 如果要获取头的信息需配合invokeHeadMap使用
if (exception instanceof ExcelDataConvertException e) {
log.error("第{}行,第{}列解析异常,数据为:{}", e.getRowIndex(), e.getColumnIndex(), e.getCellData());
}
}
/**
* 处理从Excel文件中读取的数据
*/
public void handlerData() {
// 处理数据代码逻辑
}
}
(2)调用读取数据方法
public static final String XLSX_MIME = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
@PostMapping("/import")
public Result importExcel(@RequestBody MultipartFile file) throws IOException {
if (file.isEmpty()) {
throw new BusinessException("上传文件不能为空", Code.BUS_EXC);
}
String oriFileName = file.getOriginalFilename();
if (XLSX_MIME.equals(file.getContentType())
&& oriFileName != null
&& oriFileName.toLowerCase().endsWith(".xlsx")) {
ReadExcelListener listener = new ReadExcelListener();
EasyExcel.read(file.getInputStream(), EasyExcelEntity.class, listener)
.sheet()
.doRead();
return new Result(Code.SUCCESS,"导入成功", null);
} else {
throw new BusinessException("请上传.xlsx类型文件", Code.BUS_EXC);
}
}
四,写数据
Collection<EasyExcelEntity> data = new ArrayList<>();
File file = new File("绝对路径或相对路径");
// 这里需要指定写用哪个class去写,然后写到第一个sheet,名字为模板,然后文件流会自动关闭
EasyExcel.write(file, EasyExcelEntity.class).sheet("sheet").doWrite(data);