springboot中Excel檔案下載踩坑大全

2021-07-08 16:00:38

專案場景：Spring boot檔案下載
問題一：下載的檔名稱出現中文亂碼的問題
問題二：在swagger中測試下載介面，點選下載的檔案，發現檔名是亂碼的問題
問題四：開發環境下載成功，打成jar包釋出到伺服器上部署就出現下載失敗問題
完整程式碼

專案場景：Spring boot檔案下載

呼叫介面下載spring boot工程的resources目錄下的excel模板檔案，非常常見的一個檔案下載功能，但是卻容易遇到很多坑，下面總結記錄下。

問題一：下載的檔名稱出現中文亂碼的問題

解決方案：

response.setHeader("Content-Disposition",
                "attachment;filename=" + new String("下載模板".getBytes("UTF-8"), "ISO8859-1"));

說明：
這是網上最常見的解決方案，經過這樣的修改後，在瀏覽器上呼叫get請求下載的檔案確實沒有出現檔名中文亂碼了。
但是在swagger裡面測試介面，下載的問題還是會出現中文亂碼。

問題二：在swagger中測試下載介面，點選下載的檔案，發現檔名是亂碼的問題

這裡我專案中使用的是springdoc-openapi-ui 1.5.9，基於的是openapi3.0的協定。
整體使用方式和介面和swagger類似。

swagger中下載的檔案，點選開發後，檔名亂碼問題：

解決方案：

response.setHeader("Content-Disposition", "attachment;fileName=" + 
URLEncoder.encode("線索匯入模板.xlsx","utf8"));

說明：
通過URLEncoder.encode函數對檔名稱處理後，無論是在瀏覽器呼叫GET請求下載檔案，還是Swagger中呼叫下載介面，都不會出現檔名亂碼問題。

問題三：下載的excel檔案開啟時總是提示部分內容有問題，嘗試恢復。

解決辦法：
給response的Header設定大小：

/加上設定大小 下載下來的excel檔案才不會在開啟前提示修復
response.addHeader("Content-Length",String.valueOf(file.length()));

問題四：開發環境下載成功，打成jar包釋出到伺服器上部署就出現下載失敗問題

原因：
Resource下的檔案是存在於jar這個檔案裡面，在磁碟上是沒有真實路徑存在的，它其實是位於jar內部的一個路徑。所以通過ResourceUtils.getFile或者this.getClass().getResource("")方法無法正確獲取檔案。

解決：
通過ClassPathResource讀取檔案流

 ClassPathResource classPathResource = new ClassPathResource("template/template.xlsx");

完整程式碼

1、控制層程式碼

@Operation(summary = "下載模版",description = "下載模版")
@GetMapping("/download")
public void download(HttpServletResponse response){
    templateService.download(response);
}

2、下載方法實現

/**
 * 下載線索模板
 * @param response
 */
public void download(HttpServletResponse response) {
    InputStream inputStream = null;
    BufferedInputStream bis = null;
    OutputStream outputStream = null;
    try {
        ClassPathResource classPathResource = new ClassPathResource("template/template.xlsx");
        inputStream = classPathResource.getInputStream();

        response.setContentType("application/octet-stream");
        response.setHeader("content-type", "application/octet-stream");
        //待下載檔名
        String fileName = URLEncoder.encode("模板.xlsx","utf8");
        response.setHeader("Content-Disposition", "attachment;fileName=" + fileName);
        //加上設定大小 下載下來的excel檔案才不會在開啟前提示修復
        response.addHeader("Content-Length",String.valueOf(classPathResource.getFile().length()));

        byte[] buff = new byte[1024];
        outputStream = response.getOutputStream();
        bis = new BufferedInputStream(inputStream);
        int read = bis.read(buff);
        while (read != -1) {
            outputStream.write(buff, 0, buff.length);
            outputStream.flush();
            read = bis.read(buff);
        }
    } catch ( IOException e ) {
        log.error("檔案下載失敗,e");
    } finally {
        IOUtils.closeQuietly(outputStream);
        IOUtils.closeQuietly(inputStream);
        IOUtils.closeQuietly(bis);
    }
}

參考：https://blog.csdn.net/Hi_Boy_/article/details/107198371

到此這篇關於springboot中Excel檔案下載踩坑大全的文章就介紹到這了,更多相關springboot Excel檔案下載內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！