Springboot采用EasyPoi采用前后端分离导出Excel并返回前端Blob

实现思路

1. 封装excel的工具类，采用EasyPoi,简单，快速；
2. 编写PO对象，采用@Excel注解增加注释；
3. 查询数据，并将数据封闭至PO对象中；
4. 通过工具类将对象通过BLOB格式返回给前端；
5. 前端通过工具类下载该EXCEL;

引依赖

<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-base</artifactId>
    <version>4.2.0</version>
</dependency>
    <dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-web</artifactId>
    <version>4.2.0</version>
</dependency>
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-annotation</artifactId>
    <version>4.2.0</version>
</dependency>

写工具类ExcelUtil

package test.common.util;

import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;

/**
 * Excel导入导出工具类
 * @author pangu
 */
public class ExcelUtil {

    /**
     * 导出工具类
     * @param list
     * @param title
     * @param sheetName
     * @param pojoClass
     * @param fileName
     * @param isCreateHeader
     * @param response
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,
                                   String fileName, boolean isCreateHeader, HttpServletResponse response){
        ExportParams exportParams = new ExportParams(title, sheetName);
        exportParams.setCreateHeadRows(isCreateHeader);
        defaultExport(list, pojoClass, fileName, response, exportParams);
    }

    /**
     * 导出工具类
     * @param list
     * @param title
     * @param sheetName
     * @param pojoClass
     * @param fileName
     * @param response
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName,
                                   HttpServletResponse response){
        defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
    }

    public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response){
        defaultExport(list, fileName, response);
    }

    private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName,
                                      HttpServletResponse response, ExportParams exportParams) {
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams,pojoClass,list);
        if (workbook != null); downLoadExcel(fileName, response, workbook);
    }

    private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
        try {
            response.setCharacterEncoding("UTF-8");
            response.setHeader("content-Type", "application/vnd.ms-excel");
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
            workbook.write(response.getOutputStream());
        } catch (IOException e) {
            //throw new NormalException(e.getMessage());
        }
    }

    private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
        if (workbook != null);
        downLoadExcel(fileName, response, workbook);
    }

    public static <T> List<T> importExcel(String filePath,Integer titleRows,Integer headerRows, Class<T> pojoClass){
        if (StringUtils.isBlank(filePath)){
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
        }catch (NoSuchElementException e){
            //throw new NormalException("模板不能为空");
        } catch (Exception e) {
            e.printStackTrace();
            //throw new NormalException(e.getMessage());
        } return list;
    }

    public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass){
        if (file == null){ return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
        }catch (NoSuchElementException e){
            // throw new NormalException("excel文件不能为空");
        } catch (Exception e) {
            //throw new NormalException(e.getMessage());
            System.out.println(e.getMessage());
        }
        return list;
    }

}

写PO对象

package com.test.order.api.dto;

import cn.afterturn.easypoi.excel.annotation.Excel;
import io.swagger.annotations.ApiModel;
import lombok.Data;

import java.io.Serializable;

/**
 * @Author 
 * @Date 2021/2/18
 * @Version 1.0
 */
@ApiModel(value = "OrderPOI", description = "返回给前端的Excel表头")
@Data
public class OrderPOI implements Serializable {

    private static final long serialVersionUID = 5758487990585198585L;

    @Excel(name = "订单编号", orderNum = "0", width = 30, isImportField = "true_st")
    private String orderCode;
    @Excel(name = "订单名称", orderNum = "1", width = 30, isImportField = "true_st")
    private String remarks;
    @Excel(name = "订单金额", orderNum = "2", width = 30, isImportField = "true_st")
    private Double totalPrice;
    @Excel(name = "用户名", orderNum = "3", width = 30, isImportField = "true_st")
    private String userName;
    @Excel(name = "手机号", orderNum = "4", width = 30, isImportField = "true_st")
    private String phone;
    @Excel(name = "支付方式", orderNum = "5", width = 30, isImportField = "true_st")
    private String payType;
    @Excel(name = "下单时间", orderNum = "6", width = 30, isImportField = "true_st")
    private String createTime;
    @Excel(name = "订单状态", orderNum = "7", width = 30, isImportField = "true_st")
    private String status;
    @Excel(name = "交易号", orderNum = "8", width = 30, isImportField = "true_st")
    private String code;
    @Excel(name = "实收金额", orderNum = "9", width = 30, isImportField = "true_st")
    private Double payPrice;

}

通过工具类的方法将数据导出成BLOB格式，样例

@ApiOperation(value = "后台-导出订单列表")
@GetMapping("/export-order")
public void export(@ApiIgnore HttpServletResponse response, String[] orderCodes) {
    try {
        List<OrderPOI> orderPOIS = orderService.export(orderCodes);
        // 使用工具类导出excel
        ExcelUtil.exportExcel(orderPOIS, null, "订单", OrderPOI.class, "order", response);
    } catch (Exception e) {
        System.out.println(e);
        LogManager.error(e);
    }
}

前端接受数据

  handleExport(){
	exportRole().then(response => {
	  downloadFile(response, "order", 'xlsx')
	})
  }

// 下载文件
export function downloadFile(obj, name, suffix) {
  const url = window.URL.createObjectURL(new Blob([obj]))
  const link = document.createElement('a')
  link.style.display = 'none'
  link.href = url
  const fileName = parseTime(new Date()) + '-' + name + '.' + suffix
  link.setAttribute('download', fileName)
  document.body.appendChild(link)
  link.click()
  document.body.removeChild(link)
}