Javalin是一款Kotlin和Java轻量级Web框架，它设计简单，默认情况下是阻塞的，支持WebSocket、HTTP2和异步请求。Javalin最初是SparkJava框架的一个分支，后来受JavaScript框架koa.js的影响进行了彻底的重写。

Javalin构建于Jetty之上，其性能相当于原始的Jetty。此外，开发人员不需要扩展任何类、使用@Annotations，也不需要为Java或Kotlin下载不同版本的Javalin。

要在Java中使用Javalin，开发人员只需要一个如下所示的public static void main ：

public static void main(String[] args) {
    var app = Javalin.create().start(7000);
    app.get("/", ctx -> ctx.result("Hello World"));
}

我们来看看一个带有配置信息的代码片段：

var app = Javalin.create(config -> {
    config.defaultContentType = "application/json";
    config.autogenerateEtags = true;
    config.addStaticFiles("/public");
    config.asyncRequestTimeout = 10_000L;
    config.dynamicGzip = true;
    config.enforceSsl = true;
}).routes(() -> {
    path("users", () -> {
        get(UserController::getAll);
        post(UserController::create);
        path(":user-id"(() -> {
            get(UserController::getOne);
            patch(UserController::update);
            delete(UserController::delete);
        });
        ws("events", userController::webSocketEvents);
    });
}).start(port);

在Javalin中验证路径参数、查询参数和表单参数等都非常简单：

var myQpStr = ctx.queryParam("my-qp"); // 没有验证，返回字符串或空
var myQpInt = ctx.pathParam("my-qp", Integer.class).get(); // 返回一个整数或抛出异常
var myQpInt = ctx.formParam("my-qp", Integer.class).check(i -> i > 4).get(); // 整数 > 4

// 验证两个依赖的查询参数 :
var fromDate = ctx.queryParam("from", Instant.class).get();
var toDate = ctx.queryParam("to", Instant.class)
        .check(it -> it.isAfter(fromDate), "'to' has to be after 'from'")
        .get();

// 验证一个json消息体:
var myObject = ctx.bodyValidator(MyObject.class)
        .check(obj -> obj.myObjectProperty == someValue)
        .get();

Javalin另一个有趣的功能是handler。Javalin引入了前置handler（before-handler）、端点handler（endpoint-handler）、后置handler（after-handler）、异常handler（exception-handler）和错误handler（error-handler）。

//前置handler
app.before(ctx -> {
    // 在所有请求之前运行
});
app.before("/path/*", ctx -> {
    // 在/path/*请求之前运行
});

//端点handler
app.get("/", ctx -> {
    // 一些代码
    ctx.json(object);
});

app.get("/hello/*, ctx -> {
    // 捕获所有对/hello/子路径的请求 
});

//后置handler
app.after(ctx -> {
    // 在所有请求之后运行
});
app.after("/path/*", ctx -> {
    // 在/path/*请求之后运行 
});

为了处理验证/授权，Javalin引入了功能性接口AccessManager，程序开发人员可以根据需要实现自己的访问管理。

// 设置Javalin应该使用的access-manager
app.accessManager((handler, ctx, permittedRoles) -> {
    MyRole userRole = getUserRole(ctx);
    if (permittedRoles.contains(userRole)) {
        handler.handle(ctx);
    } else {
        ctx.status(401).result("Unauthorized");
    }
});

Role getUserRole(Context ctx) {
    // 基于请求确定用户角色 
    // 通常通过检查标头来完成
}

enum MyRole implements Role {
    ANYONE, ROLE_ONE, ROLE_TWO, ROLE_THREE;
}

app.routes(() -> {
    get("/un-secured",   ctx -> ctx.result("Hello"),   roles(ANYONE));
    get("/secured",      ctx -> ctx.result("Hello"),   roles(ROLE_ONE));
});

从版本3.0开始，Javalin还引入了OpenAPI（Swagger）插件。OpenAPI 3.0规范的完整实现提供了DSL和注解两种使用方式。

OpenAPI DSL:

val addUserDocs = document()
        .body()
        .result("400")
        .result("204")

fun addUserHandler(ctx: Context) {
    val user = ctx.body()
    UserRepository.addUser(user)
    ctx.status(204)
}

OpenAPI注解：

@OpenApi(
    requestBody = OpenApiRequestBody(User::class),
    responses = [
        OpenApiResponse("400", Unit::class),
        OpenApiResponse("201", Unit::class)
    ]
)
fun addUserHandler(ctx: Context) {
    val user = ctx.body()
    UserRepository.createUser(user)
    ctx.status(201)
}

要部署Javalin应用程序，开发人员只需创建一个有依赖项（使用maven-assembly-plugin）的jar，然后用Java -jar filename.jar发布该jar。Javalin带有一个嵌入式Jetty服务器，所以无需额外的应用程序服务器。

Javalin还有专门为教育工作者准备的页面，该页面强调学生可以从Javalin受益，因为Javalin提供了嵌入式的Jetty服务器，所以不需要Servlet Container/Application服务器配置就可以开始编码。

有一系列教程可供使用，如Running on GraalVM和Kotlin CRUD REST API。可以在教程页面找到完整的列表。

文档页面提供了有关Javalin的更多细节。用户可以通过maven或从手动maven中央库下载Javalin。

原文链接：

Introducing Javalin: a Lightweight Web Framework for Java and Kotlin

创作场景

Java 和 Kotlin 轻量级 Web 框架 Javalin 简介