Skip to content
Server Plugin

Caching headers

필수 종속성: io.ktor:ktor-server-caching-headers

코드 예제: caching-headers

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

CachingHeaders 플러그인은 HTTP 캐싱에 사용되는 Cache-Control 및 Expires 헤더를 구성하는 기능을 추가합니다. 다음과 같은 방법으로 캐싱을 구성할 수 있습니다.

  • 이미지, CSS 및 JavaScript 파일 등과 같은 특정 콘텐츠 유형에 대해 서로 다른 캐싱 전략을 구성합니다.
  • 다양한 수준에서 캐싱 옵션을 지정합니다. 애플리케이션 수준에서 전역적으로 지정하거나, 라우트 수준에서 지정하거나, 특정 호출에 대해 지정할 수 있습니다.

종속성 추가 ​

CachingHeaders을(를) 사용하려면 빌드 스크립트에 ktor-server-caching-headers 아티팩트를 추가하세요.

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

CachingHeaders 설치 ​

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

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

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

CachingHeaders 플러그인은 특정 라우트에 설치할 수도 있습니다. 이는 애플리케이션의 서로 다른 리소스에 대해 각기 다른 CachingHeaders 구성이 필요한 경우 유용할 수 있습니다.

CachingHeaders을(를) 설치한 후에는 다양한 콘텐츠 유형에 대한 캐싱 설정을 구성할 수 있습니다.

캐싱 구성 ​

CachingHeaders 플러그인을 구성하려면 지정된 ApplicationCall 및 콘텐츠 유형에 대해 명시된 캐싱 옵션을 제공하도록 options 함수를 정의해야 합니다. caching-headers 예제의 코드 스니펫은 일반 텍스트 및 HTML에 max-age 옵션이 포함된 Cache-Control 헤더를 추가하는 방법을 보여줍니다.

kotlin
fun Application.module() {
    routing {
        install(CachingHeaders) {
            options { call, content ->
                when (content.contentType?.withoutParameters()) {
                    ContentType.Text.Plain -> CachingOptions(CacheControl.MaxAge(maxAgeSeconds = 3600))
                    ContentType.Text.Html -> CachingOptions(CacheControl.MaxAge(maxAgeSeconds = 60))
                    else -> null
                }
            }
        }
    }
}

CachingOptions 객체는 Cache-Control 및 Expires 헤더 값을 매개변수로 받습니다.

  • cacheControl 매개변수는 CacheControl 값을 받습니다. CacheControl.MaxAge를 사용하여 max-age 매개변수와 공개 범위(visibility), 재검증 옵션 등의 관련 설정을 지정할 수 있습니다. CacheControl.NoCache/CacheControl.NoStore를 사용하여 캐싱을 비활성화할 수 있습니다.
  • expires 매개변수를 사용하면 Expires 헤더를 GMTDate 또는 ZonedDateTime 값으로 지정할 수 있습니다.

라우트 수준 ​

플러그인은 전역적으로뿐만 아니라 특정 라우트에도 설치할 수 있습니다. 예를 들어, 아래 예제는 /index 라우트에 지정된 캐싱 헤더를 추가하는 방법을 보여줍니다.

kotlin
route("/index") {
    install(CachingHeaders) {
        options { call, content -> CachingOptions(CacheControl.MaxAge(maxAgeSeconds = 1800)) }
    }
    get {
        call.respondText("Index page")
    }
}

호출 수준 ​

더 세밀한 캐싱 설정이 필요한 경우, ApplicationCall.caching 속성을 사용하여 호출 수준에서 캐싱 옵션을 구성할 수 있습니다. 아래 예제는 사용자의 로그인 여부에 따라 캐싱 옵션을 구성하는 방법을 보여줍니다.

kotlin
route("/profile") {
    get {
        val userLoggedIn = true
        if(userLoggedIn) {
            call.caching = CachingOptions(CacheControl.NoStore(CacheControl.Visibility.Private))
            call.respondText("Profile page")
        } else {
            call.caching = CachingOptions(CacheControl.MaxAge(maxAgeSeconds = 900))
            call.respondText("Login page")
        }
    }
}

사용자 로그인 처리에는 Authentication 및 Sessions 플러그인을 사용할 수 있습니다.