[Ktor] 3. Response

Ktor Client 가이드 요약 정리

• Ktor Documents
• 기준 버전: 1.6.2
• 시리즈
  • 1. 클라이언트, Engine
  • 2. Request
  • 3. Response

Request를 생성하는 모든 함수(request, get, post, …)는 HttpResponse 객체를 반환한다.

Response body

Raw body

• String
• val httpResponse: HttpResponse = client.get("https://ktor.io/") val stringBody: String = httpResponse.receive()
• ByteArray
• val httpResponse: HttpResponse = client.get("https://ktor.io/") val byteArrayBody: ByteArray = httpResponse.receive()
• ByteArray 타입으로 받아서 파일로 저장하기 (실행 가능 예제 링크)

val client = HttpClient()
val file = File.createTempFile("files", "index")

runBlocking {
    val httpResponse: HttpResponse = client.get("https://ktor.io/") {
          // onDownload: download progress callback
        onDownload { bytesSentTotal, contentLength ->
            println("Received $bytesSentTotal bytes from $contentLength")
        }
    }
    val responseBody: ByteArray = httpResponse.receive()
    file.writeBytes(responseBody)
    println("A file saved to ${file.path}")
}

Json object

JSON 플러그인을 이용하면 JSON 데이터를 data class로 deserialize 가능하다.

val customer: Customer = client.get("http://127.0.0.1:8080/customer")

Streaming data

HttpResponse.receive 함수를 호출하면 Ktor는 응답을 메모리에서 처리하여 전체 response body를 반환한다. 전체 응답을 기다리는 것이 아닌, 순차적인 chunk를 얻으려면 HttpStatement를 반환하는 execute block을 이용한다.

val client = HttpClient(CIO)
val file = File.createTempFile("files", "index")

runBlocking {
    client.get<HttpStatement>("https://ktor.io/").execute { httpResponse ->
        val channel: ByteReadChannel = httpResponse.receive()
        while (!channel.isClosedForRead) {
            val packet = channel.readRemaining(DEFAULT_BUFFER_SIZE.toLong())
            while (!packet.isEmpty) {
                val bytes = packet.readBytes()
                file.appendBytes(bytes)
                println("Received ${file.length()} bytes from ${httpResponse.contentLength()}")
            }
        }
        println("A file saved to ${file.path}")
    }
}

Response parameters

HttpResponse 클래스는 status code, headers, HTTP version 등의 파라미터를 제공한다.

Status code

• HttpResponse.status 프로퍼티

Headers

• HttpResponse.headers 프로퍼티