SpringBoot实现文件下载限速

在SpringBoot项目中，实现文件下载的限速功能可以有效控制服务器带宽的占用，并防止单个用户消耗过多的资源。本文将通过具体的代码示例和详细的流程解释，介绍如何在SpringBoot项目中实现文件下载的限速功能。

前言

在文件下载过程中，如果不加以控制，可能会导致服务器带宽被单个或少数用户占用，影响其他用户的访问体验。通过实现文件下载的限速，可以平衡带宽资源的使用，确保所有用户都有良好的下载体验。

实现思路

为了实现文件下载的限速，我们需要以下几个关键步骤：

创建一个工具类，用于限制下载速率。
在控制器中使用该工具类处理文件下载请求。
使用StreamingResponseBody实现流式响应，确保大文件可以逐步传输。

代码实现

步骤1：创建限速工具类

首先，我们创建一个限速工具类RateLimiter，该类包含一个方法limitDownloadSpeed，用于限制下载速率。

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * @desc: 文件工具类
 * @author: shy
 * @date: 2024/06/28 11:27
 */
public class FileUtil {

    private static final int BUFFER_SIZE = 1024;

    /**
     * 文件下载限速
     *
     * @param in             输入流
     * @param out            输出流
     * @param bytesPerSecond 每秒允许下载的字节数
     * @throws IOException
     */
    public static void limitDownloadSpeed(InputStream in, OutputStream out, int bytesPerSecond) throws IOException {
        byte[] buffer = new byte[BUFFER_SIZE];
        int bytesRead;
        long bytesSent = 0;
        long startTime = System.currentTimeMillis();
        try {
            while ((bytesRead = in.read(buffer)) != -1) {
                // 将数据写入输出流
                out.write(buffer, 0, bytesRead);
                bytesSent += bytesRead;

                if (bytesSent >= bytesPerSecond) {
                    long elapsedTime = System.currentTimeMillis() - startTime;
                    if (elapsedTime < 1000) {
                        // 如果时间少于1秒，则休眠剩余时间
                        Thread.sleep(1000 - elapsedTime);
                    }
                    // 重置已发送字节计数和开始时间
                    bytesSent = 0;
                    startTime = System.currentTimeMillis();
                }
            }
        } catch (InterruptedException e) {
            // 恢复线程的中断状态
            Thread.currentThread().interrupt();
            throw new IOException("Thread was interrupted", e);
        }
    }
}

解释：

BUFFER_SIZE：定义缓冲区大小。
limitDownloadSpeed：通过try-with-resources管理InputStream，根据设定的速率读取数据并写入输出流，控制传输速率。

步骤2：修改文件下载控制器

接下来，我们在控制器中使用StreamingResponseBody来实现文件下载，并调用限速工具类的方法。

import java.io.File;
import java.io.InputStream;
import java.nio.file.Files;

import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody;

import com.shy.admin.common.annotation.WithoutLogin;
import com.shy.common.utils.FileUtil;

/**
 * @desc: 文件下载Controller
 * @author: shy
 * @date: 2024/06/28 10:48
 */
@RestController
@RequestMapping("/file")
public class FileController {

    // 每秒允许下载的字节数（例如100KB/s）
    private static final int BYTES_PER_SECOND = 1024 * 100; 

    @WithoutLogin
    @GetMapping("/download/{filename}")
    public ResponseEntity<StreamingResponseBody> downloadFile(@PathVariable String filename) {
        // 获取要下载的文件
        File file = new File("D:\\tools\\" + filename);
        // 使用 StreamingResponseBody 实现流式响应体
        StreamingResponseBody responseBody = outputStream -> {
            try (InputStream inputStream = Files.newInputStream(file.toPath())) {
                // 调用限速方法
                FileUtil.limitDownloadSpeed(inputStream, outputStream, BYTES_PER_SECOND);
            }
        };
        // 返回 ResponseEntity，包含响应头和流式响应体
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=" + file.getName())
                .contentType(MediaType.APPLICATION_OCTET_STREAM)
                .contentLength(file.length())
                .body(responseBody);
    }
}

解释：

StreamingResponseBody：实现流式响应体，用于处理大文件的逐步传输。
responseBody：通过lambda表达式实现StreamingResponseBody的writeTo方法，在方法中使用try-with-resources管理InputStream，并调用RateLimiter的方法实现限速。

工作流程

请求处理：当客户端发送下载请求时，Spring 调用控制器方法downloadFile。
创建 StreamingResponseBody：控制器方法创建StreamingResponseBody实例。
返回 ResponseEntity：控制器方法返回包含StreamingResponseBody的ResponseEntity，并设置适当的响应头（如Content-Disposition和Content-Type）。
调用 writeTo 方法：Spring 在准备向客户端发送响应时，调用StreamingResponseBody的writeTo方法，并传入与客户端连接的OutputStream。
写入数据：writeTo方法中，从文件输入流读取数据，并通过RateLimiter方法将数据写入OutputStream，同时控制传输速率。