Skip to content
Server Plugin

FreeMarker

必要相依性:io.ktor:ktor-server-freemarker

程式碼範例: freemarker

原生伺服器Ktor 支援 Kotlin/Native,可讓您在無需額外執行階段或虛擬機的情況下執行伺服器。支援:✖️

Ktor 允許您透過安裝 FreeMarker 外掛程式,在應用程式中使用 FreeMarker 範本 作為檢視。

新增相依性 ​

若要使用 FreeMarker,請將 ktor-server-freemarker 構件新增至您的建置指令碼中:

kotlin
implementation(ktorLibs.server.freemarker)
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。
groovy
implementation ktorLibs.server.freemarker
上述程式碼片段使用 Ktor version catalog 來指定 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 在相對於當前 classpath 的 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)))
}