SpringCloud微服务实战——搭建企业级开发框架（三十）（整合EasyExcel实现数据表格导入导出功能）
??批量上传数据导入、数据统计分析导出，已经基本是系统必不可缺的一项功能，这里从性能和易用性方面考虑，集成EasyExcel。EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目，在尽可能节约内存的情况下支持读写百M的Excel：
??Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便。(https://github.com/alibaba/easyexcel/)
一、引入依赖的库
1、在GitEgg-Platform项目中修改gitegg-platform-bom工程的pom.xml文件，增加EasyExcel的Maven依赖。
......2.2.10
......
com.alibaba
easyexcel
${easyexcel.version}
......
2、修改gitegg-platform-boot工程的pom.xml文件，添加EasyExcel依赖。这里考虑到数据导入导出是系统必备功能，所有引用springboot工程的微服务都需要用到EasyExcel，并且目前版本EasyExcel不支持LocalDateTime日期格式，这里需要自定义LocalDateTimeConverter转换器，用于在数据导入导出时支持LocalDateTime。
pom.xml文件
......
com.alibaba
easyexcel
自定义LocalDateTime转换器LocalDateTimeConverter.java
package com.gitegg.platform.boot.excel;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Objects;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
/**
* 自定义LocalDateStringConverter
* 用于解决使用easyexcel导出表格时候，默认不支持LocalDateTime日期格式
*
* @author GitEgg
*/public class LocalDateTimeConverter implements Converter {/**
* 不使用{@code @DateTimeFormat}注解指定日期格式时,默认会使用该格式.
*/
private static final String DEFAULT_PATTERN = "yyyy-MM-dd HH:mm:ss";
@Override
public Class supportJavaTypeKey() {
return LocalDateTime.class;
}@Override
public CellDataTypeEnum supportExcelTypeKey() {
return CellDataTypeEnum.STRING;
}/**
* 这里读的时候会调用
*
* @param cellDataexcel数据 (NotNull)
* @param contentPropertyexcel属性 (Nullable)
* @param globalConfiguration 全局配置 (NotNull)
* @return 读取到内存中的数据
*/
@Override
public LocalDateTime convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
DateTimeFormat annotation = contentProperty.getField().getAnnotation(DateTimeFormat.class);
return LocalDateTime.parse(cellData.getStringValue(),
DateTimeFormatter.ofPattern(Objects.nonNull(annotation) ? annotation.value() : DEFAULT_PATTERN));
}/**
* 写的时候会调用
*
* @param valuejava value (NotNull)
* @param contentPropertyexcel属性 (Nullable)
* @param globalConfiguration 全局配置 (NotNull)
* @return 写出到excel文件的数据
*/
@Override
public CellData convertToExcelData(LocalDateTime value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
DateTimeFormat annotation = contentProperty.getField().getAnnotation(DateTimeFormat.class);
return new CellData(value.format(DateTimeFormatter.ofPattern(Objects.nonNull(annotation) ? annotation.value() : DEFAULT_PATTERN)));
}
}
以上依赖及转换器编辑好之后，点击Platform的install，将依赖重新安装到本地库，然后GitEgg-Cloud就可以使用定义的依赖和转换器了。
二、业务实现及测试 因为依赖的库及转换器都是放到gitegg-platform-boot工程下的，所以，所有使用到gitegg-platform-boot的都可以直接使用EasyExcel的相关功能，在GitEgg-Cloud项目下重新Reload All Maven Projects。这里以gitegg-code-generator微服务项目举例说明数据导入导出的用法。
1、EasyExcel可以根据实体类的注解来进行Excel的读取和生成，在entity目录下新建数据导入和导出的实体类模板文件。
文件导入的实体类模板DatasourceImport.java
package com.gitegg.code.generator.datasource.entity;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
* * 数据源配置上传
*
*
* @author GitEgg
* @since 2021-08-18 16:39:49
*/
@Data
@HeadRowHeight(20)
@ContentRowHeight(15)
@ApiModel(value="https://www.it610.com/article/DatasourceImport对象", description="数据源配置导入")
public class DatasourceImport {@ApiModelProperty(value = "https://www.it610.com/article/数据源名称")
@ExcelProperty(value = "https://www.it610.com/article/数据源名称" ,index = 0)
@ColumnWidth(20)
private String datasourceName;
@ApiModelProperty(value = "https://www.it610.com/article/连接地址")
@ExcelProperty(value = "https://www.it610.com/article/连接地址" ,index = 1)
@ColumnWidth(20)
private String url;
@ApiModelProperty(value = "https://www.it610.com/article/用户名")
@ExcelProperty(value = "https://www.it610.com/article/用户名" ,index = 2)
@ColumnWidth(20)
private String username;
@ApiModelProperty(value = "https://www.it610.com/article/密码")
@ExcelProperty(value = "https://www.it610.com/article/密码" ,index = 3)
@ColumnWidth(20)
private String password;
@ApiModelProperty(value = "https://www.it610.com/article/数据库驱动")
@ExcelProperty(value = "https://www.it610.com/article/数据库驱动" ,index = 4)
@ColumnWidth(20)
private String driver;
@ApiModelProperty(value = "https://www.it610.com/article/数据库类型")
@ExcelProperty(value = "https://www.it610.com/article/数据库类型" ,index = 5)
@ColumnWidth(20)
private String dbType;
@ApiModelProperty(value = "https://www.it610.com/article/备注")
@ExcelProperty(value = "https://www.it610.com/article/备注" ,index = 6)
@ColumnWidth(20)
private String comments;
}文件导出的实体类模板DatasourceExport.java
package com.gitegg.code.generator.datasource.entity;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.gitegg.platform.boot.excel.LocalDateTimeConverter;
import lombok.Data;
import java.time.LocalDateTime;
/**
* * 数据源配置下载
*
*
* @author GitEgg
* @since 2021-08-18 16:39:49
*/
@Data
@HeadRowHeight(20)
@ContentRowHeight(15)
@ApiModel(value="https://www.it610.com/article/DatasourceExport对象", description="数据源配置导出")
public class DatasourceExport {@ApiModelProperty(value = "https://www.it610.com/article/主键")
@ExcelProperty(value = "https://www.it610.com/article/序号" ,index = 0)
@ColumnWidth(15)
private Long id;
@ApiModelProperty(value = "https://www.it610.com/article/数据源名称")
@ExcelProperty(value = "https://www.it610.com/article/数据源名称" ,index = 1)
@ColumnWidth(20)
private String datasourceName;
@ApiModelProperty(value = "https://www.it610.com/article/连接地址")
@ExcelProperty(value = "https://www.it610.com/article/连接地址" ,index = 2)
@ColumnWidth(20)
private String url;
@ApiModelProperty(value = "https://www.it610.com/article/用户名")
@ExcelProperty(value = "https://www.it610.com/article/用户名" ,index = 3)
@ColumnWidth(20)
private String username;
@ApiModelProperty(value = "https://www.it610.com/article/密码")
@ExcelProperty(value = "https://www.it610.com/article/密码" ,index = 4)
@ColumnWidth(20)
private String password;
@ApiModelProperty(value = "https://www.it610.com/article/数据库驱动")
@ExcelProperty(value = "https://www.it610.com/article/数据库驱动" ,index = 5)
@ColumnWidth(20)
private String driver;
@ApiModelProperty(value = "https://www.it610.com/article/数据库类型")
@ExcelProperty(value = "https://www.it610.com/article/数据库类型" ,index = 6)
@ColumnWidth(20)
private String dbType;
@ApiModelProperty(value = "https://www.it610.com/article/备注")
@ExcelProperty(value = "https://www.it610.com/article/备注" ,index = 7)
@ColumnWidth(20)
private String comments;
@ApiModelProperty(value = "https://www.it610.com/article/创建日期")
@ExcelProperty(value = "https://www.it610.com/article/创建日期" ,index = 8, converter = LocalDateTimeConverter.class)
@ColumnWidth(22)
@DateTimeFormat("yyyy-MM-dd HH:mm:ss")
private LocalDateTime createTime;
}2、在DatasourceController中新建上传和下载方法：
/**
* 批量导出数据
* @param response
* @param queryDatasourceDTO
* @throws IOException
*/
@GetMapping("/download")
public void download(HttpServletResponse response, QueryDatasourceDTO queryDatasourceDTO) throws IOException {
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode("数据源列表", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;
filename*=utf-8''" + fileName + ".xlsx");
List dataSourceList = datasourceService.queryDatasourceList(queryDatasourceDTO);
List dataSourceExportList = new ArrayList<>();
for (DatasourceDTO datasourceDTO : dataSourceList) {
DatasourceExport dataSourceExport = BeanCopierUtils.copyByClass(datasourceDTO, DatasourceExport.class);
dataSourceExportList.add(dataSourceExport);
}
String sheetName = "数据源列表";
EasyExcel.write(response.getOutputStream(), DatasourceExport.class).sheet(sheetName).doWrite(dataSourceExportList);
}/**
* 下载导入模板
* @param response
* @throws IOException
*/
@GetMapping("/download/template")
public void downloadTemplate(HttpServletResponse response) throws IOException {
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode("数据源导入模板", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;
filename*=utf-8''" + fileName + ".xlsx");
String sheetName = "数据源列表";
EasyExcel.write(response.getOutputStream(), DatasourceImport.class).sheet(sheetName).doWrite(null);
}/**
* 上传数据
* @param file
* @return
* @throws IOException
*/
@PostMapping("/upload")
public Result upload(@RequestParam("uploadFile") MultipartFile file) throws IOException {
List datasourceImportList =EasyExcel.read(file.getInputStream(), DatasourceImport.class, null).sheet().doReadSync();
if (!CollectionUtils.isEmpty(datasourceImportList))
{
List datasourceList = new ArrayList<>();
datasourceImportList.stream().forEach(datasourceImport-> {
datasourceList.add(BeanCopierUtils.copyByClass(datasourceImport, Datasource.class));
});
datasourceService.saveBatch(datasourceList);
}
return Result.success();
}
3、前端导出（下载）设置，我们前端框架请求用的是axios，正常情况下，普通的请求成功或失败返回的responseType为json格式，当我们下载文件时，请求返回的是文件流，这里需要设置下载请求的responseType为blob。考虑到下载是一个通用的功能，这里提取出下载方法为一个公共方法：首先是判断服务端的返回格式，当一个下载请求返回的是json格式时，那么说明这个请求失败，需要处理错误新题并提示，如果不是，那么走正常的文件流下载流程。
api请求
//请求的responseType设置为blob格式
export function downloadDatasourceList (query) {
return request({
url: '/gitegg-plugin-code/code/generator/datasource/download',
method: 'get',
responseType: 'blob',
params: query
})
}
导出/下载的公共方法
// 处理请求返回信息
export function handleDownloadBlod (fileName, response) {
const res = response.data
if (res.type === 'application/json') {
const reader = new FileReader()
reader.readAsText(response.data, 'utf-8')
reader.onload = function () {
const { msg } = JSON.parse(reader.result)
notification.error({
message: '下载失败',
description: msg
})
}
} else {
exportBlod(fileName, res)
}
}// 导出Excel
export function exportBlod (fileName, data) {
const blob = new Blob([data])
const elink = document.createElement('a')
elink.download = fileName
elink.style.display = 'none'
elink.href = https://www.it610.com/article/URL.createObjectURL(blob)
document.body.appendChild(elink)
elink.click()
URL.revokeObjectURL(elink.href)
document.body.removeChild(elink)
}vue页面调用
handleDownload () {
this.downloadLoading = true
downloadDatasourceList(this.listQuery).then(response => {
handleDownloadBlod('数据源配置列表.xlsx', response)
this.listLoading = false
})
},
4、前端导入(上传的设置)，前端无论是Ant Design of Vue框架还是ElementUI框架都提供了上传组件，用法都是一样的，在上传之前需要组装FormData数据，除了上传的文件，还可以自定义传到后台的参数。
【SpringCloud微服务实战——搭建企业级开发框架（三十）（整合EasyExcel实现数据表格导入导出功能）】上传组件
导入 上传方法
beforeUpload (file) {
this.handleUpload(file)
return false
},
handleUpload (file) {
this.uploadedFileName = ''
const formData = https://www.it610.com/article/new FormData()
formData.append('uploadFile', file)
this.uploading = true
uploadDatasource(formData).then(() => {
this.uploading = false
this.$message.success('数据导入成功')
this.handleFilter()
}).catch(err => {
console.log('uploading', err)
this.$message.error('数据导入失败')
})
},
以上步骤，就把EasyExcel整合完成，基本的数据导入导出功能已经实现，在业务开发过程中，可能会用到复杂的Excel导出，比如包含图片、图表等的Excel导出，这一块需要根据具体业务需要，参考EasyExcel的详细用法来定制自己的导出方法。
源码地址: Gitee: https://gitee.com/wmz1930/GitEgg
GitHub: https://github.com/wmz1930/GitEgg
推荐阅读
- 基于微信小程序带后端ssm接口小区物业管理平台设计
- CET4听力微技能一
- 微习惯复盘
- 社保代缴公司服务费包含哪些
- 员工的微信朋友圈是公司的宣传阵地吗（）
- 私有化轻量级持续集成部署方案--03-部署web服务（下）
- FBI怎么和恐怖分子谈判
- 探索免费开源服务器tomcat的魅力
- 微雨中的东湖
- 小醉微记|小醉微记|心不安处皆动荡