快捷導(dǎo)航

SpringBoot中的文件下載功能實(shí)現(xiàn)教程

更新時(shí)間：2025年09月13日 11:40:01 作者：別來(lái)無(wú)恙149

SpringBoot文件下載分兩種方式：直接流式下載（實(shí)時(shí)生成內(nèi)容,適合小文件）與靜態(tài)資源映射（預(yù)先存儲(chǔ)文件,適合大文件）,實(shí)現(xiàn)涉及控制器調(diào)用及分頁(yè)數(shù)據(jù)處理流程

一、文件下載的兩種實(shí)現(xiàn)方式

在Spring Boot應(yīng)用中，文件下載主要有兩種實(shí)現(xiàn)方式：

直接流式下載：

將文件內(nèi)容直接寫(xiě)入HTTP響應(yīng)流
不保存到服務(wù)器磁盤(pán)
適合小文件或即時(shí)生成的內(nèi)容

靜態(tài)資源映射下載：

先將文件保存到服務(wù)器
通過(guò)靜態(tài)資源映射提供訪問(wèn)
適合大文件或需要重復(fù)下載的場(chǎng)景

二、直接流式下載實(shí)現(xiàn)

核心代碼實(shí)現(xiàn)：

// ExcelXlsUtil.java
public static void writeXls(HttpServletResponse response, 
                           String fileName, 
                           String[] headers, 
                           List<List<String>> data) throws IOException {
    // 1. 創(chuàng)建工作簿和工作表
    HSSFWorkbook workbook = new HSSFWorkbook();
    HSSFSheet sheet = workbook.createSheet("Sheet1");
    
    // 2. 創(chuàng)建表頭行
    HSSFRow headerRow = sheet.createRow(0);
    for (int i = 0; i < headers.length; i++) {
        headerRow.createCell(i).setCellValue(headers[i]);
    }
    
    // 3. 填充數(shù)據(jù)行
    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. 設(shè)置響應(yīng)頭
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    response.setHeader("Content-Disposition", 
        "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8") + ".xls");
    
    // 5. 寫(xiě)入響應(yīng)流
    try (OutputStream os = response.getOutputStream()) {
        workbook.write(os);
    }
    workbook.close();
}

控制器調(diào)用示例

@GetMapping("/downloadDirect")
public void downloadDirect(HttpServletResponse response) throws IOException {
    // 1. 準(zhǔn)備數(shù)據(jù)
    String[] headers = {"ID", "姓名", "手機(jī)號(hào)"};
    List<List<String>> data = Arrays.asList(
        Arrays.asList("1", "張三", "13800138000"),
        Arrays.asList("2", "李四", "13900139000")
    );
    
    // 2. 調(diào)用下載工具
    ExcelXlsUtil.writeXls(response, "用戶(hù)列表", headers, data);
}

三、靜態(tài)資源映射下載實(shí)現(xiàn)

這里我通過(guò)了一個(gè)分頁(yè)查詢(xún)的函數(shù)將某一頁(yè)的數(shù)據(jù)查詢(xún)出來(lái)了

    @GetMapping("/exportExcel")
    public Result exportAndSaveExcel(PersonSelectForm personSelectForm) throws IOException {
        // 1. 獲取數(shù)據(jù)
        List<PersonForm> resultList = getresList(personSelectForm);

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

        // 3. 寫(xiě)入數(shù)據(jù)
        int rowIndex = 0;

        // 3.1 寫(xiě)標(biāo)題（合并單元格）
        HSSFRow titleRow = sheet.createRow(rowIndex++);
        titleRow.createCell(0).setCellValue("住戶(hù)信息明細(xì)表");
        // 合并第一行單元格（0行，合并0~8列）
        sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, 8));

        // 3.2 寫(xiě)表頭
        HSSFRow headerRow = sheet.createRow(rowIndex++);
        String[] headers = new String[] {
                "ID", "小區(qū)名稱(chēng)", "所屬樓棟", "房號(hào)", "姓名", "性別", "手機(jī)號(hào)碼", "居住性質(zhì)", "備注"
        };
        for (int i = 0; i < headers.length; i++) {
            headerRow.createCell(i).setCellValue(headers[i]);
        }

        // 3.3 寫(xiě)數(shù)據(jù)行
        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 = "住戶(hù)信息_" + 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. 寫(xiě)入本地文件
        try (FileOutputStream fos = new FileOutputStream(file)) {
            workbook.write(fos);
        } finally {
            workbook.close();
        }

        // 8. 返回相對(duì)路徑或文件名（前端用下載接口訪問(wèn)，不建議直接返回本地絕對(duì)路徑）
        String relativePath = fileName; // 你可以根據(jù)自己配置修改

        // 如果你沒(méi)有配置靜態(tài)資源映射，需要寫(xiě)一個(gè)下載接口來(lái)讀取 D:\javacode\community_vue\community\FileXls 文件夾里的文件

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