整合EasyExcel实现灵活的导入导出java

• 引入pom依靠
  
• 
  

1.          <dependency>
2.             <groupId>com.alibaba</groupId>
3.             <artifactId>easyexcel</artifactId>
4.         </dependency>

复制代码

• 实现功能
  
  1. 结合Vue前端，实现浏览器页面直接导出日志文件
  2. 实现文件的灵活导入

  复制代码

文件导出
3. 实体类

1. 实体类里有自定义转换器：用于Java类型数据和Excel类型数据的转换，非常使用。结合注解，可以非常方便的进行Excel文件导出。

复制代码

1. /**
2. * <p>
3. * 操作日志信息
4. * </p>
5. *
6. * home.php?mod=space&uid=686208 horse
7. * home.php?mod=space&uid=441028 2020-09-08
8. * 注意: 实体类中如果使用@Accessory（chain=true）,那么导入的数据无法填充到实例中,导出数据不受影响
9. */
10. @Data
11. @EqualsAndHashCode(callSuper = false)
12. @TableName("tb_operational_log")
13. @ApiModel(value = "OperationalLog对象", description = "操作日志信息")
14. public class OperationalLog implements Serializable {
16.     private static final long serialVersionUID = 1L;
18.     @ExcelProperty({"操作日志", "日志ID"})
19.     @ApiModelProperty(value = "日志ID")
20.     @TableId(value = "id", type = IdType.ASSIGN_ID)
21.     private String id;
23.     @ExcelProperty({"操作日志", "操作类型"})
24.     @ApiModelProperty(value = "操作类型")
25.     private String operType;
27.     @ExcelProperty({"操作日志", "操作描述"})
28.     @ApiModelProperty(value = "操作描述")
29.     private String operDesc;
31.     @ExcelProperty({"操作日志", "操作员ID"})
32.     @ApiModelProperty(value = "操作员ID")
33.     private String operUserId;
35.     @ExcelProperty({"操作日志", "操作员名称"})
36.     @ApiModelProperty(value = "操作员名称")
37.     private String operUserName;
39.     @ExcelProperty({"操作日志", "操作方法"})
40.     @ApiModelProperty(value = "操作方法")
41.     private String operMethod;
43.     @ExcelProperty({"操作日志", "请求方法"})
44.     @ApiModelProperty(value = "请求方法")
45.     private String operRequWay;
47.     @ExcelProperty(value = {"操作日志", "请求耗时：单位-ms"}, converter = CustomRequestTimeConverter.class)
48.     @ApiModelProperty(value = "请求耗时：单位-ms")
49.     private Long operRequTime;
51.     @ExcelProperty({"操作日志", "请求参数"})
52.     @ApiModelProperty(value = "请求参数")
53.     private String operRequParams;
55.     @ExcelProperty({"操作日志", "请求Body"})
56.     @ApiModelProperty(value = "请求Body")
57.     private String operRequBody;
59.     @ExcelProperty({"操作日志", "请求IP"})
60.     @ApiModelProperty(value = "请求IP")
61.     private String operRequIp;
63.     @ExcelProperty({"操作日志", "请求URL"})
64.     @ApiModelProperty(value = "请求URL")
65.     private String operRequUrl;
67.     @ExcelProperty(value = {"操作日志", "日志标识"}, converter = CustomLogFlagConverter.class)
68.     @ApiModelProperty(value = "日志标识: 1-admin,0-portal")
69.     private Boolean logFlag;
71.     @ExcelProperty({"操作日志", "操作状态"})
72.     @ApiModelProperty(value = "操作状态:1-成功,0-失败")
73.     @TableField(value = "is_success")
74.     private Boolean success;
76.     @ExcelIgnore
77.     @ApiModelProperty(value = "逻辑删除 1-未删除， 0-删除")
78.     @TableField(value = "is_deleted")
79.     @TableLogic(value = "1", delval = "0")
80.     private Boolean deleted;
82.     @ExcelProperty(value = {"操作日志", "创建时间"}, converter = CustomTimeFormatConverter.class)
83.     @ApiModelProperty(value = "创建时间")
84.     private Date gmtCreate;
85. }

