SpringBoot生成Excel文件并下载到浏览器

前言

今天又接到了如题的需求，突然脑子一抽不记得这个逻辑是怎么样的了，正好理一理。

分析业务

如何实现下载

先通过DAO得到一个List对象，然后将改List对象的数据写入到WorkBook里面，再将该WorkBook写出成一个Excel文件，再让用户下载该文件即可。大致流程如下

工具类及实现方法

导出

将得到的List生成Excel文件可以看下面这篇：Java导出数据库到Excel文件

导出工具类

具体的使用如果不太清楚的话，上面的链接里有测试类可以参考

import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import java.io.*;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.text.SimpleDateFormat;
import java.util.*;

/**
 * @author 三文鱼先生
 * @title
 * @description 用于导出数据
 * @date 2022/8/23
 **/
public class ExcelExportUtil {

    /**
     * @description 考虑到下载方式的不同 这里细化成只获取一个workBook 格式为默认 无格式
     * @author 三文鱼先生
     * @date 10:47 2022/8/26
     * @param list 需要存储为excel的对象集合
     * @param map 键值对映射 属性 - 表头字段  类似于: name - 姓名
     * @param type 生成workbook的类型
     * @param tableName 生成Sheet的名称
     * @param orderList 表头顺序对应的属性list
     * @return org.apache.poi.ss.usermodel.Workbook
     **/
    public static <T>Workbook createWorkbook(
                               List<T> list , //数据库查询的返回List
                               Map<String , String> map , //表头映射
                               Integer type , //生成workbook的类型 0 - xls 其他-xlsx
                               String tableName , //表名
                               List<String> orderList //排序的List 为空 则使用默认的顺序
    ) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException, InstantiationException {
        //工作簿
        Workbook workbook = getWorkbookByType(type);
        //单个表
        Sheet sheet = workbook.createSheet(tableName);

        //orderList 表头顺序，可以为空
        if(orderList == null || orderList.size() == 0) {
            orderList = new ArrayList<>();
            //获取map映射的顺序
            for (Map.Entry<String, String> mapEntry : map.entrySet()) {
                orderList.add(mapEntry.getKey());
            }
        }
        //每列对应的属性参数
        List<Class> typeClassList = getParamsType(list.get(0).getClass(), orderList);

        //设置表头的值
        Row headRow = sheet.createRow(0);
        for (int i = 0; i < orderList.size(); i++) {
            Cell cell = headRow.createCell(i);
            //设置单元格的属性
            cell.setCellType(CellType.STRING);
            cell.setCellValue(map.get(orderList.get(i)));
        }

        int index = 1;
        //单元行
        Row dataRow = null;
        //单元格
        Cell dataCell = null;
        //遍历List
        for (T t : list) {
            //获取一行
            dataRow = sheet.createRow(index);
            //遍历表头对应属性，给一行数据设置值
            for (int j = 0; j < orderList.size(); j++) {
                //获取一个单元格
                dataCell = dataRow.createCell(j);
                //根据对应列的属性 设置对应的值类型及值
                setCellValueTypeAndValue(dataCell , typeClassList.get(j) ,
                        t.getClass().getMethod(getGetterMethodName(orderList.get(j)) , new Class[]{})
                        .invoke(t , new Class[]{}));
            }
            //行下标后移
            index++;
        }
        //设置值
        return workbook;
    }

    /**
     * @description  存储到对应的文件夹下
     * @author 三文鱼先生
     * @date 10:44 2022/8/26
     * @param path 文件夹路径
     * @param workbook 存储的工作簿对象
     * @param type 存储的类型
     * @return void
     **/
    public static String store(String path , Workbook workbook , Integer type) throws IOException {
        path = path +File.separator +getNowDate()+ workbook.getSheetName(0) + getExtensionByType(type);
        try(OutputStream outputStream = new FileOutputStream(new File(path))){
            workbook.write(outputStream);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }catch (Exception e) {
            e.printStackTrace();
        } finally {
            workbook.close();
        }
        return path;
    }

    /**
     * @description 根据type获取对应文件后缀 0-xls 其他xlsx 默认为xls
     * @author 三文鱼先生
     * @date 10:43 2022/8/26
     * @param type 类型
     * @return java.lang.String
     **/
    public static String getExtensionByType(Integer type) {
        if(type == null || type == 0)
            return ".xls";
        else
            return ".xlsx";
    }

    /**
     * @description 根据所给的type获取对应的工作簿 0-HSSFWorkbook 其他-XSSFWorkbook
     * @author 三文鱼先生
     * @date 10:41 2022/8/26
     * @param type 类型
     * @return org.apache.poi.ss.usermodel.Workbook
     **/
    public static Workbook getWorkbookByType(Integer type) {
        if(type == null || type == 0)
            return new HSSFWorkbook();
        else
            return new XSSFWorkbook();
    }

