[Android] OkHttp와 Retrofit

💡안드로이드 네트워크 통신을 위한 HTTP 클라이언트 라이브러리에 대하여 학습한 내용을 기록하였습니다.

 

개요

• OkHttp와 Retrofit은 안드로이드에서 네트워크 통신을 쉽게 처리할 수 있도록 도와주는 HTTP 클라이언트 라이브러리입니다.
• 둘 다 네트워크 요청을 관리하는 데 매우 유용하지만, Retrofit은 상위 레벨의 라이브러리로 OkHttp를 내부적으로 사용하며, 더 간단한 API를 제공하여 네트워크 작업을 쉽게 처리할 수 있도록 도와줍니다.
• OkHttp와 Retrofit을 학습하기 위해 필요한 개념을 함께 정리하였습니다.

HTTP

• HypeText Transfer Protocol의 약자로, 인터넷 상에서 HTML 문서와 같은 데이터를 링크 기반으로 주고받기 위한 프로토콜(통신 규약)입니다.
• 서버-킅라이언트 모델로 구분하며 전송 제어 프로토콜(TCP)과 인터넷 프로토콜(IP) 위에서 동작합니다.

HTTPS

• HTTP + Secure Socket(보안 통신)의 약자로 모든 통신 내용을 암호화하며, 공개키 암호화 방식을 사용합니다.

REST

• REST(Representational State Transfer)는 웹 서비스를 설계하는 데 사용되는 아키텍처 스타일입니다.
• REST는 인터넷에서 웹 서비스 간의 통신을 용이하게 하는 몇 가지 기본 원칙을 제시하는데, 이를 따르는 API를 REST API 또는 RESTful API라고 합니다.

API

• 정보 제공자가 제공하는 기능에 대해 응용 프로그램에서 할 수 있도록 만든 인터페이스입니다.

REST API

• Representational State Transfer API로 URI로 자원(이미지, 동영상, DB 데이터)을 표현하는 데에 집중하고, 자원의 상태(행위)에 대한 정의를 HTTP Method로 하는 아키텍처입니다.
  • HTTP Method : CRUD 작업 처리를 위한 메서드
• 클라이언트는 자원의 상태에 대한 조작을 요청하고 서버로부터 받은 응답인 JSON, XML로 이루어집니다.
• 이는 REST 아키텍처의 제약조건을 준수하는 API를 의미합니다.

OkHttp

• OkHttp는 HTTP 요청 및 응답을 처리하는 저수준의 HTTP 클라이언트 라이브러리입니다.
• 안드로이드에서 HTTP 통신을 할 때 사용되며, 네트워크 요청을 간소화하고 효율적인 네트워크 연결 재사용 및 캐싱 기능을 제공합니다.

https://square.github.io/okhttp/

Overview - OkHttp

주요 기능

• HTTP/2 및 SPDY 지원
  • 네트워크 연결 성능을 개선하고, 더 적은 대역폭을 사용합니다.
• 커넥션 풀
  • 네트워크 연결을 재사용하여 성능을 최적화합니다.
• 캐싱
  • 서버가 응답한 데이터를 로컬에 재사용하며, 네트워크 요청 수를 줄일 수 있습니다.
• 비동기 및 동기 요청
  • 비동기 네트워크 요청을 쉽게 처리할 수 있으며, 필요한 경우 동기 요청도 가능합니다.
• 인터셉터
  • 네트워크 요청 및 응답을 가로채서 로깅, 헤더 추가, 인증과 같은 작업을 쉽게 수행할 수 있습니다.

Gradle

• OkHttp를 사용하기 위해서 의존성을 추가합니다.

dependencies {
    implementation("com.squareup.okhttp3:okhttp:4.9.3")
}

• 동기 요청

val client = OkHttpClient()

val request = Request.Builder()
    .url("<https://api.example.com>")
    .build()

// 동기 요청
val response: Response = client.newCall(request).execute()
if (response.isSuccessful) {
    println(response.body?.string())
}

• 비동기 요청

val client = OkHttpClient()

val request = Request.Builder()
    .url("<https://api.example.com>")
    .build()

// 비동기 요청
client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        e.printStackTrace()
    }

    override fun onResponse(call: Call, response: Response) {
        if (response.isSuccessful) {
            println(response.body?.string())
        }
    }
})

Retrofit

• Retrofit은 OkHttp를 기반으로 만들어진 고수준의 HTTP 클라이언트 라이브러리입니다.
• REST API 호출을 매우 간단하게 처리할 수 있도록 설계되었으며, JSON 데이터를 자동으로 직렬화/역직렬화하고, 인터페이스 기반으로 네트워크 요청을 정의할 수 있어 코드가 훨씬 간결해집니다.
• RxJava나 Coroutine와 같은 비동기 작업 라이브러리와도 쉽게 통합할 수 있습니다.