复制代码

• 接口和具体实现
  4.1 接口
  

2.     @OperatingLog(operType = BlogConstants.EXPORT, operDesc = "导出操作日志,写出到响应流中")
3.     @ApiOperation(value = "导出操作日志", hidden = true)
4.     @PostMapping("/oper/export")
5.     public void operLogExport(@RequestBody List<String> logIds, HttpServletResponse response) {
6.         operationalLogService.operLogExport(logIds, response);
7.     }

复制代码

4.2 具体实现

1.     自定义导出策略HorizontalCellStyleStrategy
2.     自定义导出拦截器CellWriteHandler，更加精确的自定义导出策略

复制代码

1.     /**
2.      * 导出操作日志(可以考虑分页导出)
3.      *
4.      * @param logIds
5.      * @param response
6.      */
7.     @Override
8.     public void operLogExport(List<String> logIds, HttpServletResponse response) {
9.         OutputStream outputStream = null;
10.         try {
11.             List<OperationalLog> operationalLogs;
12.             LambdaQueryWrapper<OperationalLog> queryWrapper = new LambdaQueryWrapper<OperationalLog>()
13.                     .orderByDesc(OperationalLog::getGmtCreate);
14.             // 如果logIds不为null,按照id查询信息,否则查询全部
15.             if (!CollectionUtils.isEmpty(logIds)) {
16.                 operationalLogs = this.listByIds(logIds);
17.             } else {
18.                 operationalLogs = this.list(queryWrapper);
19.             }
20.             outputStream = response.getOutputStream();
22.             // 获取单元格样式
23.             HorizontalCellStyleStrategy strategy = MyCellStyleStrategy.getHorizontalCellStyleStrategy();
25.             // 写入响应输出流数据
26.             EasyExcel.write(outputStream, OperationalLog.class).excelType(ExcelTypeEnum.XLSX).sheet("操作信息日志")
27.                     // .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()) // 自适应列宽(不是很适应,效果并不佳)
28.                     .registerWriteHandler(strategy) // 注册上面设置的格式策略
29.                     .registerWriteHandler(new CustomCellWriteHandler()) // 设置自定义格式策略
30.                     .doWrite(operationalLogs);
31.         } catch (Exception e) {
32.             log.error(ExceptionUtils.getMessage(e));
33.             throw new BlogException(ResultCodeEnum.EXCEL_DATA_EXPORT_ERROR);
34.         } finally {
35.             IoUtil.close(outputStream);
36.         }
37.     }

复制代码

自界说导出策略简单如下：

1. /**
2. * @author Mr.Horse
3. * @version 1.0
4. * @description: 单元格样式策略
5. * @date 2021/4/30 8:43
6. */
8. public class MyCellStyleStrategy {
10.     /**
11.      * 设置单元格样式(仅用于测试)
12.      *
13.      * @return 样式策略
14.      */
15.     public static HorizontalCellStyleStrategy getHorizontalCellStyleStrategy() {
16.         // 表头策略
17.         WriteCellStyle headerCellStyle = new WriteCellStyle();
18.         // 表头水平对齐居中
19.         headerCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
20.         // 背景色
21.         headerCellStyle.setFillForegroundColor(IndexedColors.SKY_BLUE.getIndex());
22.         WriteFont headerFont = new WriteFont();
23.         headerFont.setFontHeightInPoints((short) 14);
24.         headerCellStyle.setWriteFont(headerFont);
25.         // 自动换行
26.         headerCellStyle.setWrapped(Boolean.FALSE);
28.         // 内容策略
29.         WriteCellStyle contentCellStyle = new WriteCellStyle();
30.         // 设置数据允许的数据格式,这里49代表所有可以都允许设置
31.         contentCellStyle.setDataFormat((short) 49);
32.         // 设置背景色: 需要指定 FillPatternType 为FillPatternType.SOLID_FOREGROUND 不然无法显示背景颜色.头默认了 FillPatternType所以可以不指定
33.         contentCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);
34.         contentCellStyle.setFillForegroundColor(IndexedColors.GREY_40_PERCENT.getIndex());
35.         // 设置内容靠左对齐
36.         contentCellStyle.setHorizontalAlignment(HorizontalAlignment.LEFT);
37.         // 设置字体
38.         WriteFont contentFont = new WriteFont();
39.         contentFont.setFontHeightInPoints((short) 12);
40.         contentCellStyle.setWriteFont(contentFont);
41.         // 设置自动换行
42.         contentCellStyle.setWrapped(Boolean.FALSE);
43.         // 设置边框样式和颜色
44.         contentCellStyle.setBorderLeft(MEDIUM);
45.         contentCellStyle.setBorderTop(MEDIUM);
46.         contentCellStyle.setBorderRight(MEDIUM);
47.         contentCellStyle.setBorderBottom(MEDIUM);
48.         contentCellStyle.setTopBorderColor(IndexedColors.RED.getIndex());
49.         contentCellStyle.setBottomBorderColor(IndexedColors.GREEN.getIndex());
50.         contentCellStyle.setLeftBorderColor(IndexedColors.YELLOW.getIndex());
51.         contentCellStyle.setRightBorderColor(IndexedColors.ORANGE.getIndex());
53.         // 将格式加入单元格样式策略
54.         return new HorizontalCellStyleStrategy(headerCellStyle, contentCellStyle);
55.     }
56. }

