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）。
//前置handlerapp.before(ctx -> { // 在所有请求之前运行});app.before("/path/*", ctx -> { // 在/path/*请求之前运行});
//端点handlerapp.get("/", ctx -> { // 一些代码 ctx.json(object);});
app.get("/hello/*, ctx -> { // 捕获所有对/hello/子路径的请求 });
//后置handlerapp.after(ctx -> { // 在所有请求之后运行});app.after("/path/*", ctx -> { // 在/path/*请求之后运行 });
复制代码
为了处理验证/授权，Javalin 引入了功能性接口 AccessManager，程序开发人员可以根据需要实现自己的访问管理。
// 设置Javalin应该使用的access-managerapp.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
评论 2 条评论