Open AIDoc

한국어

简体中文
繁體中文
日本語

한국어

简体中文
繁體中文
日本語

Appearance

Server Plugin

세션(Sessions

[//]: # (title: 세션(Sessions))

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

코드 예제: session-cookie-client, session-cookie-server, session-header-server

Native 서버
Ktor는 Kotlin/Native를 지원하며 추가 런타임이나 가상 머신 없이 서버를 실행할 수 있게 해줍니다.
지원: ✅

Sessions 플러그인은 서로 다른 HTTP 요청 간에 데이터를 유지하기 위한 메커니즘을 제공합니다. 일반적인 사용 사례로는 로그인한 사용자의 ID 저장, 장바구니 내용 보관 또는 클라이언트에 사용자 기본 설정 유지 등이 있습니다. Ktor에서는 쿠키나 커스텀 헤더를 사용하여 세션을 구현할 수 있으며, 세션 데이터를 서버에 저장할지 클라이언트에 전달할지 선택할 수 있고, 세션 데이터의 서명 및 암호화 등을 수행할 수 있습니다.

이 주제에서는 Sessions 플러그인을 설치하고 설정하는 방법과 라우트 핸들러 내부에서 세션 데이터에 액세스하는 방법을 살펴보겠습니다.

의존성 추가 ​

세션 지원을 활성화하려면 빌드 스크립트에 ktor-server-sessions 아티팩트를 포함해야 합니다.

Kotlin
Groovy
XML

Sessions 설치 ​

애플리케이션에 Sessions 플러그인을 설치하려면, 지정된

모듈
모듈을 사용하면 라우트를 그룹화하여 애플리케이션을 구조화할 수 있습니다.
의 install 함수에 전달하세요. 아래 코드 스니펫은 Sessions을 설치하는 방법을 보여줍니다...

  • ... embeddedServer 함수 호출 내부에서 설치.
  • ... Application 클래스의 확장 함수인 명시적으로 정의된 module 내부에서 설치.
kotlin
kotlin

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

세션 설정 개요 ​

Sessions 플러그인을 구성하려면 다음 단계를 수행해야 합니다.

  1. 데이터 클래스 생성: 세션을 구성하기 전에 세션 데이터를 저장하기 위한 데이터 클래스를 생성해야 합니다.

  2. 서버와 클라이언트 간에 데이터를 전달하는 방법 선택: 쿠키 또는 커스텀 헤더를 사용합니다. 쿠키는 일반 HTML 애플리케이션에 더 적합하며, 커스텀 헤더는 API를 위한 것입니다.

  3. 세션 페이로드를 저장할 위치 선택: 클라이언트 또는 서버에 저장합니다. 직렬화된 세션 데이터를 쿠키/헤더 값을 사용하여 클라이언트에 전달하거나, 페이로드를 서버에 저장하고 세션 식별자만 전달할 수 있습니다.

    세션 페이로드를 서버에 저장하려는 경우, 저장 방법을 선택할 수 있습니다: 서버 메모리 또는 폴더에 저장합니다. 세션 데이터를 보관하기 위해 커스텀 저장소를 구현할 수도 있습니다.

  4. 세션 데이터 보호: 클라이언트에 전달되는 민감한 세션 데이터를 보호하려면 세션 페이로드를 서명하고 암호화해야 합니다.

After configuring Sessions을 설정한 후에는 라우트 핸들러 내부에서 세션 데이터를 가져오고 설정할 수 있습니다.

데이터 클래스 생성 ​

세션을 구성하기 전에 세션 데이터를 저장하기 위한 데이터 클래스를 생성해야 합니다. 예를 들어, 아래의 UserSession 클래스는 세션 ID와 페이지 조회수를 저장하는 데 사용됩니다.

kotlin
@Serializable
data class UserSession(val id: String, val count: Int)

여러 세션을 사용하려는 경우 여러 데이터 클래스를 생성해야 합니다.

쿠키를 사용하여 세션 데이터를 전달하려면 install(Sessions) 블록 내에서 지정된 이름과 데이터 클래스를 사용하여 cookie 함수를 호출하세요.

kotlin
install(Sessions) {
    cookie<UserSession>("user_session")
}

위의 예에서 세션 데이터는 Set-Cookie 헤더에 추가된 user_session 속성을 사용하여 클라이언트에 전달됩니다. cookie 블록 내에서 다른 쿠키 속성을 구성할 수 있습니다. 예를 들어, 아래 코드 스니펫은 쿠키의 경로와 만료 시간을 지정하는 방법을 보여줍니다.

kotlin
install(Sessions) {
    cookie<UserSession>("user_session") {
        cookie.path = "/"
        cookie.maxAgeInSeconds = 10
    }
}

필요한 속성이 명시적으로 노출되지 않은 경우 extensions 속성을 사용하세요. 예를 들어, 다음과 같은 방식으로 SameSite 속성을 전달할 수 있습니다.

kotlin
install(Sessions) {
    cookie<UserSession>("user_session") {
        cookie.extensions["SameSite"] = "lax"
    }
}

사용 가능한 구성 설정에 대해 자세히 알아보려면 CookieConfiguration을 참조하세요.

애플리케이션을 운영 환경에 배포하기 전에 secure 속성이 true로 설정되어 있는지 확인하세요. 이는 보안 연결(SSL)을 통해서만 쿠키를 전송할 수 있게 하며 HTTPS 다운그레이드 공격으로부터 세션 데이터를 보호합니다.

커스텀 헤더를 사용하여 세션 데이터를 전달하려면 install(Sessions) 블록 내에서 지정된 이름과 데이터 클래스를 사용하여 header 함수를 호출하세요.

kotlin
install(Sessions) {
    header<CartSession>("cart_session")
}

위의 예에서 세션 데이터는 cart_session 커스텀 헤더를 사용하여 클라이언트에 전달됩니다. 클라이언트 측에서는 세션 데이터를 가져오기 위해 각 요청에 이 헤더를 추가해야 합니다.

CORS 플러그인을 사용하여 교차 출처 요청을 처리하는 경우, 다음과 같이 CORS 구성에 커스텀 헤더를 추가하세요.

kotlin
install(CORS) {
    allowHeader("cart_session")
    exposeHeader("cart_session")
}

수정된 경우에만 세션 데이터 전송 ​

기본적으로 Ktor는 세션 데이터가 변경되지 않았더라도 모든 응답에 세션 데이터를 전송합니다.

세션 데이터가 수정된 경우에만 전송하려면 세션 구성에서 sendOnlyIfModified 플래그를 활성화하세요.

kotlin
install(Sessions) {
    cookie<MySession>("SESSION") {
        sendOnlyIfModified = true
    }
}

이 옵션은 쿠키 및 헤더 기반 세션 모두에서 사용할 수 있습니다.

세션 페이로드 저장: 클라이언트 vs 서버 ​

Ktor에서는 두 가지 방식으로 세션 데이터를 관리할 수 있습니다.

  • 클라이언트와 서버 간에 세션 데이터 전달.

    쿠키 또는 헤더 함수에 세션 이름만 전달하면 세션 데이터가 클라이언트와 서버 간에 직접 전달됩니다. 이 경우 클라이언트에 전달되는 민감한 세션 데이터를 보호하기 위해 세션 페이로드를 서명 및 암호화해야 합니다.

  • 서버에 세션 데이터를 저장하고 클라이언트와 서버 간에는 세션 ID만 전달.

    이 경우 서버의 페이로드 저장 위치를 선택할 수 있습니다. 예를 들어 세션 데이터를 메모리, 지정된 폴더에 저장하거나 고유한 커스텀 저장소를 구현할 수 있습니다.

서버에 세션 페이로드 저장 ​

Ktor를 사용하면 세션 데이터를 서버에 저장하고 서버와 클라이언트 간에는 세션 ID만 전달할 수 있습니다. 이 경우 서버에서 페이로드를 보관할 위치를 선택할 수 있습니다.

인메모리 저장소(In-memory storage) ​

SessionStorageMemory를 사용하면 세션 콘텐츠를 메모리에 저장할 수 있습니다. 이 저장소는 서버가 실행되는 동안 데이터를 유지하며 서버가 중지되면 정보를 삭제합니다. 예를 들어 다음과 같이 서버 메모리에 쿠키를 저장할 수 있습니다.

kotlin
cookie<CartSession>("cart_session", SessionStorageMemory()) {
}

전체 예제는 여기에서 확인할 수 있습니다: session-cookie-server.

SessionStorageMemory는 개발 용도로만 사용해야 합니다.

디렉터리 저장소(Directory storage) ​

directorySessionStorage를 사용하여 지정된 디렉터리의 파일에 세션 데이터를 저장할 수 있습니다. 예를 들어, build/.sessions 디렉터리의 파일에 세션 데이터를 저장하려면 다음과 같이 directorySessionStorage를 생성합니다.

kotlin
header<CartSession>("cart_session", directorySessionStorage(File("build/.sessions"))) {
}

전체 예제는 여기에서 확인할 수 있습니다: session-header-server.

커스텀 저장소(Custom storage) ​

Ktor는 커스텀 저장소를 구현할 수 있는 SessionStorage 인터페이스를 제공합니다.

kotlin
interface SessionStorage {
    suspend fun invalidate(id: String)
    suspend fun write(id: String, value: String)
    suspend fun read(id: String): String
}

세 함수 모두 중단(suspending) 함수입니다. SessionStorageMemory를 참고용으로 활용할 수 있습니다.

세션 데이터 보호 ​

세션 데이터 서명 ​

세션 데이터 서명은 세션 콘텐츠 수정을 방지하지만 사용자가 해당 콘텐츠를 볼 수는 있게 합니다. 세션에 서명하려면 SessionTransportTransformerMessageAuthentication 생성자에 서명 키를 전달하고 이 인스턴스를 transform 함수에 전달하세요.

kotlin
install(Sessions) {
    val secretSignKey = hex("6819b57a326945c1968f45236589")
    cookie<CartSession>("cart_session", SessionStorageMemory()) {
        cookie.path = "/"
        transform(SessionTransportTransformerMessageAuthentication(secretSignKey))
    }
}

SessionTransportTransformerMessageAuthentication은 기본 인증 알고리즘으로 HmacSHA256을 사용하며, 이는 변경할 수 있습니다.

세션 데이터 서명 및 암호화 ​

세션 데이터를 서명하고 암호화하면 세션 콘텐츠를 읽거나 수정하는 것을 방지할 수 있습니다. 세션을 서명하고 암호화하려면 SessionTransportTransformerEncrypt 생성자에 서명/암호화 키를 전달하고 이 인스턴스를 transform 함수에 전달하세요.

kotlin
install(Sessions) {
    val secretEncryptKey = hex("00112233445566778899aabbccddeeff")
    val secretSignKey = hex("6819b57a326945c1968f45236589")
    cookie<UserSession>("user_session") {
        cookie.path = "/"
        cookie.maxAgeInSeconds = 10
        transform(SessionTransportTransformerEncrypt(secretEncryptKey, secretSignKey))
    }
}

Ktor 버전 3.0.0에서 세션 암호화 방식이 업데이트되었습니다. 이전 버전에서 마이그레이션하는 경우, 기존 세션과의 호환성을 보장하기 위해 SessionTransportTransformerEncrypt 생성자에서 backwardCompatibleRead 속성을 사용하세요.

기본적으로 SessionTransportTransformerEncrypt는 AES 및 HmacSHA256 알고리즘을 사용하며, 이는 변경할 수 있습니다.

서명/암호화 키는 코드에 직접 명시해서는 안 됩니다. 구성 파일에서 커스텀 그룹을 사용하여 서명/암호화 키를 저장하고 환경 변수를 사용하여 초기화할 수 있습니다.

세션 콘텐츠 가져오기 및 설정 ​

특정 라우트에 대한 세션 콘텐츠를 설정하려면 call.sessions 속성을 사용하세요. set 메서드를 사용하면 새로운 세션 인스턴스를 생성할 수 있습니다.

kotlin
get("/login") {
    call.sessions.set(UserSession(id = "123abc", count = 0))
    call.respondRedirect("/user")
}

세션 콘텐츠를 가져오려면 등록된 세션 유형 중 하나를 타입 파라미터로 받는 get을 호출할 수 있습니다.

kotlin
get("/user") {
    val userSession = call.sessions.get<UserSession>()
    if (userSession != null) {
}

세션을 수정하려면(예: 카운터 증가), 데이터 클래스의 copy 메서드를 호출해야 합니다.

kotlin
get("/user") {
    val userSession = call.sessions.get<UserSession>()
    if (userSession != null) {
        call.sessions.set(userSession.copy(count = userSession.count + 1))
        call.respondText("Session ID is ${userSession.id}. Reload count is ${userSession.count}.")
    } else {
        call.respondText("Session doesn't exist or is expired.")
    }
}

어떤 이유로든(예: 사용자가 로그아웃할 때) 세션을 삭제해야 하는 경우 clear 함수를 호출하세요.

kotlin
get("/logout") {
    call.sessions.clear<UserSession>()
    call.respondRedirect("/user")
}

전체 예제는 여기에서 확인할 수 있습니다: session-cookie-client.

세션 지연 조회(Deferred session retrieval) ​

기본적으로 Ktor는 라우트에서 실제로 세션이 필요한지 여부와 관계없이 세션이 포함된 모든 요청에 대해 저장소에서 세션을 읽으려고 시도합니다. 이 동작은 특히 커스텀 세션 저장소를 사용하는 애플리케이션에서 불필요한 오버헤드를 발생시킬 수 있습니다.

io.ktor.server.sessions.deferred 시스템 속성을 활성화하여 세션 로딩을 지연시킬 수 있습니다.

kotlin
System.setProperty("io.ktor.server.sessions.deferred", "true")

예제 ​

아래의 실행 가능한 예제들은 Sessions 플러그인을 사용하는 방법을 보여줍니다.

Copyright © 2026 Open AIDoc.