Android Retrofit으로 데이터를 받는방법들

김성환·2024년 4월 25일

Response android call coroutine observable retrofit

안드로이드 개발환경에서 RestApi의 get방식으로 데이터를받아야할때가 있습니다. 이러한경우 대부분 Rerofit을 이용하여 웹서버에 데이터를 받아옵니다. 이제 여기서 개발자는 선택을 할수있습니다. Call 클래스를 이용하여 콜백으로 처리할것인지 Response클래스를 이용하여 데이터를 처리할것인지 Rx의 Observable를 이용하여 처리할것인지, 아니면 코루틴을 사용할것인지등 현재프로젝트의 규모나 개발환경에따라 여러방식으로 구현할수 있습니다. 그렇다면 각 구현방법의 장점과 단전을 알아보며 어떨때 해당방법을 처리해야될 알아가보도록 합시다.

Call 클래스를 이용한 콜백 처리

interface ApiService {
    @GET("users/{username}")
    fun getUser(@Path("username") username: String): Call<User>
}

data class User(
    val username: String,
    val email: String
)

object RetrofitClient {
    private const val BASE_URL = "your_base_url"

    val apiService: ApiService by lazy {
        val retrofit = Retrofit.Builder()
            .baseUrl(BASE_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build()

        retrofit.create(ApiService::class.java)
    }
}

RetrofitClient.apiService.getUser(userName)
	.enqueue(object : Callback<Void>{
		override fun onResponse(call: Call<User>, response: Response<User>) {
        	if (response.isSuccessful){ 
            	//... 
            } else {
            	//...
            }
        }
        override fun onFailure(call: Call<User>, t: Throwable) {
           	Log.e(TAG, t.toString())
        }
 })

Call을 enqueue메서드를 이용하여 비동기적으로 실행하고 Callback을 집어넣어 결과에따른 처리를 수행할수 있음

장점

간단한 구현: Call 클래스는 Retrofit의 기본 방식이므로 구현이 간단합니다.
콜백을 통한 비동기 처리: 비동기적으로 데이터를 받아올 수 있어 UI를 블로킹하지 않고 처리할 수 있습니다.

단점

콜백 지옥 가능성: 콜백 중첩이 발생할 수 있으며, 이는 코드를 복잡하게 만들고 유지보수를 어렵게 할 수 있습니다.
오류 처리가 어려울 수 있음: 네트워크 오류나 예외 상황에 대한 처리가 번거로울 수 있습니다.

Response 클래스를 이용한 데이터 처리

data class User(val id: Int, val username: String, val email: String) // 예시 사용자 모델

interface ApiService {
    @GET("users/{username}")
    suspend fun getUser(@Path("username") username: String): Response<User>
}

object RetrofitClient {
    private const val BASE_URL = "your_base_url"

    val apiService: ApiService by lazy {
        val retrofit = Retrofit.Builder()
            .baseUrl(BASE_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build()

        retrofit.create(ApiService::class.java)
    }
}

suspend fun fetchUser(username: String): Response<User> {
    return try {
        RetrofitClient.apiService.getUser(username)
    } catch (e: Exception) {
        // 예외 처리
        Response.error("Unknown error", null)
    }
}

withContext(Dispatchers.IO) {
        val response = fetchUser(username)
        if (response.isSuccessful) {
            val user = response.body()
            // 받아온 사용자 데이터 처리
        } else {
            // 서버로부터 오류 응답을 받았을 때 처리
            // response.errorBody()를 이용하여 오류 응답의 내용을 확인할 수 있습니다.
        }
    }

Response클래스의 경우 중단함수를 이용합니다. 중단함수를 이용한다는것은 코루틴을 사용한다는 말이기도 합니다. suspend를 사용하기에 콜백처리를 하지않고도 해당 결과만 가져올수있어 간편하다는 장점이 있습니다.

장점

간단한 데이터 처리: Response 클래스를 통해 바로 데이터를 추출하여 처리할 수 있습니다.
동기적 처리 가능: 동기적으로 데이터를 받아올 수 있어 순차적인 처리가 필요한 경우 유용합니다.

단점

비동기 처리 어려움: 동기적 처리 방식이므로 UI를 블로킹할 수 있으며, 대규모 애플리케이션에서는 성능 문제가 발생할 수 있습니다.
오류 처리가 번거로움: 네트워크 오류나 예외 상황에 대한 처리가 Call 클래스보다 복잡할 수 있습니다.

이러한 단점들은 sealed 클래스를 이용하여 에러를 관리하거나 비동기처리의 경우 데이터를 바로 받아 사용하는것이 아닌 LiveData나 Flow같은 관찰가능한 객채를 이용하여 단점을 보완할수 있습니다.

Rx의 Observable을 이용한 처리

data class User(val id: Int, val username: String, val email: String) // 예시 사용자 모델

interface ApiService {
    @GET("users/{username}")
    fun getUser(@Path("username") username: String): Observable<User>
}

object RetrofitClient {
    private const val BASE_URL = "your_base_url"

