哈士奇发布数据导出Excel功能

1、知识概要

一开始，对于数据的导入导出功能，首先使用poi依赖包进行Excel的导入导出，到后来使用的是easy-excel依赖包。依赖网上都有，这里就不找出来了，这里具体介绍后者的使用。

2、步骤流程

最开始，肯定是要创建工程，这里不做介绍。

2.1、首先，在pom.xml中导入依赖

<!--easyexcel-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.6</version>
</dependency>

2.2、接着，创建下载文件时的响应头信息配置类

public static void setDownLoadHeader(String filename, HttpServletResponse response) throws UnsupportedEncodingException {
    response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
    response.setCharacterEncoding("utf-8");
    String fName = URLEncoder.encode(filename, "UTF-8").replaceAll("\\+", "%20");
    response.setHeader("Content-disposition", "attachment;filename=" + fName);
}

解释

1-设置响应的Content-Type为"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"，表示服务器将返回的文件是一种Office Open XML格式的电子表格文件。
2-设置响应的字符编码为UTF-8，确保正确处理响应中的文本内容。而后面将空格替换代掉是为了保证传输时的安全，避免因空格或其他引发问题。
3-设置Content-disposition响应头，指示浏览器将响应内容作为附件进行下载，并指定下载时的文件名为编码后的文件名。

2.3、然后，因为是要数据导出，所以可能实体类中有的数据不需要进行导出，所以创建VO

原先的实体类

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExcelVO {

    @ModelProperties("名称")
    private String name;
    @ModelProperties("描述")
    private String description;
    @ModelProperties("状态")
    private String status;
    @ModelProperties("是否已删除")
    @TableLogic
    private Integer isDeleted;
}

根据实体类创建的VO

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExcelVO {

    @ExcelProperty("名称")
    private String name;
    @ExcelProperty("描述")
    private String description;
    @ExcelProperty("状态")
    private String status;
}

2.4、紧接着，创建用于该功能的常量类，避免下次更改时麻烦

/**
 * 设置实体文件名
 */
public static final String EXCEL_FILE_NAME = "实体";
/**
 * 设置实体模块标识
 */
public static final String EXCEL_MODULE_NAME = "实体导出版";
/**
 * excel文件后缀格式标识
 */
public static final String EXCEL_POINT_SUFFIX = ".xlsx"; 

2.5、再然后，创建如果发生异常出错，设置自定义抛出异常

FILE_EXPORT_ERROR(501, "文件导出错误");

2.6、最后，我就不具体写业务接口和业务接口实现层了，直接写在控制层上

@GetMapping("/export")
@ApiOperation(value = "导出文件")
public void export(HttpServletResponse response) {
    try {
        // 设置下载文件的请求头
        WebUtils.setDownLoadHeader(SystemConstants.EXCEL_FILE_NAME + SystemConstants.EXCEL_POINT_SUFFIX, response);
        // 获取将要导出的数据体
        List<Entity> entityList = entityService.list();
        // Entity转换成ExcelEntityVO
        List<ExcelEntityVO> excelEntityVOs = BeanCopyUtils.copyBeanList(entityList, ExcelEntityVO.class);
        // 将数据体写入excel
        EasyExcel.write(response.getOutputStream(), ExcelEntityVO.class)
                .autoCloseStream(Boolean.FALSE).sheet(SystemConstants.EXCEL_MODULE_NAME)
                .doWrite(excelCategoryVOs);
    } catch (Exception e) {
        // 出现异常则响应json
        WebUtils.renderString(response, JSON.toJSONString(ResponseResult.errorResult(AppHttpCodeEnum.FILE_EXPORT_ERROR)));
    }
}

最后这里就是一个简单的Excel导出演示。请放心，这只是一个简单的Excel导出功能实现，后面会慢慢做详细的，谢谢