https://square.github.io/retrofit/

Retrofit

주요 기능

• 인터페이스 기반 네트워크 요청
  • 인터페이스를 통해 네트워크 요청을 정의하고 사용하므로 코드가 간결합니다.
• 자동 직렬화 및 역직렬화
  • JSON 형식의 데이터를 자동으로 객체로 변환하고, 객체를 JSON으로 변환하는 작업을 처리합니다.
• OkHttp 통합
  • 내부적으로 OkHttp를 사용하여 네트워크 요청을 처리합니다.
• 비동기 네트워크 요청
  • Coroutines, RxJava, Callbacks를 통해 비동기 네트워크 요청을 쉽게 처리합니다.
• 커스터마이징
  • OkHttp와 언터셉터를 사용하여 요청과 응답을 조작할 수 있습니다.

Gradle

• Retrofit을 사용하기 위해서 의존성을 추가합니다.

dependencies {
    implementation("com.squareup.retrofit2:retrofit:2.9.0")
    implementation("com.squareup.retrofit2:converter-gson:2.9.0") // JSON 파싱용 GSON 컨버터
}

인터페이스 정의

• 인터페이스를 통해 네트워크 요청을 정의할 수 있습니다.

interface ApiService {
    @GET("users/{user}")
    suspend fun getUser(@Path("user") userId: String): UserResponse
}

Retrofit 인스턴스 생성 및 API 호출

val retrofit = Retrofit.Builder()
    .baseUrl("<https://api.example.com/>")
    .addConverterFactory(GsonConverterFactory.create()) // JSON 직렬화/역직렬화
    .build()

val apiService = retrofit.create(ApiService::class.java)

// Coroutines을 사용한 API 호출
GlobalScope.launch {
    val response = apiService.getUser("123")
    println(response)
}

OkHttp vs Retrofit

OkHttp와 Retrofit의 차이점

레벨	저수준의 HTTP 클라이언트 라이브러리	고수준의 REST API 클라이언트 라이브러리
API 정의 방식	직접 HTTP 요청 및 응답을 처리해야 함	인터페이스로 API 요청을 정의하고 자동 처리
직렬화/역직렬화	지원하지 않음 (직접 구현해야 함)	JSON 직렬화/역직렬화 자동 처리 (Gson 등과 통합)
비동기 처리	비동기 처리 가능 (enqueue() 사용)	Coroutines 및 RxJava와 자연스러운 통합 지원
인터셉터	네트워크 요청 및 응답을 가로채서 처리 가능	OkHttp의 인터셉터 기능을 그대로 사용할 수 있음
코드 복잡도	상대적으로 복잡함 (요청, 응답, JSON 처리 등을 수동으로 해야 함)	상대적으로 간단함 (인터페이스로 정의만 하면 자동 처리)

OkHttp를 사용하는 경우?

• 저수준의 HTTP 요청
• REST API가 아닌 다른 유형의 네트워크 요청
• 요청의 헤더나 파라미터를 커스텀

Retrofit을 사용하는 경우?

• RESTful API를 간편하게 호출
• JSON 데이터를 자동으로 직렬화/역직렬화할 때 사용
• 비동기 처리와 Coroutines, RxJava와 통합
• 인터페이스 기반 가독성 높은 코드

Retorfit과 OkHttp 결합

• Retrofit은 내부적으로 OkHttp를 사용하고 있으므로, 필요에 따라 결합하여 사용합니다.
• 두 방식을 결합하여 통신을 인터셉트 후 변환하는 작업을 하고 있습니다.

val okHttpClient = OkHttpClient.Builder()
    .addInterceptor { chain ->
        val request = chain.request().newBuilder()
            .addHeader("Authorization", "Bearer token")
            .build()
        chain.proceed(request)
    }
    .build()

val retrofit = Retrofit.Builder()
    .baseUrl("<https://api.example.com/>")
    .client(okHttpClient) // OkHttp 클라이언트 추가
    .addConverterFactory(GsonConverterFactory.create())
    .build()

val apiService = retrofit.create(ApiService::class.java)

결론

• OkHttp는 저수준에서 HTTP 요청, 응답을 세밀하게 제어하는 경우 적합하며, 웹 소켓, 스트리밍 등 다양한 HTTP 작업을 처리할 때 유용합니다.
• Retrofit은 RESTful API 통신을 간편하게 할 수 있도록 하며, JSON 직렬화/역직렬화, 비동기 처리를 간단하게 구현할 수 있습니다.

참고

https://velog.io/@ilil1/OkHttp-와-Retrofit