    val apiService: ApiService by lazy {
        val retrofit = Retrofit.Builder()
            .baseUrl(BASE_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build()

        retrofit.create(ApiService::class.java)
    }
}

fun fetchUser(username: String): Disposable {
    return RetrofitClient.apiService.getUser(username)
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe({ user ->
            // 성공적으로 데이터를 받아왔을 때 처리
            // user 객체를 사용하여 UI 업데이트 등을 수행
        }, { error ->
            // 오류가 발생했을 때 처리
            // error 객체를 사용하여 오류 메시지를 표시하거나 기타 작업 수행
        })
}

class MainActivity : AppCompatActivity() {

    private var disposable: Disposable? = null

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

        val username = "example_username"
        disposable = fetchUser(username)
    }

    override fun onDestroy() {
        super.onDestroy()
        disposable?.dispose() // 메모리 누수를 방지하기 위해 Disposable을 해제합니다.
    }
}

Observable을 사용하여 Retrofit을 통해 데이터를 가져오고, 이를 비동기적으로 처리할 수 있습니다. 코드를 통해 각각의 스레드에서 작업이 수행되고, 마지막에는 메인 스레드로 결과가 전달되어 UI를 업데이트할 수 있음

장점

비동기 및 이벤트 기반 처리: Rx의 Observable을 사용하면 비동기적으로 데이터를 받아오고, 이벤트 기반으로 처리할 수 있습니다.
연산자 사용으로 강력한 기능 제공: Rx의 연산자를 활용하여 데이터를 변환하거나 조작할 수 있어 유연한 데이터 처리가 가능합니다.
콜백 지옥 해결: Rx의 연쇄적인 호출 구조를 통해 콜백 지옥을 피할 수 있습니다.

단점:

학습 곡선: Rx는 처음에는 익숙하지 않을 수 있으며, 학습하는 데 시간이 걸릴 수 있습니다.
오버헤드: Rx를 추가로 사용하면 앱의 크기가 커지고, 추가적인 오버헤드가 발생할 수 있습니다.

코루틴을 사용하여 처리

data class User(val id: Int, val username: String, val email: String) // 예시 사용자 모델

interface ApiService {
    @GET("users/{username}")
    suspend fun getUser(@Path("username") username: String): User
}

object RetrofitClient {
    private const val BASE_URL = "your_base_url"

    val apiService: ApiService by lazy {
        val retrofit = Retrofit.Builder()
            .baseUrl(BASE_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build()

        retrofit.create(ApiService::class.java)
    }
}

suspend fun fetchUser(username: String): User? {
    return withContext(Dispatchers.IO) {
        try {
            RetrofitClient.apiService.getUser(username)
        } catch (e: IOException) {
            // 네트워크 오류 처리
            null
        }
    }
}

withContext(Dispatchers.IO) {
        val user = fetchUser(username)
        if (user != null) {
            // 사용자 데이터를 성공적으로 받아왔을 때 처리
            // user 객체를 사용하여 UI 업데이트 등을 수행
        } else {
            // 네트워크 오류 등으로 사용자 데이터를 받아오지 못했을 때 처리
        }
    }