[Kotlin][Android] 안드로이드 REST 통신 - Retrofit2(레트로핏)의 사용법에 대해서

안녕하세요 👋

오늘은 안드로이드에서 Rest 통신을 하는 법과

Retrofit2의 사용방법에 대해 공부한 내용을 포스팅하려 합니다.

 

REST(’RE’presentational ‘S’tate ‘T’ransfer)란?

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미합니다.

 

그렇다면 Retrofit2이란 무엇일까요?

 

Retrofit2 란?

OkHttp를 만든 Square사에서 만든 라이브러리로

Annotation을 이용하여 REST를 다룰 수 있습니다.

(OkHttp를 기반으로 reflect를 적용하여 개발)

 

---

그렇다면 Retrofit2를 사용하여 Http 통신을 하는 법을 알아보겠습니다. 😎

 

1. 인터넷 통신을 사용할 수 있는 permission을 manifest파일에 추가해줍니다.

//인터넷 사용 Permission 추가

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

 

2. 전달받을 JSON 데이터에 따라 model class를 하나 생성해줍니다.

(제가 사용한 데이터는 공공데이터 포털에 있는 '해수욕장 혼잡도'를 나타내는 데이터로 JSON 데이터는 아래와 같습니다.)

"Beach7": {
        "etlDt": "202209021330",
        "seqId": 33,
        "poiNm": "봉수대",
        "uniqPop": 691,
        "congestion": "1"
    },
    "Beach8": {
        "etlDt": "202209021330",
        "seqId": 34,
        "poiNm": "봉포리",
        "uniqPop": 1152,
        "congestion": "1"
    },
    "Beach9": {
        "etlDt": "202209021330",
        "seqId": 35,
        "poiNm": "삼포",
        "uniqPop": 738,
        "congestion": "1"
    },

---

위와 같은 JSON을 담을 class를 하나 만들어 줍니다.

data class BeachCongestionModel(
    val etlDt : String = "",
    val seqId : Int = -1,
    val poiNm : String = "",
    val uniqPop : Int = -1,
    var congestion : String = ""
)

class BeachCongestionList {
    private lateinit var mBeachList : MutableList<BeachCongestionModel>

    @SerializedName("Beach0")
    val beach0 : BeachCongestionModel? = null
    ... // 밑에 더 많은 데이터가 있지만 샘플 화면을 위하여 생략하고 
    // 이번 포스팅에서는 해변정보 하나만을 가져와 사용하였습니다.
}

 

3. 레트로핏을 통해 통신할 수 있는 interface를 하나 만들어 줍니다.

interface BeachCongestionService {
    @GET("/seantour_map/travel/getBeachCongestionApi.do")
    suspend fun getBeachCongestion() : Response<BeachCongestionList>

    companion object{
        private lateinit var instance : BeachCongestionService

        fun getInstance() : BeachCongestionService{
            if(!::instance.isInitialized){
                val retrofit = Retrofit.Builder()
                    .baseUrl(BEACH_CONGESTION_URL)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build()
                instance =  retrofit.create(BeachCongestionService::class.java)
            }
            return instance
        }
    }
}

위와 같이 annotaion을 통해 통신할 방식을 정하여 정보를 가져올 수 있습니다. 

(@GET 외에 @POST , @DELETE , @PUT 등이 있습니다.)

 

4. Retrofit2를 사용하여 통신하는 코드를 작성합니다.

private fun startRetrofitButton() {
        binding.progressBar.visibility = View.VISIBLE
            val response = RetrofitService.getInstance().getBeachCongestion()
            response.enqueue(object : Callback<BeachCongestionList>{
                override fun onResponse( // 성공시에 실행되는 코드
                    call: Call<BeachCongestionList>,
                    response: Response<BeachCongestionList>
                ) {
                    val model = response.body()?.beach0
                    CoroutineScope(Dispatchers.Main).launch {
                        with(binding){
                            beachName.text = model?.poiNm
                            congestionText.text = convertCongestion(model?.congestion as String)
                            timeText.text = model.etlDt
                            uniqPopText.text = model.uniqPop.toString()
                            seqIdText.text = model.uniqPop.toString()
                        }
                        Toast.makeText(this@MainActivity , "정상적으로 정보를 가져왔습니다." , Toast.LENGTH_SHORT).show()
                        binding.progressBar.visibility = View.GONE
                    }
                }

                override fun onFailure(call: Call<BeachCongestionList>, t: Throwable) {
                // 실패시에 실행되는 코드
                    Toast.makeText(this@MainActivity , "서버에서 정보를 가져오는데 실패했습니다" , Toast.LENGTH_SHORT).show()
                }
            })
    }

