EasyExcel导入
- easyexcel版本3.1.1
- 实体类
- 监听器
- 控制层
- 导出样式处理(显示框线、表头及内容样式、合并)
· 有写的不好的地方还请见谅,参照官网上自己根据需求改了改, 官网,小伙伴们也可以自己再优化一下
· 针对导入的数据我们可以在service进行处理
· 也可以在service层用@valid与Validated结合使用,但需通过AOP来控制统一返回
easyexcel版本3.1.1
<dependency>
<groupId></groupId>
<artifactId>easyexcel</artifactId>
<version>3.1.1</version>
</dependency>
实体类
@Data
public class DemoData{
/**
* value: 列名 index:下标 这两个一定要对应
*/
@ExcelProperty(value="姓名",index = 0)
private String name;
/**
* 用名字去匹配,这里需要注意,如果名字重复,会导致只有一个字段读取到数据
*/
@ExcelProperty(value="性别",index = 1)
private String sex;
@ExcelProperty(value="生日",index = 2)
private Date date;
}
监听器
package com.bwrj.listener;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.metadata.data.ReadCellData;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.fastjson.JSON;
import com.bwrj.entity.TermInfo;
import com.bwrj.service.ImportService;
import com.bwrj.util.Dto;
import com.bwrj.util.DtoUtil;
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
@Slf4j
public class ImportTermInfoListener implements ReadListener<TermInfo> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<TermInfo> cachedDataList = new ArrayList(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private ImportService importService;
//后台统一返回的信息
private Dto result;
/**
* 这两条用来校验表头信息
*/
private List<String> headList = new ArrayList();
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来,否则会报空指针
*
* @param
*/
public ImportTermInfoListener(ImportService importService, Dto result) {
this.importService = importService;
this.result = result;
}
@Override
public void invokeHead(Map<Integer, ReadCellData<?>> headMap, AnalysisContext context) {
for (Integer i : headMap.keySet()) {
headList.add(headMap.get(i).getStringValue());
}
log.info("表头信息:{}", headList);
//如果表头不包含指定列名就抛出自定义异常,然后controller去捕捉,这样就可以把错误信息返回给前端,需要判断多个表头可以以此类推
if (headList.size() < 11) {
result = DtoUtil.returnFail("导入模板不匹配");
}
}
/**
* 这个每一条数据解析都会来调用
*/
@Override
public void invoke(TermInfo data, AnalysisContext context) {
log.info("解析到一条数据:{}", JSON.toJSONString(data));
cachedDataList.add(data);
// 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
Dto dto = saveData();
result.setMessage(dto.getMessage());
// 存储完成清理 list
cachedDataList = new ArrayList(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了 都会来调用
*
* @param context
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据,确保最后遗留的数据也存储到数据库
Dto dto = saveData();
result.setMessage(dto.getMessage());
log.info("所有数据解析完成!");
}
/**
* 存储数据库
*/
private Dto saveData() {
log.info("{}条数据,开始存储数据库!", cachedDataList.size());
if (cachedDataList.size() > 0) {
Dto dto = importService.saveTermInfo(cachedDataList);
return dto;
} else {
return DtoUtil.returnFail("未获取到数据", "E400");
}
}
}
控制层
@RestController
@RequestMapping("import")
public class ImportController {
@Autowired
private ImportService importService;
/**
* 由于默认一行行的读取excel,所以需要创建excel一行一行的回调监听器,参照
*
* 直接读即可
*/
@PostMapping("importTermInfo")
public Dto importTermInfo(MultipartFile file) throws IOException {
Dto result=new Dto();
EasyExcel.read(file.getInputStream(), TermInfo.class, new ImportTermInfoListener(importService,result)).sheet().headRowNumber(1).doRead();
return result;
}
}
导出样式处理(显示框线、表头及内容样式、合并)
这里只简单介绍导出的一些样式处理,具体导出参考 easyexcel导出
public void importQuantityEstimate(MultipartFile file) {
try {
//自定义表头样式 浅橙色 居中
WriteCellStyle headCellStyle = new WriteCellStyle();
headCellStyle.setFillForegroundColor(IndexedColors.TAN.getIndex()); //表头颜色
headCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER); //文本居中
//字体
WriteFont writeFont = new WriteFont();
writeFont.setFontName("微软雅黑"); //字体
writeFont.setFontHeightInPoints((short) 10); //字体大小
headCellStyle.setWriteFont(writeFont);
//内容样式
WriteCellStyle contentCellStyle = new WriteCellStyle();
contentCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER); //文本居中
contentCellStyle.setWriteFont(writeFont);
contentCellStyle.setBorderLeft(BorderStyle.THIN); //左边框线
contentCellStyle.setBorderTop(BorderStyle.THIN); //顶部框线
contentCellStyle.setBorderRight(BorderStyle.THIN); //右边框线
contentCellStyle.setBorderBottom(BorderStyle.THIN); //底部框线
ArrayList<WriteCellStyle> contentCells = new ArrayList<>();
contentCells.add(contentCellStyle);
//样式策略
HorizontalCellStyleStrategy handler = new HorizontalCellStyleStrategy();
handler.setHeadWriteCellStyle(headCellStyle); //表头样式
handler.setContentWriteCellStyleList(contentCells); //内容样式
//合并单元格 最后一行的第一列至导出第三列合并
OnceAbsoluteMergeStrategy onceAbsoluteMergeStrategy = new OnceAbsoluteMergeStrategy(new OnceAbsoluteMergeProperty(dataList.size() + 1, dataList.size() + 1, 0, headMap.size() - 4));
EasyExcel.write("")
.registerWriteHandler(handler)
.registerWriteHandler(onceAbsoluteMergeStrategy)
.head(headers) //动态表头 List<List<String>> 最外层为每一列,里面为每列的每一行
.automaticMergeHead(true) //表头自动合并
.doWrite(dataList);
} catch (Exception e) {
e.printStackTrace();
}
}