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))
}