Skip to content
Server Plugin

Thymeleaf

필요한 의존성: io.ktor:ktor-server-thymeleaf

코드 예제: thymeleaf

네이티브 서버Ktor는 Kotlin/Native를 지원하므로 추가 런타임이나 가상 머신 없이도 서버를 실행할 수 있습니다. 지원: ✖️

Ktor에서는 Thymeleaf 플러그인을 설치하여 애플리케이션 내에서 Thymeleaf 템플릿을 뷰로 사용할 수 있습니다.

의존성 추가 ​

Thymeleaf을(를) 사용하려면 빌드 스크립트에 ktor-server-thymeleaf 아티팩트를 추가합니다:

kotlin
implementation(ktorLibs.server.thymeleaf)
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
groovy
implementation ktorLibs.server.thymeleaf
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-thymeleaf-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

Thymeleaf 설치 ​

애플리케이션에 Thymeleaf 플러그인을 설치하려면, 지정된 모듈모듈을 사용하면 라우트를 그룹화하여 애플리케이션의 구조를 설계할 수 있습니다.의 install 함수에 전달하세요. 다음 예제는 Thymeleaf을 설치하는 방법을 보여줍니다:

  • embeddedServer() 함수 호출 내부에서 설치.
  • Application 클래스에 명시적으로 정의된 module() 확장 함수 내부에서 설치.
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.thymeleaf.*

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

Thymeleaf 구성 ​

템플릿 로딩 구성 ​

install 블록 내에서 ClassLoaderTemplateResolver를 구성할 수 있습니다. 예를 들어, 아래 코드 스니펫은 Ktor가 현재 클래스패스를 기준으로 templates 패키지에서 *.html 템플릿을 찾을 수 있도록 설정합니다:

kotlin
import io.ktor.server.application.*
import io.ktor.server.thymeleaf.*
import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver

fun Application.module() {
    install(Thymeleaf) {
        setTemplateResolver(ClassLoaderTemplateResolver().apply {
            prefix = "templates/"
            suffix = ".html"
            characterEncoding = "utf-8"
        })
    }
}

응답으로 템플릿 전송 ​

resources/templates에 다음과 같은 index.html 템플릿이 있다고 가정해 보겠습니다:

html
<html xmlns:th="http://www.thymeleaf.org">
    <body>
        <h1 th:text="'Hello, ' + ${user.name}"></h1>
    </body>
</html>

사용자에 대한 데이터 모델은 다음과 같습니다:

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

지정된 라우트에 템플릿을 사용하려면 다음과 같이 call.respond 메서드에 ThymeleafContent를 전달하세요:

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

예제: Thymeleaf 템플릿 자동 다시 로드 ​

아래 예제는 개발 모드를 사용할 때 Thymeleaf 템플릿을 자동으로 다시 로드하는 방법을 보여줍니다.

kotlin
package com.example

import io.ktor.server.application.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import io.ktor.server.thymeleaf.*
import org.thymeleaf.templateresolver.*

fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)

fun Application.module() {
    install(Thymeleaf) {
        setTemplateResolver((if (developmentMode) {
            FileTemplateResolver().apply {
                cacheManager = null
                prefix = "src/main/resources/templates/"
            }
        } else {
            ClassLoaderTemplateResolver().apply {
                prefix = "templates/"
            }
        }).apply {
            suffix = ".html"
            characterEncoding = "utf-8"
        })
    }
    routing {
        get("/index") {
            val sampleUser = User(1, "John")
            call.respond(ThymeleafContent("index", mapOf("user" to sampleUser)))
        }
    }
}

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

전체 예제는 여기에서 확인할 수 있습니다: thymeleaf-auto-reload.