Spring框架中的文件下載功能

文件下載是Web應用程序中常見的功能之一，Spring框架提供了多種方式來進行文件下載，從簡單的文件下載到帶寬控制和流加密的高級下載，Spring框架可以滿足各種需求。本文將詳細介紹Spring框架中的文件下載功能。

一、Spring下載文件流

在Spring框架中，我們可以很容易地使用ResponseEntity類型來下載文件。

示例代碼：

@GetMapping("/download")
public ResponseEntity downloadFile() throws IOException {
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
    headers.setContentDispositionFormData("attachment", "filename.txt");
    byte[] contents = "This is the content of the file".getBytes();
    return new ResponseEntity(contents, headers, HttpStatus.OK);
}

解釋：

首先，我們通過@GetMapping註解定義了一個/download映射，在該方法中，我們創建了HttpHeaders對象，並設置Content-Type為application/octet-stream，它告訴Web瀏覽器這是一個二進位文件而不是文本文件。之後，我們設置了Content-Disposition標頭，指示瀏覽器將文件下載而不是以其它方式打開它。

最後，我們創建了一個包含文件內容的位元組數組，並使用ResponseEntity返回它。ResponseEntity將承擔整個HTTP響應，因此不僅包含文件內容和標頭，還包含HTTP狀態碼。

二、Spring下載文件帶寬限制

如果您需要限制下載文件的帶寬，請使用StreamingResponseBody和ServletOutputStream。

示例代碼：

@GetMapping("/download")
public void downloadFileWithBandwidthLimit(HttpServletResponse response) throws IOException {
    response.setContentType("application/octet-stream");
    response.setHeader("Content-Disposition", "attachment; filename=filename.txt");
    InputStream inputStream = new ByteArrayInputStream("This is the content of the file".getBytes());
    ServletOutputStream outputStream = response.getOutputStream();
    byte[] buffer = new byte[1024];
    int bytesRead = -1;
    long totalBytesWritten = 0L;
    long startTime = System.currentTimeMillis();
    while ((bytesRead = inputStream.read(buffer)) != -1) {
        long currentTime = System.currentTimeMillis();
        long timeDiffInMillis = currentTime - startTime;
        long timeDiffInSeconds = TimeUnit.MILLISECONDS.toSeconds(timeDiffInMillis);
        long bytesPerSecond = totalBytesWritten / timeDiffInSeconds;
        if (bytesPerSecond > 1000) {
            try {
                Thread.sleep(1000 - timeDiffInMillis % 1000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
        outputStream.write(buffer, 0, bytesRead);
        totalBytesWritten += bytesRead;
    }
    inputStream.close();
    outputStream.flush();
}

解釋：

在此示例中，我們通過@GetMapping註解定義了一個/download映射，使用StreamingResponseBody和ServletOutputStream實現了帶寬限制的文件下載。

我們使用inputStream指向文件數據，使用outputStream寫入響應的數據。

我們使用位元組數組緩衝數據，每次從輸入流中讀取1024個位元組並將其寫入輸出流中。

我們使用while循環讀取輸入流並寫入輸出流。在每個循環中，我們計算時間差和位元組數，並根據時間差休眠以限制帶寬。

三、Spring下載文件返迴文件流

如果您需要將文件直接返回給用戶而不進行下載，請使用InputStreamResource並設置Content-Type頭和Content-Length頭。

示例代碼：

@GetMapping("/download")
public ResponseEntity downloadFile() throws IOException {
    byte[] contents = "This is the content of the file".getBytes();
    InputStream inputStream = new ByteArrayInputStream(contents);
    HttpHeaders headers = new HttpHeaders();
    headers.setContentLength(contents.length);
    headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
    InputStreamResource resource = new InputStreamResource(inputStream);
    return new ResponseEntity(resource, headers, HttpStatus.OK);
}

解釋：

在此示例中，我們使用@GetMapping註解定義了一個/download映射，使用InputStreamResource將文件返回給用戶。我們使用位元組數組模擬文件內容，並通過ByteArrayInputStream創建一個輸入流。我們使用HttpHeaders來設置Content-Length頭和Content-Type頭。

HttpHeaders對象中的Content-Length頭指定將返回內容的長度。HttpHeaders對象中的Content-Type頭指定要返迴文件的MIME類型。

四、Spring下載文件損壞

在文件下載期間出現錯誤時，可以使用ResponseEntityExceptionHandler處理異常。Spring框架提供了默認異常處理程序ResponseEntityExceptionHandler，可以自定義實現來處理不同類型的異常。

示例代碼：

@ControllerAdvice
public class CustomResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
    @ExceptionHandler(FileNotFoundException.class)
    public ResponseEntity