SpringBoot实现文件下载的限速功能

 更新时间:2024年07月03日 11:13:40   作者:shy好好学习  
在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表达式实现StreamingResponseBodywriteTo方法,在方法中使用try-with-resources管理InputStream,并调用RateLimiter的方法实现限速。

工作流程

  1. 请求处理:当客户端发送下载请求时,Spring 调用控制器方法downloadFile
  2. 创建 StreamingResponseBody:控制器方法创建StreamingResponseBody实例。
  3. 返回 ResponseEntity:控制器方法返回包含StreamingResponseBodyResponseEntity,并设置适当的响应头(如Content-DispositionContent-Type)。
  4. 调用 writeTo 方法:Spring 在准备向客户端发送响应时,调用StreamingResponseBodywriteTo方法,并传入与客户端连接的OutputStream
  5. 写入数据writeTo方法中,从文件输入流读取数据,并通过RateLimiter方法将数据写入OutputStream,同时控制传输速率。

总结

通过以上步骤,我们成功在SpringBoot项目中实现了文件下载的限速功能。核心思路是通过一个限速工具类控制数据传输速率,并使用StreamingResponseBody实现流式响应,确保大文件可以逐步传输。这种设计既能有效控制带宽资源的使用,又能提供良好的用户下载体验。

以上就是SpringBoot实现文件下载的限速功能的详细内容,更多关于SpringBoot文件下载限速的资料请关注脚本之家其它相关文章!

相关文章

  • SpringBoot 如何使用 JWT 保护 Rest Api 接口

    SpringBoot 如何使用 JWT 保护 Rest Api&nbs

    使用spring-boot开发RESTful API非常的方便,在生产环境中,对发布的 API 增加授权保护是非常必要的,现在我们来看如何利用JWT技术为API 增加授权保护,保证只有获得授权的用户才能够访问 API,感兴趣的朋友跟随小编一起看看吧
    2024-02-02
  • java并发中ExecutorService的具体用法

    java并发中ExecutorService的具体用法

    本文深入探讨Java中的ExecutorService框架,介绍其创建方法、任务分配、关闭策略及Future、ScheduledExecutorService的使用,对比Fork/Join框架,提供丰富的代码示例,感兴趣的朋友跟随小编一起看看吧
    2025-09-09
  • SpringCloud之服务注册与发现Spring Cloud Eureka实例代码

    SpringCloud之服务注册与发现Spring Cloud Eureka实例代码

    这篇文章主要介绍了SpringCloud之服务注册与发现Spring Cloud Eureka实例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04
  • Java使用组合模式实现表示公司组织结构功能示例

    Java使用组合模式实现表示公司组织结构功能示例

    这篇文章主要介绍了Java使用组合模式实现表示公司组织结构功能,简单描述了组合模式的概念、功能并结合实例形式分析了Java使用组合模式实现公司组织结构表示功能具体操作步骤与相关注意事项,需要的朋友可以参考下
    2018-05-05
  • 解决feign之间文件上传报错:Error converting request body的问题

    解决feign之间文件上传报错:Error converting request body

    这篇文章主要介绍了解决feign之间文件上传报错:Error converting request body的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-05-05
  • java 分转元与元转分实现操作

    java 分转元与元转分实现操作

    这篇文章主要介绍了java 分转元与元转分实现操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • Spring Boot如何通过Actuator显示git和build的信息

    Spring Boot如何通过Actuator显示git和build的信息

    这篇文章主要介绍了Spring Boot通过Actuator显示git和build的信息,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-01-01
  • springboot+springmvc+mybatis项目整合

    springboot+springmvc+mybatis项目整合

    这篇文章主要为大家详细介绍了springboot+springmvc+mybatis项目的整合,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-04-04
  • Java8中对于LocalDateTime的序列化和反序列化问题

    Java8中对于LocalDateTime的序列化和反序列化问题

    这篇文章主要介绍了Java8中对于LocalDateTime的序列化和反序列化问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • 详解Springboot 优雅停止服务的几种方法

    详解Springboot 优雅停止服务的几种方法

    这篇文章主要介绍了详解Springboot 优雅停止服务的几种方法 ,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08

最新评论