JarCastingrut
Pronounced as route (/ru:t/).
What
A request router that attempts to be fast by using a radix tree internally and avoiding object allocation.
Why
The frequently recurring pattern of routing by iterating over a list of compiled regex patterns is not always a great performer.
rut aims to be at least an order of magnitude faster.
Usage
// From rut-examples/src/main/java/Example.java
// Set up router
final Router<Handler> router = Router.builder(Handler.class)
.route("GET", "/users/", handler("list users"))
.route("POST", "/users/", handler("create user"))
.route("GET", "/users/<user>/blogs/", handler("list user blogs"))
.route("POST", "/users/<user>/blogs/", handler("create user blog"))
.route("GET", "/users/<user>/blogs/<blog>/posts/", handler("list user blog posts"))
.route("POST", "/users/<user>/blogs/<blog>/posts/", handler("create user blog post"))
.route("GET", "/users/<user>/blogs/<blog>/posts/<post>", handler("get user blog post"))
.route("GET", "/static/<filename:path>", handler("get static content"))
.build();
// Create a reusable routing result holder
final Router.Result<Handler> result = router.result();
// Route a request
router.route("POST", "/users/foo-user/blogs/b%C3%A4r-blog/posts/?q=baz&w=quux", result);
assert result.isSuccess();
final Handler handler = result.target();
// Print handler name
out.println("handler: " + handler);
// Print captured path parameter names, raw values and uri decoded values
for (int i = 0; i < result.params(); i++) {
out.printf("param %d: %s=%s (%s)%n", i, result.paramName(i), result.paramValue(i),
result.paramValueDecoded(i));
}
// Print query
out.println("query: " + result.query());
// List all allowed methods
out.println("allowed methods: " + result.allowedMethods());
Output:
handler: create user blog post
param 0: user=foo-user (foo-user)
param 1: blog=b%C3%A4r-blog (bär-blog)
query: q=baz&w=quux
allowed methods: [POST, GET]
pom.xml
<dependency>
<groupId>io.norberg</groupId>
<artifactId>rut</artifactId>
<version>1.0</version>
</dependency>
Notes
- Route paths must be URL encoded when registered.
Benchmarks
mvn clean package
java -jar rut-benchmark/target/rut-benchmark.jar
Benchmark Mode Cnt Score Error Units
RoutingBenchmark.radixTreeRouting thrpt 200 10394965.771 ± 107132.302 ops/s
RoutingBenchmark.regexRouting thrpt 200 911995.189 ± 5912.181 ops/s