티스토리 뷰
개요
OkHttp
는 Java, Kotlin 진영에서 가장 널리 쓰이고 있는 오픈 소스 HTTP 클라이언트 라이브러리이다. 직관적인 사용법과 함께 HTTP/2, TLS 1.3, GZIP, 커넥션 풀링 등 현존하는 라이브러리 중 가장 많은 기능을 제공한다.- OkHttp 4.x 버전부터 Java로 구현되었떤 코드를 전부 Kotlin으로 전환하였다. Kotlin 기반 프로젝트에서는 더욱 친화적인 사용이 가능해졌다.
build.gradle.kts
- OkHttp를 사용하기 위해 아래와 같이 종속성을 추가한다.
dependencies {
implementation("com.squareup.okhttp3:okhttp:4.9.1")
}
OkHttpClient 빈 설정
OkHttpClient
객체는 싱글턴 빈으로 재사용하면 효율을 높일 수 있다. 아래와 같이 빈을 설정할 수 있다.
package cc.remake.crolo.core.config
import okhttp3.OkHttpClient
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import java.util.concurrent.TimeUnit
@Configuration
class OkHttpConfig {
@Bean("okHttpClient")
fun okHttpClient(): OkHttpClient {
return OkHttpClient()
.newBuilder().apply {
// 서버 연결을 최대 10초 수행
connectTimeout(10, TimeUnit.SECONDS)
// 서버 요청을 최대 10초 수행
writeTimeout(10, TimeUnit.SECONDS)
// 서버 응답을 최대 10초 기다림
readTimeout(10, TimeUnit.SECONDS)
}.build()
}
}
ObjectMapper 빈 설정
- 원격지에 위치한 서버와 JSON 문자열을 주고 받으려면
ObjectMapper
빈이 요구된다. 설정 예는 아래와 같다.
import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.databind.SerializationFeature
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule
import com.fasterxml.jackson.module.kotlin.KotlinModule
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
@Configuration
class JsonConfig {
@Bean("objectMapper")
fun objectMapper(): ObjectMapper {
return Jackson2ObjectMapperBuilder.json()
.featuresToDisable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
.featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
.modules(KotlinModule(), JavaTimeModule())
.build()
}
}
JSON POST 요청 예
- 이제 원격지에 대한 호출 서비스를 작성할 차례이다. 아래는 기본적인 서비스와 뼈대와 함게 요청, 응답이 JSON인 요청을 작성하는 예이다.
import com.fasterxml.jackson.databind.ObjectMapper
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import org.springframework.stereotype.Service
@Service
class FooService(
private val okHttpClient: OkHttpClient,
private val objectMapper: ObjectMapper
) {
// POST 방식의 JSON 요청-응답 코드 작성
fun requestJSonPost(request: FooRequestDTO): FooResponseDTO {
// 요청 DTO를 JSON 문자열로 변환
val requestBody = objectMapper.writeValueAsString(request)
// 원격지에 대한 HTTP 요청 실행
val httpResponse = try {
okHttpClient.newCall(
Request.Builder()
.url("{request-url}")
.addHeader("{foo-request-header-name}", "{header-value}")
.post(requestBody.toRequestBody("application/json; charset=utf-8".toMediaType()))
.build()
).execute()
} catch (ex: Exception) {
// 요청 실패 예외 처리
}
// 상태 코드 획득
val statusCode: Int = httpResponse.code
// 특정 응답 헤더 획득
val fooResponseHeader: String? = httpResponse.header("{foo-response-header-name}")
// 응답 바디 획득, 크기가 가용 메모리보다 클 경우 OutOfMemoryError 발생
val responseBody: String? = httpResponse.body?.string()
if (!httpResponse.isSuccessful) {
// 요청 실패 응답 처리 로직 작성
}
val response = objectMapper.readValue(responseBody, FooResponseDTO::class.java)
// 요청 성공 응답 처리 로직 작성
return response
}
}
파일 다운로드 예
- 아래는 파일 다운로드의 예이다.
// 응답을 다운로드
httpResponse.body?.byteStream()?.copyTo(File("{file-path}").outputStream())
참고 글
댓글
최근에 올라온 글
최근에 달린 댓글
- Total
- Today
- Yesterday
링크
TAG
- chrome
- 구동계
- Kendo UI Web Grid
- jstl
- jsp
- maven
- CentOS
- JavaScript
- 평속
- DynamoDB
- 자전거
- Kendo UI
- spring
- 태그를 입력해 주세요.
- java
- 로드 바이크
- Spring MVC 3
- Spring Boot
- bootstrap
- jpa
- Eclipse
- kotlin
- 알뜰폰
- Docker
- node.js
- Tomcat
- JHipster
- graylog
- MySQL
- 로드바이크
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | ||||||
2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 31 |
글 보관함