Skip to content
Server Plugin

JTE

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

程式碼範例: jte

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

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

新增相依性 ​

若要使用 Jte,請將 ktor-server-jte 構件新增至您的組建指令碼中:

kotlin
implementation(ktorLibs.server.jte)
上述程式碼片段使用 Ktor 版本目錄 來指定 Ktor 相依性。
groovy
implementation ktorLibs.server.jte
上述程式碼片段使用 Ktor 版本目錄 來指定 Ktor 相依性。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-jte-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

若要處理 .kte 檔案,請將 gg.jte:jte-kotlin 構件新增至您的專案中:

kotlin
implementation("gg.jte:jte-kotlin:$jte_version")
groovy
implementation "gg.jte:jte-kotlin:$jte_version"
xml
<dependency>
    <groupId>gg.jte</groupId>
    <artifactId>jte-kotlin</artifactId>
    <version>${jte_version}</version>
</dependency>

目前的 jte‑kotlin 編譯器外掛程式與 Kotlin 2.3.x 不相容。 由於 Ktor 3.4.0 使用 Kotlin 2.3 工具鏈,在 jte‑kotlin 外掛程式新增對 Kotlin 2.3 的支援之前,無法使用 Ktor JTE 外掛程式。

如果您依賴 JTE,請在 jte‑kotlin 針對 Kotlin 2.3 進行更新之前,使用 Kotlin 2.2.x 以及相容的 Ktor 版本。

安裝 Jte ​

若要將 Jte 外掛程式安裝至應用程式中, 請將其傳遞給指定模組模組可讓您透過對路由進行分組來建構應用程式。中的 install 函式。 以下範例展示如何安裝 Jte:

  • 在 embeddedServer() 函式呼叫中。
  • 在 Application 類別上明確定義的 module() 擴充函式中。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.jte.*

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

在 install 區塊內,您可以設定如何載入 JTE 範本。

設定 Jte ​

設定範本載入 ​

若要載入 JTE 範本,您需要:

  1. 建立用於解析範本程式碼的 CodeResolver。例如,您可以設定 DirectoryCodeResolver 從給定目錄載入範本,或是設定 ResourceCodeResolver 從應用程式資源載入範本。
  2. 使用 templateEngine 屬性指定範本引擎,該引擎會使用已建立的 CodeResolver 將範本轉換為原生 Java/Kotlin 程式碼。

例如,以下程式碼片段讓 Ktor 能夠在 templates 目錄中尋找 JTE 範本:

kotlin
import gg.jte.TemplateEngine
import gg.jte.resolve.DirectoryCodeResolver
import io.ktor.server.application.*
import io.ktor.server.jte.*
import java.nio.file.Path

fun Application.module() {
    install(Jte) {
        val resolver = DirectoryCodeResolver(Path.of("templates"))
        templateEngine = TemplateEngine.create(resolver, gg.jte.ContentType.Html)
    }
}

在回應中傳送範本 ​

假設您在 templates 目錄中有一個 index.kte 範本:

html
@param id: Int
@param name: String
<html>
    <body>
        <h1>Hello, ${name}!</h1>
    </body>
</html>

若要將該範本用於指定的路由,請透過以下方式將 JteContent 傳遞給 call.respond 方法:

kotlin
get("/index") {
    val params = mapOf("id" to 1, "name" to "John")
    call.respond(JteContent("index.kte", params))
}