Skip to content
Server Plugin

FreeMarker

所需依赖项: io.ktor:ktor-server-freemarker

代码示例: freemarker

Native 服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持: ✖️

通过安装 FreeMarker 插件,Ktor 允许您在应用程序中使用 FreeMarker 模板作为视图。

添加依赖项 ​

要使用 FreeMarker,请将 ktor-server-freemarker 工件添加到构建脚本中:

kotlin
implementation(ktorLibs.server.freemarker)
上面的代码段使用 Ktor 版本目录来指定 Ktor 依赖项。
groovy
implementation ktorLibs.server.freemarker
上面的代码段使用 Ktor 版本目录来指定 Ktor 依赖项。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-freemarker-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

安装 FreeMarker ​

要在应用程序中安装 FreeMarker 插件,请将其传递给指定模块模块允许您通过对路由进行分组来构建应用程序结构。中的 install 函数。 以下示例展示了如何安装 FreeMarker:

  • 在 embeddedServer() 函数调用中。
  • 在 Application 类的显式定义的 module() 扩展函数中。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.freemarker.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(FreeMarker)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.freemarker.*
// ...
fun Application.module() {
    install(FreeMarker)
    // ...
}

在 install 块内部,您可以配置所需的 TemplateLoader 以加载 FreeMarker 模板。

配置 FreeMarker ​

配置模板加载 ​

要加载模板,您需要将所需的 TemplateLoader 类型赋值给 templateLoader 属性。例如,以下代码段使 Ktor 能够在相对于当前类路径的 templates 包中查找模板:

kotlin
import freemarker.cache.*
import io.ktor.server.application.*
import io.ktor.server.freemarker.*

fun Application.module() {
    install(FreeMarker) {
        templateLoader = ClassTemplateLoader(this::class.java.classLoader, "templates")
    }
}

在响应中发送模板 ​

假设您在 resources/templates 中包含 index.ftl 模板:

html
<html>
    <body>
        <h1>Hello, ${user.name}!</h1>
    </body>
</html>

用户的数据模型如下所示:

kotlin
data class User(val id: Int, val name: String)

要将该模板用于指定的路由,请按以下方式将 FreeMarkerContent 传递给 call.respond 方法:

kotlin
get("/index") {
    val sampleUser = User(1, "John")
    call.respond(FreeMarkerContent("index.ftl", mapOf("user" to sampleUser)))
}