springboot中Excel文件下載踩坑大全

更新時(shí)間：2021年07月08日 15:05:35 作者：斗者_(dá)2013

本文主要介紹了springboot中Excel文件下載，但是卻容易遇到很多坑，文中通過(guò)示例代碼介紹的非常詳細(xì)，感興趣的小伙伴們可以參考一下

項(xiàng)目場(chǎng)景：Spring boot文件下載
問(wèn)題一：下載的文件名稱(chēng)出現(xiàn)中文亂碼的問(wèn)題
問(wèn)題二：在swagger中測(cè)試下載接口，點(diǎn)擊下載的文件，發(fā)現(xiàn)文件名是亂碼的問(wèn)題
問(wèn)題四：開(kāi)發(fā)環(huán)境下載成功，打成jar包發(fā)布到服務(wù)器上部署就出現(xiàn)下載失敗問(wèn)題
完整代碼

項(xiàng)目場(chǎng)景：Spring boot文件下載

調(diào)用接口下載spring boot工程的resources目錄下的excel模板文件，非常常見(jiàn)的一個(gè)文件下載功能，但是卻容易遇到很多坑，下面總結(jié)記錄下。

問(wèn)題一：下載的文件名稱(chēng)出現(xiàn)中文亂碼的問(wèn)題

解決方案：

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

說(shuō)明：
這是網(wǎng)上最常見(jiàn)的解決方案，經(jīng)過(guò)這樣的修改后，在瀏覽器上調(diào)用get請(qǐng)求下載的文件確實(shí)沒(méi)有出現(xiàn)文件名中文亂碼了。
但是在swagger里面測(cè)試接口，下載的問(wèn)題還是會(huì)出現(xiàn)中文亂碼。

問(wèn)題二：在swagger中測(cè)試下載接口，點(diǎn)擊下載的文件，發(fā)現(xiàn)文件名是亂碼的問(wèn)題

這里我項(xiàng)目中使用的是springdoc-openapi-ui 1.5.9，基于的是openapi3.0的協(xié)議。
整體使用方式和界面和swagger類(lèi)似。

swagger中下載的文件，點(diǎn)擊開(kāi)發(fā)后，文件名亂碼問(wèn)題：

在這里插入圖片描述

解決方案：

response.setHeader("Content-Disposition", "attachment;fileName=" + 
URLEncoder.encode("線(xiàn)索導(dǎo)入模板.xlsx","utf8"));

說(shuō)明：
通過(guò)URLEncoder.encode函數(shù)對(duì)文件名稱(chēng)處理后，無(wú)論是在瀏覽器調(diào)用GET請(qǐng)求下載文件，還是Swagger中調(diào)用下載接口，都不會(huì)出現(xiàn)文件名亂碼問(wèn)題。

問(wèn)題三：下載的excel文件打開(kāi)時(shí)總是提示部分內(nèi)容有問(wèn)題，嘗試恢復(fù)。

在這里插入圖片描述

解決辦法：
給response的Header設(shè)置大?。?/p>

/加上設(shè)置大小 下載下來(lái)的excel文件才不會(huì)在打開(kāi)前提示修復(fù)
response.addHeader("Content-Length",String.valueOf(file.length()));

問(wèn)題四：開(kāi)發(fā)環(huán)境下載成功，打成jar包發(fā)布到服務(wù)器上部署就出現(xiàn)下載失敗問(wèn)題

原因：
Resource下的文件是存在于jar這個(gè)文件里面，在磁盤(pán)上是沒(méi)有真實(shí)路徑存在的，它其實(shí)是位于jar內(nèi)部的一個(gè)路徑。所以通過(guò)ResourceUtils.getFile或者this.getClass().getResource("")方法無(wú)法正確獲取文件。

解決：
通過(guò)ClassPathResource讀取文件流

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

完整代碼

1、控制層代碼

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

2、下載方法實(shí)現(xiàn)

/**
 * 下載線(xiàn)索模板
 * @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);
        //加上設(shè)置大小 下載下來(lái)的excel文件才不會(huì)在打開(kāi)前提示修復(fù)
        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

到此這篇關(guān)于springboot中Excel文件下載踩坑大全的文章就介紹到這了,更多相關(guān)springboot Excel文件下載內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: