FreeMarker
必要な依存関係: io.ktor:ktor-server-freemarker
コード例: freemarker
NativeサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✖️
Ktorでは、FreeMarkerプラグインをインストールすることで、アプリケーション内のビューとしてFreeMarkerテンプレートを使用できます。
依存関係の追加
FreeMarkerを使用するには、ビルドスクリプトにktor-server-freemarkerアーティファクトを追加します。
implementation(ktorLibs.server.freemarker)implementation ktorLibs.server.freemarker<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-freemarker-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>FreeMarkerのインストール
アプリケーションにFreeMarkerプラグインをインストールするには、指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内のinstall関数に渡します。 以下の例は、FreeMarkerをインストールする方法を示しています。
embeddedServer()関数の呼び出し内。Applicationクラスで明示的に定義されたmodule()拡張関数内。
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)
}import io.ktor.server.application.*
import io.ktor.server.freemarker.*
// ...
fun Application.module() {
install(FreeMarker)
// ...
}installブロック内では、FreeMarkerテンプレートを読み込むための目的のTemplateLoaderを設定できます。
FreeMarkerの設定
テンプレート読み込みの設定
テンプレートを読み込むには、templateLoaderプロパティに必要なTemplateLoader型を割り当てる必要があります。例えば、以下のコードスニペットにより、Ktorは現在のクラスパスを基準としてtemplatesパッケージ内のテンプレートを検索できるようになります。
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>
<body>
<h1>Hello, ${user.name}!</h1>
</body>
</html>ユーザーのデータモデルは以下のようになります。
data class User(val id: Int, val name: String)指定したルートでこのテンプレートを使用するには、次のようにcall.respondメソッドにFreeMarkerContentを渡します。
get("/index") {
val sampleUser = User(1, "John")
call.respond(FreeMarkerContent("index.ftl", mapOf("user" to sampleUser)))
}