SpringBoot下載文件的正確解法方式

更新時間：2023年08月09日 09:24:39 作者：habitplus007

這篇文章主要給大家介紹了關于SpringBoot下載文件的正確解法方式,SpringBoot是一款流行的框架,用于開發(fā)Web應用程序,在使用SpringBoot構建Web應用程序時,可能需要實現(xiàn)文件下載的功能,需要的朋友可以參考下

前言

最近遇到一個奇怪的需求，前端通過post請求下載壓縮文件，同時會傳給后端一些數(shù)據(jù)，用于生成壓縮包。此時后端接口就不僅僅是生成壓縮文件流輸出給前端。而必須要有報錯能力與異常處理能力。即如果后端報錯，前端應該是下載不了文件流。

比較一般的解法

一般而言，Spring Boot生成文件流供前端下載，會直接將文件流寫入到 HttpServletResponse.getOutputStream()，然而這樣會有一個問題，無論后端如何報錯，前端都能成功下載文件，因為 status=200。即如下寫法：

@PostMapping(value = "/project/code/download")
public void downloadCode(@RequestBody TProjectInfo pf, HttpServletResponse response) {
    // 1.生成源碼文件
    // 2.壓縮文件
    // 3.設置回復的一些參數(shù)
    // 4.將壓縮文件寫入網(wǎng)絡流
    log.info("request param: {}", pf);
    OutputStream os = null;
        try {
            // 配置文件下載
            // 下載文件能正常顯示中文
            String filename = pf.getProjectName() + System.currentTimeMillis() + ".zip";
            response.setHeader("Content-Disposition", "attachment;filename=" + filename);
            response.setHeader("Content-Type", "application/octet-stream");
            response.setContentType("application/octet-stream; charset=UTF-8");
            os = response.getOutputStream();
            projectService.generateCode(pf, os);
            log.info("Download  successfully!");
        } catch (Exception e) {
            log.error("Download  failed: {}", e.getMessage());
            throw new OptErrorException(OptStatus.FAIL.code, "文件下載失敗");
        } finally {
            if (os != null) {
                try {
                    os.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
}

分析原因

因為后端直接向OutputStream寫入，會覆蓋所有異常捕獲，因此前端直接向data下取字節(jié)流數(shù)據(jù)即可。

正確解法

其實就是要后端能在錯誤時返回json數(shù)據(jù)，正確下載時直接取data下取字節(jié)流即可，所以使用 ResponseEntity 返回即可。

@PostMapping(value = "/project/code/download")
public ResponseEntity<InputStreamResource> downloadCode(@RequestBody TProjectInfo pf) {
   log.info("request param: {}", pf);
   String filename = pf.getProjectName() + System.currentTimeMillis() + ".zip";
   byte[] bytes = projectService.generateCode(pf);
   ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
   HttpHeaders headers = new HttpHeaders();
   headers.add("Content-Disposition", String.format("attachment; filename=\"%s\"", filename));
   return ResponseEntity.ok()
           .headers(headers)
           .contentType(MediaType.parseMediaType("application/octet-stream"))
           .body(new InputStreamResource(bais));
}

這里的異常，使用RestExceptionAdvice統(tǒng)一處理：

@RestControllerAdvice
public class ExceptionAdvice {
    private static final Logger logger = LoggerFactory.getLogger(ExceptionAdvice.class);
    /**
     * 處理數(shù)據(jù)綁定異常
     *
     * @param bindException 數(shù)據(jù)綁定異常
     * @return 統(tǒng)一響應基本結果
     */
    @ExceptionHandler(value = BindException.class)
    public ResponseEntity<Result<Object>> handleValidateException(BindException bindException) {
        logger.error("數(shù)據(jù)綁定異常，{}", bindException.getMessage(), bindException);
        return of(HttpStatus.BAD_REQUEST, "數(shù)據(jù)綁定異常");
    }
    /**
     * 統(tǒng)一處理 405 異常
     *
     * @param exception 請求方法不支持異常
     * @return 統(tǒng)一響應結果
     */
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    public ResponseEntity<Result<Object>> handleMethodNotSupportedException(HttpRequestMethodNotSupportedException exception) {
        if (exception != null) {
            logger.error("Http 405, {}", exception.getMessage(), exception);
        }
        return of(HttpStatus.METHOD_NOT_ALLOWED, "方法不被支持");
    }
    private ResponseEntity<Result<Object>> of(HttpStatus status, String msg) {
        return ResponseEntity.status(status).body(Result.builder().code(OptStatus.FAIL.code).msg(msg).build());
    }
    /**
     * 統(tǒng)一處理自定義操作錯誤異常
     *
     * @param exception 操作錯誤異常
     * @return 統(tǒng)一響應結果
     */
    @ExceptionHandler(value = OptErrorException.class)
    public ResponseEntity<Result<Object>> handleOptErrorException(OptErrorException exception) {
        return of(HttpStatus.INTERNAL_SERVER_ERROR, exception.getOptMsg());
    }
    /**
     * 統(tǒng)一處理 服務器內部 異常
     *
     * @param e 異常
     * @return 統(tǒng)一響應結果
     */
    @ExceptionHandler(value = Throwable.class)
    public ResponseEntity<Result<Object>> handle500(Throwable e) {
        if (e != null) {
            logger.error("Http 500, {}", e.getMessage(), e);
        }
        return of(HttpStatus.INTERNAL_SERVER_ERROR, "服務器內部未知錯誤");
    }
}

以上就是解決的全過程，可能寫得有點片面，純屬一點個人實踐中的見解。