快捷導(dǎo)航

Java后端向前端返回文件流實(shí)現(xiàn)下載功能的方法

更新時(shí)間：2023年10月27日 09:48:39 作者：Spring羊

這篇文章主要給大家介紹了關(guān)于Java后端向前端返回文件流實(shí)現(xiàn)下載功能的相關(guān)資料,Java后端可以通過(guò)調(diào)用接口返回文件流來(lái)實(shí)現(xiàn)文件傳輸功能，文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下

引言

前端實(shí)現(xiàn)文件下載功能有多種方法，這里就不一一介紹，這里只介紹使用文件流下載的實(shí)現(xiàn)方法。

既然是文件流那就肯定需要給前端返回一堆二進(jìn)制編碼，作為后端就可以返回一個(gè)OutPutStream

后端可以使用Java中servlet提供的HttpServletResponse，核心步驟是要設(shè)置響應(yīng)的數(shù)據(jù)類(lèi)型，設(shè)置為某一類(lèi)文件類(lèi)型或二進(jìn)制格式，以及響應(yīng)頭，然后用ServletOutputStream將文件以流的形式發(fā)送到前端。

直接上代碼

response.setCharacterEncoding("UTF-8");
response.setContentType("application/vnd.ms-excel");

response.setHeader("Content-Disposition", "attachment;filename=example.xls");

解釋一下

首先設(shè)置響應(yīng)數(shù)據(jù)類(lèi)型，你要下載什么文件就設(shè)置什么類(lèi)型，如果你不知道文件是什么類(lèi)型但可以肯定他不是文本文件，那就用下面的application/octet-stream表示，這樣瀏覽器就知道這是一些二進(jìn)制數(shù)據(jù)，就不會(huì)對(duì)其解析了。
其次是設(shè)置響應(yīng)頭：

attachment: 表示響應(yīng)內(nèi)容應(yīng)該被當(dāng)作附件處理，會(huì)觸發(fā)瀏覽器下載行為。

filename：參數(shù)指定下載文件的名稱(chēng)。上述代碼則會(huì)讓瀏覽器下載一個(gè)example.xls的文件。

這里給大家放一個(gè)鏈接，里面有常見(jiàn)的MIME類(lèi)型，常見(jiàn) MIME 類(lèi)型列表例如下圖，png類(lèi)型，pdf，ppt等等。

然后就是用流的形式發(fā)送給前端

ServletOutputStream outputStream = response.getOutputStream();
checkInfo.write(outputStream);
outputStream.flush();

這樣后端就完成了把一個(gè)文件以文件流的形式傳遞給前端，前端發(fā)起請(qǐng)求就會(huì)觸發(fā)瀏覽器的下載行為。

下面是完整代碼

@GetMapping("/output/{classId}/{checkName}")
    public void checkToExcel(@PathVariable String checkName, @PathVariable String classId, HttpServletResponse response) {
        HSSFWorkbook checkInfo = checkExcelService.getCheckInfo(classId, checkName);
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Content-Disposition", "attachment;filename=" + checkName + "簽到統(tǒng)計(jì)表.xls");
        try {
            ServletOutputStream outputStream = response.getOutputStream();
            checkInfo.write(outputStream);
            outputStream.flush();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

不知道有沒(méi)有朋友像我一樣，方法的返回值寫(xiě)的是流（例如ByteArrayOutputStream）這么寫(xiě)就錯(cuò)了

我之前在寫(xiě)這個(gè)程序時(shí)就是向前端返回一個(gè)流，結(jié)果下載的文件始終格式錯(cuò)誤，瀏覽器收到的響應(yīng)數(shù)據(jù)類(lèi)型也一直是json，原因就在于沒(méi)有使用response發(fā)送流，所以一定要使用response.getOutputStream()獲取流，然后再去flush，這樣前端才真正收到的是二進(jìn)制文件流。