SpringBoot中的文件下载功能实现教程

 更新时间:2025年09月13日 11:40:01   作者:别来无恙149  
SpringBoot文件下载分两种方式:直接流式下载(实时生成内容,适合小文件)与静态资源映射(预先存储文件,适合大文件),实现涉及控制器调用及分页数据处理流程

一、文件下载的两种实现方式

在Spring Boot应用中,文件下载主要有两种实现方式:

直接流式下载

  • 将文件内容直接写入HTTP响应流
  • 不保存到服务器磁盘
  • 适合小文件或即时生成的内容

静态资源映射下载

  • 先将文件保存到服务器
  • 通过静态资源映射提供访问
  • 适合大文件或需要重复下载的场景

二、直接流式下载实现

核心代码实现:

// ExcelXlsUtil.java
public static void writeXls(HttpServletResponse response, 
                           String fileName, 
                           String[] headers, 
                           List<List<String>> data) throws IOException {
    // 1. 创建工作簿和工作表
    HSSFWorkbook workbook = new HSSFWorkbook();
    HSSFSheet sheet = workbook.createSheet("Sheet1");
    
    // 2. 创建表头行
    HSSFRow headerRow = sheet.createRow(0);
    for (int i = 0; i < headers.length; i++) {
        headerRow.createCell(i).setCellValue(headers[i]);
    }
    
    // 3. 填充数据行
    for (int i = 0; i < data.size(); i++) {
        HSSFRow row = sheet.createRow(i + 1);
        List<String> rowData = data.get(i);
        for (int j = 0; j < rowData.size(); j++) {
            row.createCell(j).setCellValue(rowData.get(j));
        }
    }
    
    // 4. 设置响应头
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    response.setHeader("Content-Disposition", 
        "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8") + ".xls");
    
    // 5. 写入响应流
    try (OutputStream os = response.getOutputStream()) {
        workbook.write(os);
    }
    workbook.close();
}

控制器调用示例

@GetMapping("/downloadDirect")
public void downloadDirect(HttpServletResponse response) throws IOException {
    // 1. 准备数据
    String[] headers = {"ID", "姓名", "手机号"};
    List<List<String>> data = Arrays.asList(
        Arrays.asList("1", "张三", "13800138000"),
        Arrays.asList("2", "李四", "13900139000")
    );
    
    // 2. 调用下载工具
    ExcelXlsUtil.writeXls(response, "用户列表", headers, data);
}

三、静态资源映射下载实现

这里我通过了一个分页查询的函数将某一页的数据查询出来了

    @GetMapping("/exportExcel")
    public Result exportAndSaveExcel(PersonSelectForm personSelectForm) throws IOException {
        // 1. 获取数据
        List<PersonForm> resultList = getresList(personSelectForm);

        // 2. 创建工作簿和工作表
        HSSFWorkbook workbook = new HSSFWorkbook();
        HSSFSheet sheet = workbook.createSheet("Sheet1");

        // 3. 写入数据
        int rowIndex = 0;

        // 3.1 写标题(合并单元格)
        HSSFRow titleRow = sheet.createRow(rowIndex++);
        titleRow.createCell(0).setCellValue("住户信息明细表");
        // 合并第一行单元格(0行,合并0~8列)
        sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, 8));

        // 3.2 写表头
        HSSFRow headerRow = sheet.createRow(rowIndex++);
        String[] headers = new String[] {
                "ID", "小区名称", "所属楼栋", "房号", "姓名", "性别", "手机号码", "居住性质", "备注"
        };
        for (int i = 0; i < headers.length; i++) {
            headerRow.createCell(i).setCellValue(headers[i]);
        }

        // 3.3 写数据行
        for (PersonForm person : resultList) {
            HSSFRow row = sheet.createRow(rowIndex++);
            row.createCell(0).setCellValue(person.getPersonId() != null ? person.getPersonId().toString() : "");
            row.createCell(1).setCellValue(person.getCommunityName() != null ? person.getCommunityName() : "");
            row.createCell(2).setCellValue(person.getTermName() != null ? person.getTermName() : "");
            row.createCell(3).setCellValue(person.getHouseNo() != null ? person.getHouseNo() : "");
            row.createCell(4).setCellValue(person.getUserName() != null ? person.getUserName() : "");
            row.createCell(5).setCellValue(person.getSex() != null ? person.getSex() : "");
            row.createCell(6).setCellValue(person.getMobile() != null ? person.getMobile() : "");
            row.createCell(7).setCellValue(person.getPersonType() != null ? person.getPersonType() : "");
            row.createCell(8).setCellValue(person.getRemark() != null ? person.getRemark() : "");
        }

        // 4. 生成文件名
        String fileName = "住户信息_" + System.currentTimeMillis() + ".xls";

        // 5. 定义保存路径,确保路径最后有分隔符
        String excelpath = "D:\\javacode\\community_vue\\community\\FileXls\\";
        File dir = new File(excelpath);
        if (!dir.exists()) {
            dir.mkdirs();
        }

        // 6. 完整文件路径
        File file = new File(excelpath + fileName);

        // 7. 写入本地文件
        try (FileOutputStream fos = new FileOutputStream(file)) {
            workbook.write(fos);
        } finally {
            workbook.close();
        }

        // 8. 返回相对路径或文件名(前端用下载接口访问,不建议直接返回本地绝对路径)
        String relativePath = fileName; // 你可以根据自己配置修改

        // 如果你没有配置静态资源映射,需要写一个下载接口来读取 D:\javacode\community_vue\community\FileXls 文件夹里的文件

        return Result.ok().put("data", relativePath);
    }

四、实现流程

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Springboot+TCP监听服务器搭建过程图解

    Springboot+TCP监听服务器搭建过程图解

    这篇文章主要介绍了Springboot+TCP监听服务器搭建过程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • java分布式面试降级组件Hystrix的功能特性

    java分布式面试降级组件Hystrix的功能特性

    这篇文章主要为大家介绍了java分布式面试关于降级组件Hystrix的功能特性回答,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • Java经典用法总结

    Java经典用法总结

    这篇文章主要介绍了Java经典用法总结,在本文中,尽量收集一些java最常用的习惯用法,特别是很难猜到的用法,感兴趣的小伙伴们可以参考一下
    2016-02-02
  • SpringBoot简单整合ElasticSearch实践

    SpringBoot简单整合ElasticSearch实践

    Elasticsearch支持结构化和非结构化数据检索,通过索引创建和倒排索引文档,提高搜索效率,它基于Lucene封装,分为索引库、类型、文档和字段,Spring Boot可方便操作ES,通过依赖配置、实体类映射和ElasticsearchRepository接口实现CRUD操作
    2025-12-12
  • Java多线程之同步工具类CyclicBarrier

    Java多线程之同步工具类CyclicBarrier

    这篇文章主要介绍Java多线程之同步工具类CyclicBarrier,它是一个同步工具类,它允许一组线程互相等待,直到达到某个公共屏障点,支持一个可选的Runnable命令,在一组线程中的最后一个线程到达之后,该命令只在每个屏障点运行一次。下面来看文章具体内容
    2021-10-10
  • 详解Spring Security如何配置JSON登录

    详解Spring Security如何配置JSON登录

    这篇文章主要介绍了详解Spring Security如何配置JSON登录,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • java中List<对象>如何根据对象的一个属性进行去重

    java中List<对象>如何根据对象的一个属性进行去重

    这篇文章主要给大家介绍了关于java中List<对象>如何根据对象的一个属性进行去重的相关资料,在开发中可能会遇到很多需要去重的情况,比如Person对象有name跟age两个属性,需要根据age进行去重,需要的朋友可以参考下
    2023-08-08
  • springcloud 熔断器Hystrix的具体使用

    springcloud 熔断器Hystrix的具体使用

    本篇文章主要介绍了springcloud 熔断器Hystrix的具体使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • Eclipse下编写java程序突然不会自动生成R.java文件和包的解决办法

    Eclipse下编写java程序突然不会自动生成R.java文件和包的解决办法

    这篇文章主要介绍了Eclipse下编写java程序突然不会自动生成R.java文件和包的解决办法 的相关资料,需要的朋友可以参考下
    2016-01-01
  • RocketMq同组消费者如何自动设置InstanceName

    RocketMq同组消费者如何自动设置InstanceName

    这篇文章主要介绍了RocketMq同组消费者如何自动设置InstanceName问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06

最新评论