    /**
     * @description 根据属性名称获取对应的get方法
     * @author 三文鱼先生
     * @date 10:38 2022/8/26
     * @param param 属性名称
     * @return java.lang.String
     **/
    public static String getGetterMethodName(String param) {
        char[] chars = param.toCharArray();
        //首字母大写
        if(Character.isLowerCase(chars[0])) {
            chars[0] -= 32;
        }
        //拼接get方法
        return "get" + new String(chars);
    }

    /**
     * @description 根据属性的List获取对应的类型List
     * @author 三文鱼先生
     * @date 10:37 2022/8/26
     * @param cs 对应的类
     * @param paramsList 对应的属性list
     * @return java.util.List<java.lang.Class>
     **/
    public static List<Class> getParamsType(Class cs , List<String> paramsList) {
        List<Class> typeClass = new ArrayList<>();
        //对象的所有属性
        Field[] fields = cs.getDeclaredFields();
        //临时的属性 - 类型映射
        Map<String , Class> map = new HashMap();
        //获取属性名称及类型
        for (Field field : fields) {
            map.put(field.getName(), field.getType());
        }
        //遍历属性List获取对应的类型List
        for (String s : paramsList) {
            typeClass.add(map.get(s));
        }
        return typeClass;
    }

    /**
     * @description 根据对应的类型 给单元格设置类型和值
     * @author 三文鱼先生
     * @date 10:32 2022/8/26
     * @param cell 单元格
     * @param cs 属性的类型
     * @param o get方法获取到的对象
     * @return void
     **/
    public static  void setCellValueTypeAndValue(Cell cell , Class cs , Object o) {
    //这里没有日期类型 需要的自己加就行了
        if(Boolean.class.equals(cs) || boolean.class.equals(cs)) {
            //boolean类型
            cell.setCellType(CellType.BOOLEAN);
            cell.setCellValue((Boolean) o);
        } else if (
                int.class.equals(cs) ||
                Integer.class.equals(cs)
        ) {
            //int类型
            cell.setCellType(CellType.NUMERIC);
            cell.setCellValue((Integer) o);
        } else if(
                double.class.equals(cs)||
                Double.class.equals(cs)
        ) {
            //浮点数类型 也可以是float类型什么的
            cell.setCellType(CellType.NUMERIC);
            cell.setCellValue((Double) o);
        } else {
            //默认为字符串类型
            cell.setCellType(CellType.STRING);
            cell.setCellValue((String) o);
        }
    }

    /**
     * @description 获取当前时间的字符串
     * @author 三文鱼先生
     * @date 17:06 2022/8/26
     * @return java.lang.String
     **/
    public static String getNowDate() {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMdd-HHmmss");
        return simpleDateFormat.format(new Date());
    }
}

下载

下载的话看这篇：记SpringBoot下载的两种方式

以请求方式下载

public synchronized void downloadFile(String path , HttpServletResponse response) throws Exception {
        //确保下载路径包含download关键字（确保下载内容，在download文件夹下）
        if(path.contains("download")) {
            File file = new File(path);
            String filename = file.getName();
            //获取文件后缀
            String extension = getNameOrExtension(filename , 1);
            //设置响应的信息
            response.reset();
            response.setCharacterEncoding("UTF-8");
            response.setHeader("Content-Disposition", "attachment;filename=" +  URLEncoder.encode(filename, "utf8"));
            response.setHeader("Pragma", "no-cache");
            response.setHeader("Cache-Control", "no-cache");
            //设置浏览器接受类型为流
            response.setContentType("application/octet-stream;charset=UTF-8");

            try(
                    FileInputStream in = new FileInputStream(file);
            ) {
                // 将文件写入输入流
                OutputStream out = response.getOutputStream();

                if("doc".equals(extension)) {
                    //doc文件就以HWPFDocument创建
                    HWPFDocument doc = new HWPFDocument(in);
                    //写入
                    doc.write(out);
                    //关闭对象中的流
                    doc.close();
                }else if("docx".equals(extension)) {
                    //docx文件就以XWPFDocument创建
                    XWPFDocument docx = new XWPFDocument(in);
                    docx.write(out);
                    docx.close();
                } else {
                    //其他类型的文件，按照普通文件传输 如（zip、rar等压缩包）
                    int len;
                    //一次传输1M大小字节
                    byte[] bytes = new byte[1024];
                    while ((len = in.read(bytes)) != -1) {
                        out.write(bytes  , 0 , len);
                    }
                }
            } catch (IOException ex) {
                ex.printStackTrace();
            }
        } else {
            throw new Exception("下载路径不合法。");
        }

    }

还有另一种下载，就是以资源文件的形式实现，比较简单这里就不放代码了，上面的文章里有提到。