Ktor Routing:如何在应用程序/ api中分解路由功能?

时间:2018-02-22 04:44:14

标签: kotlin ktor

我的问题是关于Ktor中路由功能背后的大背景;和设计具有大量路由的API时的可扩展性。

如果我创建这样的应用程序:

import io.ktor.application.*
import io.ktor.response.*
import io.ktor.request.*
import io.ktor.server.engine.embeddedServer
import io.ktor.server.netty.Netty

fun Application.routingExample() {
 intercept(ApplicationCallPipeline.Call){
   if (call.request.uri == "/") call.respondText("User call for /")
 }
}

fun main(args: Array<String>) {
    embeddedServer(Netty, 8080, watchPaths = listOf("Routing"), module = Application::routingExample).start()
}

如果我有一个路由数量少的api / app,那也没关系。但是我应该采用什么样的方式来扩展这种方法 大量路线(例如,30条路线和控制器功能)。

我会有很多选择:

一个大型路由功能:我会有一个很大的Application.routingExample功能,可以容纳所有路由,所以我不需要更新主路由。

一个大的主函数:会有一个大函数来保存对不同较小函数的调用;但它会重复;至于我想要的API 在同一个港口服务他们。

所以我的问题是关于编码风格:有没有办法将路由控制器关系分解?

1 个答案:

答案 0 :(得分:3)

首先,有一个复杂的routing功能,因此您无需比较请求URI。

其次,由于路由是DSL,因此只是代码,您可以以任何您喜欢的方式提取函数和组织代码。一个例子是KotlinConf后端应用程序。源代码可在此处获取:https://github.com/JetBrains/kotlinconf-app/blob/master/backend/src/org/jetbrains/kotlinconf/backend/Api.kt

看起来像这样:

fun Routing.api(database: Database, production: Boolean) {
    apiKeynote(database, production)
    apiRegister(database, production)
    apiAll(database, production)
    apiSession(database, production)
    apiVote(database, production)
    apiFavorite(database, production)
    wsVotes(database, production)
}

每个函数都是Routing的扩展,并定义了自己的API端点集,如下所示:

fun Routing.apiFavorite(database: Database, production: Boolean) {
    route("favorites") {
        get { … }
        post { … }
        delete { … }
    }
}

您可以将它们与业务逻辑,支持系统等一起放在不同的文件,文件夹或包中。