Dio请求限流实现：令牌桶算法与漏桶算法

【免费下载链接】dio A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc. 项目地址: https://gitcode.com/gh_mirrors/di/dio

你是否遇到过API请求过于频繁导致服务器拒绝访问？或者因突发流量造成应用崩溃？本文将介绍如何在Dio（Dart和Flutter的强大HTTP客户端）中实现请求限流，通过令牌桶算法与漏桶算法保护服务器资源，提升应用稳定性。读完本文，你将掌握两种限流算法的原理、Dio拦截器实现方式以及如何根据场景选择合适的算法。

限流算法基础

为什么需要请求限流？

在分布式系统中，API接口需要面对来自多用户、多设备的并发请求。无限制的请求流量可能导致：

• 服务器过载，响应延迟增加
• 资源耗尽，服务不可用
• 额外的云服务成本支出

Dio作为HTTP客户端，通过拦截器（Interceptor）机制提供了请求生命周期的钩子，使我们能够在请求发送前进行流量控制。Dio拦截器的核心实现位于dio/lib/src/interceptor.dart，通过重写onRequest方法可以实现自定义限流逻辑。

两种经典限流算法对比

特性	令牌桶算法	漏桶算法
原理	以固定速率生成令牌，请求需获取令牌才能执行	以固定速率处理请求，超出容量的请求被丢弃
灵活性	支持突发流量（令牌积累）	严格控制流出速率
实现难度	中等（需维护令牌生成）	简单（队列+定时器）
适用场景	API调用、用户交互请求	数据上报、日志发送

令牌桶算法实现

算法原理

令牌桶算法想象有一个装令牌的桶：

• 系统以固定速率（如10个/秒）向桶中放入令牌
• 每个请求需要从桶中获取一个令牌才能执行
• 桶满时多余令牌溢出（不累积）
• 无令牌时请求等待或拒绝

Dio拦截器实现

以下是基于Dio拦截器的令牌桶限流实现，完整代码可参考example_dart/lib/queue_interceptors.dart的排队机制：

import 'dart:async';
import 'package:dio/dio.dart';

class TokenBucketInterceptor extends Interceptor {
  final int capacity; // 令牌桶容量
  final double tokensPerSecond; // 令牌生成速率
  double _tokens;
  DateTime _lastRefillTime;

  TokenBucketInterceptor({
    required this.capacity,
    required this.tokensPerSecond,
  })  : _tokens = capacity.toDouble(),
        _lastRefillTime = DateTime.now();

  // 计算当前可用令牌数
  double _refillTokens() {
    final now = DateTime.now();
    final elapsed = now.difference(_lastRefillTime).inMicroseconds / 1e6;
    final tokensToAdd = elapsed * tokensPerSecond;
    _tokens = math.min(capacity.toDouble(), _tokens + tokensToAdd);
    _lastRefillTime = now;
    return _tokens;
  }

  @override
  void onRequest(
    RequestOptions options,
    RequestInterceptorHandler handler,
  ) async {
    _refillTokens();
    
    if (_tokens >= 1) {
      _tokens -= 1;
      handler.next(options); // 有令牌，继续请求
    } else {
      // 无令牌，等待令牌生成
      final waitTime = (1 - _tokens) / tokensPerSecond;
      await Future.delayed(Duration(milliseconds: (waitTime * 1000).round()));
      _refillTokens();
      _tokens -= 1;
      handler.next(options);
    }
  }
}

// 使用示例
final dio = Dio();
dio.interceptors.add(TokenBucketInterceptor(
  capacity: 20, // 最多积累20个令牌
  tokensPerSecond: 5, // 每秒生成5个令牌
));

关键参数调优

• 容量（capacity）：设置为预期突发流量峰值，如用户快速点击按钮产生的请求数
• 令牌速率（tokensPerSecond）：根据服务器处理能力设置，如后端API的QPS限制

漏桶算法实现

算法原理

漏桶算法类似一个有孔的桶：

• 请求像水一样流入桶中
• 桶以固定速率将水漏出（处理请求）
• 水满时新流入的水溢出（请求被丢弃）

Dio拦截器实现

利用Dio的QueuedInterceptor（排队拦截器）特性，可以简化漏桶算法的实现：

import 'package:dio/dio.dart';

class LeakyBucketInterceptor extends QueuedInterceptor {
  final int maxRequests; // 桶容量
  final Duration processingDelay; // 处理间隔
  final List<RequestOptions> _queue = [];
  bool _isProcessing = false;

  LeakyBucketInterceptor({
    required this.maxRequests,
    required this.processingDelay,
  });

  Future<void> _processQueue(RequestInterceptorHandler handler) async {
    if (_isProcessing || _queue.isEmpty) return;
    
    _isProcessing = true;
    while (_queue.isNotEmpty) {
      final options = _queue.removeAt(0);
      handler.next(options);
      await Future.delayed(processingDelay);
    }
    _isProcessing = false;
  }

  @override
  void onRequest(
    RequestOptions options,
    RequestInterceptorHandler handler,
  ) {
    if (_queue.length < maxRequests) {
      _queue.add(options);
      _processQueue(handler);
    } else {
      // 桶已满，拒绝请求
      handler.reject(DioException(
        requestOptions: options,
        type: DioExceptionType.cancel,
        message: "请求过于频繁，请稍后再试",
      ));
    }
  }
}

// 使用示例
dio.interceptors.add(LeakyBucketInterceptor(
  maxRequests: 10, // 最多缓存10个请求
  processingDelay: Duration(milliseconds: 500), // 每500ms处理一个请求
));

实战应用与最佳实践

算法选择建议

• 用户交互请求（如按钮点击、表单提交）：选择令牌桶算法，允许合理的突发请求
• 后台任务（如统计上报、日志同步）：选择漏桶算法，平稳占用带宽

与现有排队机制结合

Dio的QueuedInterceptor提供了请求排队能力，特别适合与限流算法结合使用。例如，在处理CSRF令牌刷新时，排队机制可以防止并发请求导致的令牌重复刷新问题，具体实现可参考example_dart/lib/queued_interceptor_crsftoken.dart。

监控与动态调整

生产环境中建议添加限流监控：

class MonitoredTokenBucketInterceptor extends TokenBucketInterceptor {
  final void Function(double remainingTokens) onTokenLevelChanged;
  
  // 重写令牌消耗方法，添加监控回调
  @override
  void onRequest(...) {
    super.onRequest(...);
    onTokenLevelChanged(_tokens);
  }
}

总结与扩展

请求限流是保障API稳定性的重要手段，Dio通过灵活的拦截器机制使限流实现变得简单。本文介绍的两种算法各有特点：

• 令牌桶算法适合需要处理突发流量的场景
• 漏桶算法适合需要严格控制速率的场景

实际应用中，还可以进一步扩展：

• 为不同API端点设置差异化限流策略
• 结合后端返回的限流头信息（如RateLimit）动态调整参数
• 将限流状态存储在本地，实现应用重启后的状态恢复

通过合理的限流策略，我们可以在保护服务器资源和保证用户体验之间取得平衡。完整的示例代码和更多拦截器用法，请参考Dio官方示例库example_dart/lib/。

希望本文能帮助你构建更健壮的HTTP请求系统，如果你有其他限流方案或实践经验，欢迎在评论区分享！记得点赞收藏，关注获取更多Dio高级用法教程。

【免费下载链接】dio A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc. 项目地址: https://gitcode.com/gh_mirrors/di/dio