复制代码

自界说导出拦截器简单如下：

1. /**
2. * @author Mr.Horse
3. * @version 1.0
4. * @description 实现CellWriteHandler接口, 实现对单元格样式的精确控制
5. * @date 2021/4/29 21:11
6. */
7. public class CustomCellWriteHandler implements CellWriteHandler {
9.     private static Logger logger = LoggerFactory.getLogger(CustomCellWriteHandler.class);
11.     @Override
12.     public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
13.                                  Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {
15.     }
17.     /**
18.      * 单元格创建之后(没有写入值)
19.      *
20.      * @param writeSheetHolder
21.      * @param writeTableHolder
22.      * @param cell
23.      * @param head
24.      * @param relativeRowIndex
25.      * @param isHead
26.      */
27.     @Override
28.     public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
29.                                 Head head, Integer relativeRowIndex, Boolean isHead) {
31.     }
33.     @Override
34.     public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
35.                                        CellData cellData, Cell cell, Head head, Integer relativeRowIndex,
36.                                        Boolean isHead) {
38.     }
40.     /**
41.      * 单元格处理后(已写入值): 设置第一行第一列的头超链接到EasyExcel的官网(本系统的导出的excel 0,1两行都是头,所以只设置第一行的超链接)
42.      * 这里再进行拦截的单元格样式设置的话,前面该样式将全部失效
43.      *
44.      * @param writeSheetHolder
45.      * @param writeTableHolder
46.      * @param cellDataList
47.      * @param cell
48.      * @param head
49.      * @param relativeRowIndex
50.      * @param isHead
51.      */
52.     @Override
53.     public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
54.                                  List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex,
55.                                  Boolean isHead) {
56.         // 设置超链接
57.         if (isHead && cell.getRowIndex() == 0 && cell.getColumnIndex() == 0) {
58.             logger.info(" ==> 第{}行,第{}列超链接设置完成", cell.getRowIndex(), cell.getColumnIndex());
59.             CreationHelper helper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper();
60.             Hyperlink hyperlink = helper.createHyperlink(HyperlinkType.URL);
61.             hyperlink.setAddress("https://github.com/alibaba/easyexcel");
62.             cell.setHyperlink(hyperlink);
63.         }
64.         // 精确设置单元格格式
65.         boolean bool = isHead && cell.getRowIndex() == 1 &&
66.                 (cell.getStringCellValue().equals("请求参数") || cell.getStringCellValue().equals("请求Body"));
67.         if (bool) {
68.             logger.info("第{}行，第{}列单元格样式设置完成。", cell.getRowIndex(), cell.getColumnIndex());
69.             // 获取工作簿
70.             Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
71.             CellStyle cellStyle = workbook.createCellStyle();
73.             Font cellFont = workbook.createFont();
74.             cellFont.setBold(Boolean.TRUE);
75.             cellFont.setFontHeightInPoints((short) 14);
76.             cellFont.setColor(IndexedColors.SEA_GREEN.getIndex());
77.             cellStyle.setFont(cellFont);
78.             cell.setCellStyle(cellStyle);
79.         }
80.     }
81. }