이번 포스팅에서는 Response시에 Call객체를 반환하도록 구현하였기에 위와 같이

enqueue()를 통해 '비동기'방식으로 처리하였습니다. 이 외에도

execute()를 통해 '동기'방식으로 처리도 가능합니다.

excute()로 값을 수신 시 response.isSuccessful을 통해 성공 여부를 확인할 수 있으며

그에 따라 동작을 구현해주면 됩니다. 😃

 

전체 코드는 아래와 같습니다.

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <ProgressBar
        android:id="@+id/progressBar"
        android:layout_width="50dp"
        android:layout_height="50dp"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        android:indeterminateTint="#000"
        app:layout_constraintBottom_toBottomOf="parent"
        android:visibility="gone"
        />

    <TextView
        android:id="@+id/timeText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="100dp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/seqIdText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@id/timeText"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        android:layout_marginTop="20dp"
        />

    <TextView
        android:id="@+id/beachName"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@id/seqIdText"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        android:layout_marginTop="20dp"
        />

    <TextView
        android:id="@+id/congestionText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@id/beachName"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        android:layout_marginTop="20dp"
        />

    <TextView
        android:id="@+id/uniqPopText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@id/congestionText"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        android:layout_marginTop="20dp"
        />

    <Button
        android:id="@+id/startButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="시작"
        android:layout_marginBottom="32dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.498"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent" />


</androidx.constraintlayout.widget.ConstraintLayout>

 

package com.lee.retrofitexamplepj

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.view.View
import android.widget.Toast
import com.lee.retrofitexamplepj.databinding.ActivityMainBinding
import com.lee.retrofitexamplepj.retrofit.model.BeachCongestionList
import com.lee.retrofitexamplepj.retrofit.model.BeachCongestionModel
import com.lee.retrofitexamplepj.retrofit.model.RetrofitService
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.Job
import kotlinx.coroutines.launch
import retrofit2.Call
import retrofit2.Callback
import retrofit2.Response

class MainActivity : AppCompatActivity() {
    private lateinit var binding : ActivityMainBinding
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater).also {
            setContentView(it.root)
        }
        addListeners()
    }
    private fun addListeners() {
        with(binding){
            startButton.setOnClickListener {
                startRetrofitButton()
            }
        }
    }

    private fun startRetrofitButton() {
        binding.progressBar.visibility = View.VISIBLE
            val response = RetrofitService.getInstance().getBeachCongestion()
            response.enqueue(object : Callback<BeachCongestionList>{
                override fun onResponse(
                    call: Call<BeachCongestionList>,
                    response: Response<BeachCongestionList>
                ) {
                    val model = response.body()?.beach0
                    CoroutineScope(Dispatchers.Main).launch {
                        with(binding){
                            beachName.text = model?.poiNm
                            congestionText.text = convertCongestion(model?.congestion as String)
                            timeText.text = model.etlDt
                            uniqPopText.text = model.uniqPop.toString()
                            seqIdText.text = model.uniqPop.toString()
                        }
                        Toast.makeText(this@MainActivity , "정상적으로 정보를 가져왔습니다." , Toast.LENGTH_SHORT).show()
                        binding.progressBar.visibility = View.GONE
                    }
                }

                override fun onFailure(call: Call<BeachCongestionList>, t: Throwable) {
                    Toast.makeText(this@MainActivity , "서버에서 정보를 가져오는데 실패했습니다" , Toast.LENGTH_SHORT).show()
                }
            })
    }
    
     /**
     * 수신 값에 따라 text를 달리해주는 함수
     **/
    fun convertCongestion(congestion : String) : String {
        return when(congestion){
            "1" -> "보통"
            "2" -> "조금 혼잡"
            "3" -> "혼잡"
            else -> "Error"
        }
    }
}

 

마지막은 실행화면으로 포스팅을 마무리하도록 하겠습니다.

 

오늘도 즐코하세요 :)