Skip to content
Server Plugin

Velocity

필수 의존성: io.ktor:ktor-server-velocity

코드 예제: velocity

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

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

의존성 추가 ​

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

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

Velocity 설치 ​

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

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

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

선택 사항으로, VelocityTools 플러그인을 설치하여 표준 및 커스텀 Velocity 도구를 추가하는 기능을 활성화할 수도 있습니다.

Velocity 설정 ​

템플릿 로딩 설정 ​

install 블록 내에서 VelocityEngine을 구성할 수 있습니다. 예를 들어 클래스패스(classpath)의 템플릿을 사용하려면 classpath용 리소스 로더를 사용합니다:

kotlin
import io.ktor.server.application.*
import io.ktor.server.velocity.*
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader
import org.apache.velocity.runtime.RuntimeConstants

fun Application.module() {
    install(Velocity) {
        setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath")
        setProperty("classpath.resource.loader.class", ClasspathResourceLoader::class.java.name)
    }
}

응답으로 템플릿 전송 ​

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

html
<html>
    <body>
        <h1>Hello, $user.name</h1>
    </body>
</html>

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

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

지정된 라우트(route)에 템플릿을 사용하려면 다음과 같이 VelocityContent를 call.respond 메서드에 전달합니다:

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

Velocity 도구 추가 ​

VelocityTools 플러그인을 설치했다면, install 블록 내에서 EasyFactoryConfiguration 인스턴스에 접근하여 표준 및 커스텀 Velocity 도구를 추가할 수 있습니다. 예를 들면 다음과 같습니다:

kotlin
install(VelocityTools) {
    engine {
        // 엔진 설정
        setProperty("resource.loader", "string")
        addProperty("resource.loader.string.name", "myRepo")
        addProperty("resource.loader.string.class", StringResourceLoader::class.java.name)
        addProperty("resource.loader.string.repository.name", "myRepo")
    }
    addDefaultTools() // 기본 도구 추가
    tool("foo", MyCustomTool::class.java) // 커스텀 도구 추가
}