复制代码

4.3 前端请求

1. 前端在基于Vue+Element的基础上实现了点击导出按钮，在浏览器页面进行下载。

复制代码

1. // 批量导出
2.     batchExport() {
3.       // 遍历获取id集合列表
4.       const logIds = []
5.       this.multipleSelection.forEach(item => {
6.         logIds.push(item.id)
7.       })
8.        // 请求后端接口
9.       axios({
10.         url: this.BASE_API + '/admin/blog/log/oper/export',
11.         method: 'post',
12.         data: logIds,
13.         responseType: 'arraybuffer',
14.         headers: { 'token': getToken() }
15.       }).then(response => {
16.         // type类型可以设置为文本类型，这里是新版excel类型
17.         const blob = new Blob([response.data], { type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=utf-8' })
18.         const pdfUrl = window.URL.createObjectURL(blob)
19.         const fileName = 'HorseBlog操作日志' // 下载文件的名字
20.         // 对于<a>标签，只有 Firefox 和 Chrome（内核）支持 download 属性
21.         if ('download' in document.createElement('a')) {
22.           const link = document.createElement('a')
23.           link.href = pdfUrl
24.           link.setAttribute('download', fileName)
25.           document.body.appendChild(link)
26.           link.click()
27.           window.URL.revokeObjectURL(pdfUrl) // 释放URL 对象
28.         } else {
29.           // IE 浏览器兼容方法
30.           window.navigator.msSaveBlob(blob, fileName)
31.         }
32.       })
33.     }

复制代码

测试结果：还行，基本实现了页面下载的功能
Excel文件导入
5. 文件读取配置

1. 本配置基于泛型的方式编写，可扩展性较强。

复制代码

1. /**
2. * @author Mr.Horse
3. * @version 1.0
4. * @description: EasyExcel文件读取配置(不能让spring管理)
5. * @date 2021/4/27 13:24
6. */
8. public class MyExcelImportConfig<T> extends AnalysisEventListener<T> {
10.     private static Logger logger = LoggerFactory.getLogger(MyExcelImportConfig.class);
12.     /**
13.      * 每次读取的最大数据条数
14.      */
15.     private static final int MAX_BATCH_COUNT = 10;
17.     /**
18.      * 泛型bean属性
19.      */
20.     private T dynamicService;
22.     /**
23.      * 可接收任何参数的泛型List集合
24.      */
25.     List<T> list = new ArrayList<>();
27.     /**
28.      * 构造函数注入bean(根据传入的bean动态注入)
29.      *
30.      * @param dynamicService
31.      */
32.     public MyExcelImportConfig(T dynamicService) {
33.         this.dynamicService = dynamicService;
34.     }
36.     /**
37.      * 解析每条数据都进行调用
38.      *
39.      * @param data
40.      * @param context
41.      */
42.     @Override
43.     public void invoke(T data, AnalysisContext context) {
44.         logger.info(" ==> 解析一条数据: {}", JacksonUtils.objToString(data));
45.         list.add(data);
46.         if (list.size() > MAX_BATCH_COUNT) {
47.             // 保存数据
48.             saveData();
49.             // 清空list
50.             list.clear();
51.         }
52.     }
54.     /**
55.      * 所有数据解析完成后,会来调用一次
56.      * 作用: 避免最后集合中小于 MAX_BATCH_COUNT 条的数据没有被保存
57.      *
58.      * @param context
59.      */
60.     @Override
61.     public void doAfterAllAnalysed(AnalysisContext context) {
62.         saveData();
63.         logger.info(" ==> 数据解析完成 <==");
64.     }
66.     /**
67.      * 保存数据: 正式应该插入数据库,这里用于测试
68.      */
69.     private void saveData() {
70.         logger.info(" ==> 数据保存开始: {}", list.size());
71.         list.forEach(System.out::println);
72.         logger.info(" ==> 数据保存结束 <==");
73.     }
75.     /**
76.      * 在转换异常 获取其他异常下会调用本接口。我们如果捕捉并手动抛出异常则停止读取。如果这里不抛出异常则 继续读取下一行。
77.      *
78.      * @param exception
79.      * @param context
80.      * @throws Exception
81.      */
82.     @Override
83.     public void onException(Exception exception, AnalysisContext context) throws Exception {
84.         logger.error(" ==> 数据解析失败,但是继续读取下一行:{}", exception.getMessage());
85.         //  如果是某一个单元格的转换异常 能获取到具体行号
86.         if (exception instanceof ExcelDataConvertException) {
87.             ExcelDataConvertException convertException = (ExcelDataConvertException) exception;
88.             logger.error("第{}行，第{}列数据解析异常", convertException.getRowIndex(), convertException.getColumnIndex());
89.         }
90.     }
92. }

复制代码

• 读取测试
  

1.     @ApiOperation(value = "数据导入测试", notes = "操作日志导入测试[OperationalLog]", hidden = true)
2.     @PostMapping("/import")
3.     public R excelImport(@RequestParam("file") MultipartFile file) throws IOException {
4.         EasyExcel.read(file.getInputStream(), OperationalLog.class, new MyExcelImportConfig<>(operationalLogService))
5.                 .sheet().doRead();
6.         return R.ok().message("文件导入成功");
7.     }

复制代码

• 附上自界说属性转换器
  转换器的属性内容转换，需要根据自己的实际业务需求而定，这里仅作为简单示例
  

1. /**
2. * @author Mr.Horse
3. * @version 1.0
4. * @description: 自定义excel转换器: 将操作日志的请求耗时加上单位 "ms"
5. * @date 2021/4/27 10:25
6. */
8. public class CustomRequestTimeConverter implements Converter<Long> {
10.     /**
11.      * 读取数据时: 属性对应的java数据类型
12.      *
13.      * @return
14.      */
15.     @Override
16.     public Class<Long> supportJavaTypeKey() {
17.         return Long.class;
18.     }
20.     /**
21.      * 写入数据时: excel内部的数据类型,因为请求耗时是long类型,对应excel是NUMBER类型,但是加上"ms后对应的是STRING类型"
22.      *
23.      * @return
24.      */
25.     @Override
26.     public CellDataTypeEnum supportExcelTypeKey() {
27.         return CellDataTypeEnum.STRING;
28.     }
30.     /**
31.      * 读取回调
32.      *
33.      * @param cellData
34.      * @param contentProperty
35.      * @param globalConfiguration
36.      * @return
37.      * @throws Exception
38.      */
39.     @Override
40.     public Long convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
41.         // 截取字符串: "ms",转换为long类型
42.         String value = cellData.getStringValue();
43.         return Long.valueOf(value.substring(0, value.length() - 2));
44.     }
46.     @Override
47.     public CellData<Long> convertToExcelData(Long value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
48.         // 添加字符串: "ms"
49.         return new CellData<>(String.valueOf(value).concat("ms"));
50.     }
51. }

复制代码

格式化时间

1. /**
2. * @author Mr.Horse
3. * @version 1.0
4. * @description: {description}
5. * @date 2021/4/27 14:01
6. */
8. public class CustomTimeFormatConverter implements Converter<Date> {
10.     @Override
11.     public Class<Date> supportJavaTypeKey() {
12.         return Date.class;
13.     }
15.     @Override
16.     public CellDataTypeEnum supportExcelTypeKey() {
17.         return CellDataTypeEnum.STRING;
18.     }
20.     @Override
21.     public Date convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
22.         String value = cellData.getStringValue();
23.         return DateUtil.parse(value, DatePattern.NORM_DATETIME_PATTERN);
24.     }
26.     @Override
27.     public CellData<Date> convertToExcelData(Date value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
28.         return new CellData<>(DateUtil.format(value, DatePattern.NORM_DATETIME_PATTERN));
29.     }
30. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。