Android REST API(Retrofit) 연동 - 네트워크 통신과 데이터 파싱

안녕하세요, 오늘은 안드로이드 애플리케이션에서 Retrofit 라이브러리를 사용하여 REST API와 통신하는 방법에 대해 알아보겠습니다. Retrofit은 Square에서 제공하는 HTTP 클라이언트 라이브러리로, 안드로이드에서 네트워크 작업을 손쉽게 처리할 수 있게 도와줍니다. Retrofit을 사용하면 서버와의 통신 및 JSON 형식의 데이터를 파싱하는 과정을 간단하게 구현할 수 있습니다. 이번 포스팅에서는 Retrofit을 사용하여 간단한 REST API 호출과 데이터 파싱을 다루는 방법을 예제를 통해 알아보겠습니다.

1. Retrofit 라이브러리 설정

1.1 Gradle 의존성 추가

Retrofit을 사용하기 위해서는 먼저 앱 모듈의 build.gradle 파일에 Retrofit과 관련 라이브러리를 추가해야 합니다.

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
}

• retrofit 의존성은 Retrofit 라이브러리 자체를 포함하고 있습니다.
• converter-gson은 JSON 데이터를 자바 객체로 변환해주는 GSON 변환기입니다.

2. Retrofit 인터페이스 정의하기

Retrofit에서는 서버와 통신하기 위해 인터페이스를 정의해야 합니다. 이 인터페이스에서 API 호출을 정의합니다.

예를 들어, JSONPlaceholder라는 공개 API에서 사용자의 정보를 가져오는 메서드를 정의한다고 가정해 보겠습니다.

import retrofit2.Call
import retrofit2.http.GET

interface ApiService {
    @GET("users")
    fun getUsers(): Call<List<User>>
}

• @GET("users") : 서버의 /users 경로에 GET 요청을 보냅니다.
• Call<List<User>> : 반환 타입은 사용자 리스트를 포함하는 Call 객체입니다.

3. 데이터 모델 정의하기

서버에서 받아온 데이터를 Kotlin 객체로 변환해야 합니다. Retrofit은 GSON을 사용해 JSON 데이터를 자동으로 매핑해줍니다. 여기서는 User라는 데이터 모델 클래스를 정의합니다.

data class User(
    val id: Int,
    val name: String,
    val username: String,
    val email: String
)

이 클래스는 서버에서 받아온 JSON 데이터의 필드와 동일한 이름으로 정의되어 있어야 합니다.

4. Retrofit 인스턴스 생성

Retrofit을 사용하려면 Retrofit 인스턴스를 생성해야 합니다. 이 과정에서 API의 기본 URL을 지정해주고, JSON 변환기를 추가해야 합니다.

import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory

object RetrofitClient {
    private const val BASE_URL = "https://jsonplaceholder.typicode.com/"

    val retrofit: Retrofit = Retrofit.Builder()
        .baseUrl(BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .build()

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

• baseUrl(BASE_URL) : API의 기본 URL을 설정합니다.
• addConverterFactory(GsonConverterFactory.create()) : JSON 데이터를 Kotlin 객체로 변환하기 위해 GSON 변환기를 추가합니다.

5. API 호출과 데이터 처리

Retrofit 인스턴스를 이용해 API 호출을 진행하고, 받아온 데이터를 UI에 표시해 보겠습니다.

import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import retrofit2.Call
import retrofit2.Callback
import retrofit2.Response

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        fetchUsers()
    }

    private fun fetchUsers() {
        val call = RetrofitClient.apiService.getUsers()

        call.enqueue(object : Callback<List<User>> {
            override fun onResponse(call: Call<List<User>>, response: Response<List<User>>) {
                if (response.isSuccessful) {
                    val userList = response.body()
                    userList?.let {
                        for (user in it) {
                            Log.d("MainActivity", "User: ${user.name}, Email: ${user.email}")
                        }
                    }
                } else {
                    Log.e("MainActivity", "Response failed: ${response.code()}")
                }
            }

            override fun onFailure(call: Call<List<User>>, t: Throwable) {
                Log.e("MainActivity", "Network Error: ${t.message}")
            }
        })
    }
}

• fetchUsers() 메서드는 getUsers() API 호출을 수행합니다.
• call.enqueue() 메서드는 비동기 방식으로 API 요청을 수행하며, 성공 또는 실패 여부를 처리하는 콜백 메서드를 정의합니다.
• onResponse() : API 호출이 성공적으로 완료되면 서버의 응답 데이터를 처리합니다.
• onFailure() : 네트워크 오류 등의 이유로 호출이 실패했을 때 호출됩니다.

6. 전체 코드

이제 모든 코드를 하나로 합쳐 보겠습니다.

// User 데이터 클래스
data class User(
    val id: Int,
    val name: String,
    val username: String,
    val email: String
)

// Retrofit 인터페이스 정의
import retrofit2.Call
import retrofit2.http.GET

interface ApiService {
    @GET("users")
    fun getUsers(): Call<List<User>>
}

// Retrofit 인스턴스 생성
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory

object RetrofitClient {
    private const val BASE_URL = "https://jsonplaceholder.typicode.com/"

    val retrofit: Retrofit = Retrofit.Builder()
        .baseUrl(BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .build()

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

// MainActivity에서 API 호출
import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import retrofit2.Call
import retrofit2.Callback
import retrofit2.Response

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        fetchUsers()
    }

    private fun fetchUsers() {
        val call = RetrofitClient.apiService.getUsers()

        call.enqueue(object : Callback<List<User>> {
            override fun onResponse(call: Call<List<User>>, response: Response<List<User>>) {
                if (response.isSuccessful) {
                    val userList = response.body()
                    userList?.let {
                        for (user in it) {
                            Log.d("MainActivity", "User: ${user.name}, Email: ${user.email}")
                        }
                    }
                } else {
                    Log.e("MainActivity", "Response failed: ${response.code()}")
                }
            }

            override fun onFailure(call: Call<List<User>>, t: Throwable) {
                Log.e("MainActivity", "Network Error: ${t.message}")
            }
        })
    }
}

7. 결론

이번 포스팅에서는 Retrofit을 사용하여 REST API와 통신하는 방법에 대해 알아보았습니다. Retrofit을 통해 네트워크 요청을 간단하게 처리하고, JSON 데이터를 손쉽게 Kotlin 객체로 변환하여 사용할 수 있었습니다. Retrofit은 또한 enqueue 메서드를 통해 비동기 요청을 간편하게 지원하므로, 안드로이드 애플리케이션에서 서버와 통신할 때 매우 유용한 도구입니다.

Retrofit을 활용하면 다양한 API를 쉽게 통합하고, 서버와의 데이터 전송을 효과적으로 처리할 수 있습니다. 앞으로도 다양한 예제를 통해 Retrofit의 다른 기능들에 대해서도 다뤄보겠습니다.