Java後端向前端返迴文件流——實現下載功能

前端實現文件下載功能有多種方法，這裡就不一一介紹，這裡只介紹使用文件流下載的實現方法。

既然是文件流那就肯定需要給前端返回一堆二進位編碼，作為後端就可以返回一個OutPutStream

後端可以使用Java中servlet提供的HttpServletResponse，核心步驟是要設置響應的數據類型，設置為某一類文件類型或二進位格式，以及響應頭，然後用ServletOutputStream將文件以流的形式發送到前端。

直接上代碼

response.setCharacterEncoding("UTF-8");//統一編碼，utf-8
response.setContentType("application/vnd.ms-excel");//這是xls，舊excel文件類型
//response.setContentType("application/octet-stream");//一種通用的二進位數據流
response.setHeader("Content-Disposition", "attachment;filename=example.xls");//告訴瀏覽器將響應內容當作附件進行處理，從而觸發文件下載。

解釋一下

1. 首先設置響應數據類型，你要下載什麼文件就設置什麼類型，如果你不知道文件是什麼類型但可以肯定他不是文本文件，那就用下麵的application/octet-stream表示，這樣瀏覽器就知道這是一些二進位數據，就不會對其解析了。
2. 其次是設置響應頭：

attachment: 表示響應內容應該被當作附件處理，會觸發瀏覽器下載行為。

filename：參數指定下載文件的名稱。上述代碼則會讓瀏覽器下載一個example.xls的文件。

這裡給大家放一個鏈接，裡面有常見的MIME類型，常見 MIME 類型列表  例如下圖，png類型，pdf，ppt等等。

然後就是用流的形式發送給前端

ServletOutputStream outputStream = response.getOutputStream();
checkInfo.write(outputStream);//checkInfo是我寫的一個方法返回值，其本身是poi包下的HSSFWorkbook類型，讀者不必在意。
outputStream.flush();

這樣後端就完成了把一個文件以文件流的形式傳遞給前端，前端發起請求就會觸發瀏覽器的下載行為。

下麵是完整代碼

@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 + "簽到統計表.xls");
        try {
            ServletOutputStream outputStream = response.getOutputStream();
            checkInfo.write(outputStream);
            outputStream.flush();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

不知道有沒有朋友像我一樣，方法的返回值寫的是流（例如ByteArrayOutputStream）這麼寫就錯了

我之前在寫這個程式時就是向前端返回一個流，結果下載的文件始終格式錯誤，瀏覽器收到的響應數據類型也一直是json，原因就在於沒有使用response發送流，所以一定要使用response.getOutputStream()獲取流，然後再去flush，這樣前端才真正收到的是二進位文件流。