amaya-routing

A module of the amaya framework that implements routing of http paths and processing of path and query parameters.

Getting Started

To install it, you will need:

• Java 11+
• Maven/Gradle
• Amaya Core or set of core modules

Features

• Fast route processing (now without collisions ^_^)
• Static routing
• Dynamic routing
• Path parameter parsing
• Query parameter parsing

Installing

Gradle dependency

dependencies {
    implementation group: 'com.github.romanqed', name: 'amaya-core', version: '2.0.0'
    implementation group: 'com.github.romanqed', name: 'amaya-routing', version: '1.1.0'
    // Optional dependency for built-in dynamic routing impl
    implementation group: 'com.github.romanqed', name: 'amaya-fsm-router', version: '1.0.0'
}

Maven dependency

<dependency>
    <groupId>io.github.amayaframework</groupId>
    <artifactId>amaya-core</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>io.github.amayaframework</groupId>
    <artifactId>amaya-routing</artifactId>
    <version>1.1.0</version>
</dependency>
<!--Optional dependency for built-in dynamic routing impl-->
<dependency>
    <groupId>io.github.amayaframework</groupId>
    <artifactId>amaya-fsm-router</artifactId>
    <version>1.0.0</version>
</dependency>

Examples

Hello world

import io.github.amayaframework.core.WebBuilders;
import io.github.amayaframework.http.HttpMethod;

public final class Main {
    public static void main(String[] args) throws Throwable {
        var cfg = RoutingConfigurers.create();
        // Configure routes
        var paths = cfg.getPathSet();
        paths.set(HttpMethod.GET, "/hello", ctx -> {
            ctx.getResponse().getWriter().write("Hello from amaya");
        });
        // Configure app
        var builder = WebBuilders.create();
        var app = builder
                .setServerFactory(/* your web server factory here */)
                .configureApplication(cfg)
                .build();
        app.bind(8080);
        app.run();
    }
}

Dynamic routing with jsm

import com.github.romanqed.jsm.bytecode.BytecodeMachineFactory;
import io.github.amayaframework.core.WebBuilders;
import io.github.amayaframework.fsm.MachineRouterFactory;
import io.github.amayaframework.http.HttpMethod;
import io.github.amayaframework.routing.RoutingConfigurers;

public class Main {

    public static void main(String[] args) throws Throwable {
        // Prepare fsm and routing factories
        var machineFactory = new BytecodeMachineFactory();
        var routingFactory = new MachineRouterFactory(machineFactory);
        // Create configurer
        var cfg = RoutingConfigurers.create(routingFactory);
        // Configure filters
        var filters = cfg.getFilterSet();
        filters.set("int", Integer::parseInt);
        filters.set("positive", raw -> {
            var ret = Integer.parseInt(raw);
            if (ret < 0) {
                throw new IllegalArgumentException("Value must be >= 0");
            }
            return ret;
        });
        filters.set("word", raw -> {
            raw = URLDecoder.decode(raw, StandardCharsets.UTF_8);
            raw = raw.strip();
            if (raw.contains(" ")) {
                throw new IllegalArgumentException("Value must be single world");
            }
            return raw;
        });
        // Configure routes
        var paths = cfg.getPathSet();
        paths.set(HttpMethod.GET, "/a/{p:int}", ctx -> {
            ctx.getResponse().getWriter().write("/a/" + ctx.getRequest().getPathParameter("p"));
        });
        paths.set(HttpMethod.GET, "/a/1", ctx -> {
            ctx.getResponse().getWriter().write("/a/1 (static)");
        });
        paths.set(HttpMethod.GET, "/b/{p:positive}", ctx -> {
            ctx.getResponse().getWriter().write("/b/" + ctx.getRequest().getPathParameter("p"));
        });
        paths.set(HttpMethod.GET, "/word/{w:word}", ctx -> {
            ctx.getResponse().getWriter().write("/word/" + ctx.getRequest().getPathParameter("w"));
        });
        // Configure app
        var builder = WebBuilders.create();
        var app = builder
                .setServerFactory(/* your web server factory here */)
                .configureApplication(cfg)
                .build();
        app.bind(8080);
        app.run();
    }
}

Built With

• Gradle - Dependency management
• jfunc - Basic functional interfaces
• jsm - Finite state machine jit compiler
• amaya-core - Various amaya modules
• Black magic

Authors

• RomanQed - Main work

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details