Class RateLimiter

java.lang.Object
com.sure.tool.thread.RateLimiter

public class RateLimiter extends Object
令牌桶限流器:按固定速率补充令牌,突发容量由桶大小决定,线程安全,零依赖。

基于 System.nanoTime() 的平滑令牌桶实现(参考 Guava RateLimiter 的简化版): 每次放行前计算自上次补充以来应累积的令牌数,桶内最多保留 capacity 个令牌。

Since:
0.2.0
Author:
suretool
  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimiter(double permitsPerSecond)
    构造限流器。
    RateLimiter(double permitsPerSecond, double capacity)
    构造限流器。
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    阻塞等待直到获得许可(可被中断)。
    void
    acquire(int permits)
    阻塞等待直到获得指定数量许可(可被中断)。
    boolean
    尝试获取 1 个许可,不等待。
    boolean
    tryAcquire(int permits)
    尝试获取指定数量许可,不等待。

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • RateLimiter

      public RateLimiter(double permitsPerSecond)
      构造限流器。
      Parameters:
      permitsPerSecond - 每秒放行数(>0)
    • RateLimiter

      public RateLimiter(double permitsPerSecond, double capacity)
      构造限流器。
      Parameters:
      permitsPerSecond - 每秒放行数(>0)
      capacity - 突发容量(桶大小,>0)
  • Method Details

    • tryAcquire

      public boolean tryAcquire()
      尝试获取 1 个许可,不等待。
      Returns:
      是否获得许可
    • tryAcquire

      public boolean tryAcquire(int permits)
      尝试获取指定数量许可,不等待。
      Parameters:
      permits - 许可数(>0)
      Returns:
      是否获得许可
    • acquire

      public void acquire() throws InterruptedException
      阻塞等待直到获得许可(可被中断)。
      Throws:
      InterruptedException - 线程中断
    • acquire

      public void acquire(int permits) throws InterruptedException
      阻塞等待直到获得指定数量许可(可被中断)。
      Parameters:
      permits - 许可数(>0)
      Throws:
      InterruptedException - 线程中断