当前位置: 首页 > 图灵资讯 > 技术篇> SpringCloud微服务实战——搭建企业级开发框架(三十):整合EasyExcel实现数据表格导入导出功能

SpringCloud微服务实战——搭建企业级开发框架(三十):整合EasyExcel实现数据表格导入导出功能

来源:图灵教育
时间:2023-10-20 17:51:47

  批量上传数据导入和数据统计分析导出基本上是系统不可或缺的功能。考虑到性能和易用性,EasyExcel集成在这里。EasyExcel是一个基于Java的简单省内存的Excel读写开源项目,支持Excel读写100M,尽可能节省内存:  Apachee是Java分析和Excel生成的著名框架 poi、jxl。但他们都有一个严重的问题是非常消耗内存,poi有一套SAX模式API可以在一定程度上解决一些内存溢出问题,但POI仍有一些缺陷,如07版Excel解压和解压后存储完成内存,内存消耗仍然很大。easyexcel重写了poi对07版excel的分析,一个3Mexcel使用POI sax分析仍然需要大约100M的内存,easyexcel可以减少到几M,无论excel有多大,都不会有内存溢出;03版本依赖于POI的sax模式,在上层进行模型转换包装,使用户更加简单和方便。

一、引入依赖库

1、修改gitegggg-platform项目-platform-bom工程pom.增加EasyExcelMaven依赖的xml文件。

    <properties>        ...        <!-- Excel 数据导入导出 -->        <easyexcel.version>2.2.10</easyexcel.version>    </properties>   <dependencyManagement>        <dependencies>           ...            <!-- Excel 数据导入导出 -->            <dependency>                <groupId>com.alibaba</groupId>                <artifactId>easyexcel</artifactId>                <version>${easyexcel.version}</version>            </dependency>            ...        </dependencies>    </dependencyManagement>

2、修改gitegg-platform-boot工程pomm.添加EasyExcel依赖的xml文件。考虑到数据导入导出是系统必不可少的功能,所有引用springboot项目的微服务都需要EasyExcel,目前版本的EasyExcel不支持Localdatetetime日期格式,需要自定义Localdatetimeconverter转换器来支持数据导入导出时的Localdatetime。pom.xml文件

    <dependencies>        ...        <!-- Excel 数据导入导出 -->        <dependency>            <groupId>com.alibaba</groupId>            <artifactId>easyexcel</artifactId>        </dependency>    </dependencies>

Localdatetime转换器Localdatetimeconerterterter.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;/** * Localdatestringconerterter自定义 * 用于使用easyexcel导出表格时,默认不支持LocalDateTime日期格式 * * @author GitEgg */public class LocalDateTimeConverter implements Converter<LocalDateTime> {    /**     * 不使用{@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 cellData            excel数据 (NotNull)     * @param contentProperty     excel属性 (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 value               java value (NotNull)     * @param contentProperty     excel属性 (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)));    }}

  编辑完以上依赖和转换器后,点击Platforminstall,将依赖重新安装到本地仓库,然后Giteg-Cloud就可以使用定义依赖和转换器。

二、业务实现及测试

  因为所依赖的库和转换器都放在giteggg里-platform-因此,所有在boot项目下使用的giteggg-platform-boot可以直接使用EasyExcel的相关功能,在Giteg-Cloud项目下重新Reload All Maven Projects。这里是gitegg-code-以generator微服务项目为例,说明数据导入导出的用法。

1、Excel可以根据物理注释读取和生成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;/** * <p> * 上传数据源配置 * </p> * * @author GitEgg * @since 2021-08-18 16:39:49 */@Data@HeadRowHeight(20)@ContentRowHeight(15)@ApiModel(value="DatasorceImport对象", description="导入数据源配置")public class DatasourceImport {    @ApiModelProperty(value = "数据源名称")    @ExcelProperty(value = "数据源名称" ,index = 0)    @ColumnWidth(20)    private String datasourceName;    @ApiModelProperty(value = "连接地址")    @ExcelProperty(value = "连接地址" ,index = 1)    @ColumnWidth(20)    private String url;    @ApiModelProperty(value = "用户名")    @ExcelProperty(value = "用户名" ,index = 2)    @ColumnWidth(20)    private String username;    @ApiModelProperty(value = "密码")    @ExcelProperty(value = "密码" ,index = 3)    @ColumnWidth(20)    private String password;    @ApiModelProperty(value = "数据库驱动")    @ExcelProperty(value = "数据库驱动" ,index = 4)    @ColumnWidth(20)    private String driver;    @ApiModelProperty(value = "数据库类型")    @ExcelProperty(value = "数据库类型" ,index = 5)    @ColumnWidth(20)    private String dbType;    @ApiModelProperty(value = "备注")    @ExcelProperty(value = "备注" ,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;/** * <p> * 下载数据源配置 * </p> * * @author GitEgg * @since 2021-08-18 16:39:49 */@Data@HeadRowHeight(20)@ContentRowHeight(15)@ApiModel(value="DatasourceExport对象", description="导出数据源配置")public class DatasourceExport {    @ApiModelProperty(value = "主键")    @ExcelProperty(value = "序号" ,index = 0)    @ColumnWidth(15)    private Long id;    @ApiModelProperty(value = "数据源名称")    @ExcelProperty(value = "数据源名称" ,index = 1)    @ColumnWidth(20)    private String datasourceName;    @ApiModelProperty(value = "连接地址")    @ExcelProperty(value = "连接地址" ,index = 2)    @ColumnWidth(20)    private String url;    @ApiModelProperty(value = "用户名")    @ExcelProperty(value = "用户名" ,index = 3)    @ColumnWidth(20)    private String username;    @ApiModelProperty(value = "密码")    @ExcelProperty(value = "密码" ,index = 4)    @ColumnWidth(20)    private String password;    @ApiModelProperty(value = "数据库驱动")    @ExcelProperty(value = "数据库驱动" ,index = 5)    @ColumnWidth(20)    private String driver;    @ApiModelProperty(value = "数据库类型")    @ExcelProperty(value = "数据库类型" ,index = 6)    @ColumnWidth(20)    private String dbType;    @ApiModelProperty(value = "备注")    @ExcelProperty(value = "备注" ,index = 7)    @ColumnWidth(20)    private String comments;    @ApiModelProperty(value = "创建日期")    @ExcelProperty(value = "创建日期" ,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<DatasourceDTO> dataSourceList = datasourceService.queryDatasourceList(queryDatasourceDTO);        List<DatasourceExport> 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<DatasourceImport> datasourceImportList =  EasyExcel.read(file.getInputStream(), DatasourceImport.class, null).sheet().doReadSync();        if (!CollectionUtils.isEmpty(datasourceImportList))        {            List<Datasource> 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)  }}// Excelexport导出 function exportBlod (fileName, data) {  const blob = new Blob([data])  const elink = document.createElement('a')  elink.download = fileName  elink.style.display = 'none'  elink.href = 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数据需要在上传前组装。除了上传的文件外,还可以定制到后台的参数。

上传组件

      <a-upload        name="uploadFile"        :show-upload-list="false"        :before-upload="beforeUpload"      >        <a-button> <a-icon type="upload" /> 导入 </a-button>      </a-upload>

上传方法

 beforeUpload (file) {     this.handleUpload(file)     return false }, handleUpload (file) {     this.uploadedFileName = ''     const formData = 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(数据导入失败)     }) },

  在上述步骤中,Excel集成完成,实现了基本的数据导入和导出功能。在业务开发过程中,可以使用复杂的Excel导出,如包含图片和图表的Excel导出。本文需要根据具体的业务需要定制自己的导出方法,并参考Excel的详细用法。