Java rate-limiting library based on token-bucket algorithm.
Get dependency
The Bucket4j is distributed through Maven Central:
Java 17 dependency
<!-- For java 17+ -->
<dependency>
<groupId>com.bucket4j</groupId>
<artifactId>bucket4j_jdk17-core</artifactId>
<version>8.23.0</version>
</dependency>
Quick start
import io.github.bucket4j.Bucket;
...
// bucket with capacity 20 tokens and with refilling speed 1 token per each 6 second
private static Bucket bucket = Bucket.builder()
.addLimit(limit -> limit.capacity(20).refillGreedy(10, Duration.ofMinutes(1)))
.build();
private void doSomethingProtected() {
if (bucket.tryConsume(1)) {
doSomething();
} else {
throw new SomeRateLimitingException();
}
}
More examples can be found there
Bucket4j basic features
- Absolutely non-compromise precision - Bucket4j does not operate with floats or doubles, all calculation are performed in the integer arithmetic, this feature protects end users from calculation errors involved by rounding.
- Effective implementation in terms of concurrency:
- Bucket4j is good scalable for multi-threading case it by defaults uses lock-free implementation.
- In same time, library provides different concurrency strategies that can be chosen when default lock-free strategy is not desired.
- Effective API in terms of garbage collector footprint: Bucket4j API tries to use primitive types as much as it is possible in order to avoid boxing and other types of floating garbage.
- Pluggable listener API that allows to implement monitoring and logging.
- Rich diagnostic API that allows to investigate internal state.
- Rich configuration management - configuration of the bucket can be changed on fly
Bucket4j distributed features
In additional to basic features described above, Bucket4j provides ability to implement rate-limiting in cluster of JVMs:
- Bucket4j out of the box supports any GRID solution which compatible with JCache API (JSR 107) specification.
- Bucket4j provides the framework that allows to quickly build integration with your own persistent technology like RDMS or a key-value storage.
- For clustered usage scenarios Bucket4j supports asynchronous API that extremely matters when going to distribute world, because asynchronous API allows avoiding blocking your application threads each time when you need to execute Network request.
Bucket4j is not a framework, it is a library, with Bucket4j you need to write a code to achive your goals.
For generic use-cases, try to look at powerfull Spring Boot Starter for Bucket4j, that allows you to set access limits on your API effortlessly.
Its key advantage lies in the configuration via properties or yaml files, eliminating the need for manual code authoring.
Supported JCache compatible(or similar) back-ends
In addition to local in-memory buckets, the Bucket4j supports clustered usage scenario on top of following back-ends:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
