Skip to content
Server Plugin

CORS

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

코드 예제: cors

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

서버에서 교차 출처 요청(cross-origin requests)을 처리해야 하는 경우, Ktor의 CORS 플러그인을 설치하고 구성해야 합니다. 이 플러그인을 통해 허용할 호스트, HTTP 메서드, 클라이언트에서 설정한 헤더 등을 구성할 수 있습니다.

의존성 추가 ​

CORS을(를) 사용하려면 빌드 스크립트에 ktor-server-cors 아티팩트를 추가하세요:

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

CORS 설치 ​

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

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

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

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

CORS 플러그인을 특정 라우트에 설치하는 경우, 해당 라우트에 options 핸들러를 추가해야 합니다. 그래야 Ktor가 CORS 프리플라이트(preflight) 요청에 올바르게 응답할 수 있습니다.

CORS 구성 ​

CORS 관련 구성 설정은 CORSConfig 클래스를 통해 제공됩니다. 이러한 설정을 구성하는 방법을 살펴보겠습니다.

개요 ​

8080 포트에서 수신 대기 중인 서버가 있고, /customer 라우트가 JSON 데이터로 응답한다고 가정해 보겠습니다. 아래 코드 스니펫은 교차 출처 요청을 발생시키기 위해 다른 포트에서 실행 중인 클라이언트에서 Fetch API를 사용하여 보낸 샘플 요청을 보여줍니다:

javascript
function saveCustomer() {
    fetch('http://0.0.0.0:8080/customer',
        {
            headers: {
                'Accept': 'application/json',
                'Content-Type': 'application/json'
            },
            method: "POST",
            body: JSON.stringify({id: 3, firstName: "Jet", lastName: "Brains"})
        })
        .then(response => response.text())
        .then(data => {
            console.log('Success:', data);
            alert(data);
        })
        .catch((error) => {
            console.error('Error:', error);
        });
}

백엔드 측에서 이러한 요청을 허용하려면 다음과 같이 CORS 플러그인을 구성해야 합니다:

kotlin
install(CORS) {
    allowHost("0.0.0.0:8081")
    allowHeader(HttpHeaders.ContentType)
}

전체 예제는 여기에서 확인할 수 있습니다: cors.

호스트 ​

교차 출처 요청을 보낼 수 있는 허용 호스트를 지정하려면 allowHost 함수를 사용합니다. 호스트 이름 외에도 포트 번호, 서브도메인 목록 또는 지원되는 HTTP 스키마를 지정할 수 있습니다.

kotlin
install(CORS) {
    allowHost("client-host")
    allowHost("client-host:8081")
    allowHost("client-host", subDomains = listOf("en", "de", "es"))
    allowHost("client-host", schemes = listOf("http", "https"))
}

모든 호스트의 교차 출처 요청을 허용하려면 anyHost 함수를 사용합니다.

kotlin
install(CORS) {
    anyHost()
}

HTTP 메서드 ​

기본적으로 CORS 플러그인은 GET, POST, HEAD HTTP 메서드를 허용합니다. 추가 메서드를 추가하려면 allowMethod 함수를 사용합니다.

kotlin
install(CORS) {
    allowMethod(HttpMethod.Options)
    allowMethod(HttpMethod.Put)
    allowMethod(HttpMethod.Patch)
    allowMethod(HttpMethod.Delete)
}

허용 헤더 ​

기본적으로 CORS 플러그인은 Access-Control-Allow-Headers로 관리되는 다음 클라이언트 헤더를 허용합니다:

  • Accept
  • Accept-Language
  • Content-Language

추가 헤더를 허용하려면 allowHeader 함수를 사용합니다.

kotlin
install(CORS) {
    allowHeader(HttpHeaders.ContentType)
    allowHeader(HttpHeaders.Authorization)
}

커스텀 헤더를 허용하려면 allowHeaders 또는 allowHeadersPrefixed 함수를 사용합니다. 예를 들어 아래의 코드 스니펫은 custom-으로 시작하는 헤더를 허용하는 방법을 보여줍니다.

kotlin
install(CORS) {
    allowHeadersPrefixed("custom-")
}

단순하지 않은 콘텐츠 유형(non-simple content types)의 경우 allowHeaders 또는 allowHeadersPrefixed를 사용할 때 allowNonSimpleContentTypes 속성을 true로 설정해야 합니다.

노출 헤더 ​

Access-Control-Expose-Headers 헤더는 브라우저의 JavaScript가 접근할 수 있도록 지정된 헤더를 허용 목록(allowlist)에 추가합니다. 이러한 헤더를 구성하려면 exposeHeader 함수를 사용합니다.

kotlin
install(CORS) {
    // ...
    exposeHeader("X-My-Custom-Header")
    exposeHeader("X-Another-Custom-Header")
}

자격 증명 ​

기본적으로 브라우저는 교차 출처 요청 시 자격 증명 정보(쿠키 또는 인증 정보 등)를 전송하지 않습니다. 이러한 정보 전달을 허용하려면 allowCredentials 속성을 사용하여 Access-Control-Allow-Credentials 응답 헤더를 true로 설정합니다.

kotlin
install(CORS) {
    allowCredentials = true
}

기타 설정 ​

CORS 플러그인을 사용하면 기타 CORS 관련 설정도 지정할 수 있습니다. 예를 들어 maxAgeInSeconds를 사용하여 추가 프리플라이트 요청을 전송하지 않고 프리플라이트 요청에 대한 응답을 캐시할 수 있는 기간을 지정할 수 있습니다.

kotlin
install(CORS) {
    maxAgeInSeconds = 3600
}

다른 구성 옵션에 대한 자세한 내용은 CORSConfig에서 확인할 수 있습니다.