本篇为,通过easyExcel实现 多种数据类型表格 的导入导出
引入2.2.11版本easyExcel依赖
<font color-“byle”>easyExcel版本不同,converter接口中的方法也不相同,一定要注意版本的使用
<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>2.2.11</version>
</dependency>
当字段中存在布尔类型数据(做数据转换)
- 通过实现
Converter
接口定义转换器
public class StatusConverter implements Converter<Boolean> {private static final String sale = "已售出";private static final String unSale = "未售出";@Overridepublic Class<?> supportJavaTypeKey() {// 实体类中对象属性类型return Integer.class;}@Overridepublic CellDataTypeEnum supportExcelTypeKey() {// Excel中对应的CellData属性类型return CellDataTypeEnum.STRING;}@Overridepublic Boolean convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty,GlobalConfiguration globalConfiguration) {// 从Cell中读取数据String gender = cellData.getStringValue();// 判断Excel中的值,将其转换为预期的数值if (sale.equals(gender)) {return true;} else if (unSale.equals(gender)) {return false;}return null;}@Overridepublic CellData convertToExcelData(Boolean aBoolean, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {// 判断实体类中获取的值,转换为Excel预期的值,并封装为CellData对象if (aBoolean == null) {return new CellData<>("");} else if (aBoolean == true) {return new CellData<>(sale);} else if (aBoolean == false) {return new CellData<>(unSale);}return new CellData<>("");}
}
- 在实体类中通过
@ExcelProperty
注解中的converter
属性来引用
@ExcelProperty(value = "售出状态",converter = StatusConverter.class)private boolean soldStatus;
当字段中存在日期数据类型
有两种处理方法:注解处理,或转换器处理
- 通过
@DateTimeFormat
注解规定变量的格式
@DateTimeFormat("yyyy-MM-dd")@ExcelProperty("售出时间")@JsonFormat(shape = JsonFormat.Shape.STRING, pattern="yyyy-MM-dd")private Date soldTime;
- 在高版本的easyExcel下(3.1.1),可以通过实现
Converter
接口完成
实现后,在converter
属性种引用即可
public class DateTimeConverter implements Converter<Date> {@Overridepublic Class<Date> supportJavaTypeKey() {return Date.class;}@Overridepublic CellDataTypeEnum supportExcelTypeKey() {return CellDataTypeEnum.STRING;}/*** 这里读的时候会调用** @param cellData excel数据 (NotNull)* @param contentProperty excel属性 (Nullable)* @param globalConfiguration 全局配置 (NotNull)* @return 读取到内存中的数据*/@Overridepublic Date convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {DateTimeFormat annotation = contentProperty.getField().getAnnotation(DateTimeFormat.class);String format = Objects.nonNull(annotation) ? annotation.value() : "yyyy-MM-dd HH:mm:ss";SimpleDateFormat sdf = new SimpleDateFormat(format, Locale.getDefault());sdf.setTimeZone(TimeZone.getDefault());Date result = sdf.parse(cellData.getStringValue());return result;}/*** 写的时候会调用** @param value java value (NotNull)* @param contentProperty excel属性 (Nullable)* @param globalConfiguration 全局配置 (NotNull)* @return 写出到excel文件的数据*/@Overridepublic WriteCellData<Date> convertToExcelData(Date value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {DateTimeFormat annotation = contentProperty.getField().getAnnotation(DateTimeFormat.class);String format = Objects.nonNull(annotation) ? annotation.value() : "yyyy-MM-dd HH:mm:ss";SimpleDateFormat sdf = new SimpleDateFormat(format,Locale.getDefault());sdf.setTimeZone(TimeZone.getDefault());String result = sdf.format(value);return new WriteCellData<>(result);}}
需要生成的文件中,某一字段由下拉框决定数据
通过实现SheetWriteHandler
接口定义一个处理器
public class CustomSheetWriteHandler implements SheetWriteHandler {@Overridepublic void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {}/*** 想实现Excel引用其他sheet页数据作为单元格下拉选项值,* 需要重写该方法** @param writeWorkbookHolder* @param writeSheetHolder*/@Overridepublic void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {// 构造样例数据,该数据可根据实际需要,换成业务数据// 实际数据可通过构造方法,get、set方法等由外界传入List<String> selectDataList = new ArrayList<>();selectDataList.add("未售出");// 构造下拉选项单元格列的位置,以及下拉选项可选参数值的map集合// key:下拉选项要放到哪个单元格,比如A列的单元格那就是0,C列的单元格,那就是2// value:key对应的那个单元格下拉列表里的数据项,比如这里就是下拉选项1..100Map<Integer, List<String>> selectParamMap = new HashMap<>();selectParamMap.put(3, selectDataList);// 获取第一个sheet页Sheet sheet = writeSheetHolder.getCachedSheet();// 获取sheet页的数据校验对象DataValidationHelper helper = sheet.getDataValidationHelper();// 获取工作簿对象,用于创建存放下拉数据的字典sheet数据页Workbook workbook = writeWorkbookHolder.getWorkbook();// 迭代索引,用于存放下拉数据的字典sheet数据页命名int index = 1;for (Map.Entry<Integer, List<String>> entry : selectParamMap.entrySet()) {// 设置存放下拉数据的字典sheet,并把这些sheet隐藏掉,这样用户交互更友好String dictSheetName = "dict_hide_sheet" + index;Sheet dictSheet = workbook.createSheet(dictSheetName);// 隐藏字典sheet页workbook.setSheetHidden(index++, true);// 设置下拉列表覆盖的行数,从第一行开始到最后一行,这里注意,Excel行的// 索引是从0开始的,我这边第0行是标题行,第1行开始时数据化,可根据实// 际业务设置真正的数据开始行,如果要设置到最后一行,那么一定注意,// 最后一行的行索引是1048575,千万别写成1048576,不然会导致下拉列表// 失效,出不来CellRangeAddressList infoList = new CellRangeAddressList(1, 1048575, entry.getKey(), entry.getKey());int rowLen = entry.getValue().size();for (int i = 0; i < rowLen; i++) {// 向字典sheet写数据,从第一行开始写,此处可根据自己业务需要,自定// 义从第几行还是写,写的时候注意一下行索引是从0开始的即可dictSheet.createRow(i).createCell(0).setCellValue(entry.getValue().get(i));}// 设置关联数据公式,这个格式跟Excel设置有效性数据的表达式是一样的String refers = dictSheetName + "!$A$1:$A$" + entry.getValue().size();Name name = workbook.createName();name.setNameName(dictSheetName);// 将关联公式和sheet页做关联name.setRefersToFormula(refers);// 将上面设置好的下拉列表字典sheet页和目标sheet关联起来DataValidationConstraint constraint = helper.createFormulaListConstraint(dictSheetName);DataValidation dataValidation = helper.createValidation(constraint, infoList);sheet.addValidationData(dataValidation);}}
}
定义好后,通过 EasyExcel.registerWriteHandler(new CustomSheetWriteHandler())
方法调用
定义表头
使用@ExcelProperty
注解定义表头,同时,有转换器的字段,使用converter
属性,定义转换器
@Data
@TableName("sys_goods")
public class SysGoodsEntity implements Serializable {// TableId 用于指定实体类的某个属性为对应的主键@TableId@ExcelProperty("序号")private int id;@ExcelProperty("商品名")@NotBlank(message="商品名不能为空")private String goodsName;@NotBlank(message="价格不能为空")@ExcelProperty("价格")private int price;@ExcelProperty(value = "售出状态",converter = StatusConverter.class)private boolean soldStatus;@DateTimeFormat("yyyy-MM-dd")@ExcelProperty("售出时间")@JsonFormat(shape = JsonFormat.Shape.STRING, pattern="yyyy-MM-dd")private Date soldTime;@ExcelProperty("买家")private String buyers;
}
在controller层实现导出方法
/*** 以表格文件形式导出故事清单*/@PostMapping("ExportExcel")public R ExportExcel() {//设置文件导出的路径//路径可以通过前端传回数据,动态的设置地址String exportUrl = "D://java/";File file = new File(exportUrl);if (!file.isDirectory()){file.mkdirs();}//设置生成的文件名字String fileName = exportUrl + "Goods" + System.currentTimeMillis() + ".xlsx";// 这里 需要指定写 用哪个class去写,然后写到第一个sheet,名字为商品表 然后文件流会自动关闭List<SysGoodsEntity> data = this.selectAll();EasyExcel.write(fileName, SysGoodsEntity.class).registerWriteHandler(new CustomSheetWriteHandler()).sheet("商品表").doWrite(data);return R.ok();}
在controller层实现导入方法
/*** 导入表格* @param file* @throws IOException*/@PostMapping("ImportExcel")public void ImportExcel(@RequestParam("file") MultipartFile file) throws IOException {List<SysGoodsEntity> list = EasyExcel.read(file.getInputStream()).head(SysGoodsEntity.class).sheet().doReadSync();for (SysGoodsEntity goods : list) {if(goods.getGoodsName()!=null){System.out.println(goods);sysGoodsService.saveGoods(goods);}}}