[개념 콕] 안드로이드 Retrofit

Retrofit이란?

API(Application Programming Interface)

XML & JSON (JavaScript Object Notation)

XML (eXtensible Markup Language)

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE recipe PUBLIC "-//Happy-Monkey//DTD RecipeBook//EN"
"http://www.happy-monkey.net/recipebook/recipebook.dtd">

<recipe>

	<title>Peanutbutter On A Spoon</title>

	<ingredientlist>
	  <ingredient>Peanutbutter</ingredient>
	</ingredientlist>

	<preparation>Stick a spoon in a jar of peanutbutter, scoopand
	 pull out a big glob of peanutbutter.</preparation>
 
</recipe> 

JSON (JavaScript Object Notation)

{
  "squadName": "Super hero squad",
  "homeTown": "Metro City",
  "formed": 2016,
  "secretBase": "Super tower",
  "active": true,
  "members": [
    {
      "name": "Molecule Man",
      "age": 29,
      "secretIdentity": "Dan Jukes",
      "powers": ["Radiation resistance", "Turning tiny", "Radiation blast"]
    },
    {
      "name": "Madame Uppercut",
      "age": 39,
      "secretIdentity": "Jane Wilson",
      "powers": [
        "Million tonne punch",
        "Damage resistance",
        "Superhuman reflexes"
      ]
    },
    {
      "name": "Eternal Flame",
      "age": 1000000,
      "secretIdentity": "Unknown",
      "powers": [
        "Immortality",
        "Heat Immunity",
        "Inferno",
        "Teleportation",
        "Interdimensional travel"
      ]
    }
  ]
}

XML과 JSON의 차이점 비교

Retrofit의 장점

1. 코드의 간결성
• 복잡한 HTTP API 요청을 쉽고 간결하게 만들 수 있습니다.
• 간단한 어노테이션을 통해 요청 메서드와 URL을 정의할 수 있습니다.

2. 안정성과 확장성
• 내부적으로 OkHttp 라이브러리를 사용하여 통신, 이를 통해 안정적인 통신이 가능합니다.
• 인터셉터를 사용하여 요청/응답 프로세스를 확장하거나 수정할 수 있습니다.

3. 다양한 플러그인과 컨버터 지원
• 다양한 데이터 형식(JSON, XML 등)에 대해 데이터 변환 컨버터를 제공합니다.
• RxJava, Coroutines와 같은 비동기 프로그래밍 라이브러리와 연동 가능합니다.

Retrofit 사용법

// build.gradle (Module: app)
dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.x.x'
    implementation 'com.squareup.retrofit2:converter-gson:2.x.x' // Gson 컨버터 추가
}

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

val retrofit = Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .build()

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

• 동기식 요청

val response: Response<User> = apiService.getUser(id).execute()

• 비동기식 요청

apiService.getUser(id).enqueue(object: Callback<User> {
    override fun onResponse(call: Call<User>, response: Response<User>) {
        
			if (response.isSuccessful) {
			    val user: User? = response.body()
				} 
	    }

    override fun onFailure(call: Call<User>, t: Throwable) {
        // 오류 처리
        Log.e("API_ERROR", t.message ?: "Unknown error")
    }
})

실제 사용 예 (Feat. 카카오 API)

Kakao Developers

카카오 API를 활용하여 다양한 어플리케이션을 개발해보세요. 카카오 로그인, 메시지 보내기, 친구 API, 인공지능 API 등을 제공합니다.

https://developers.kakao.com/

interface NetworkInterface {
    @GET("v2/search/image")
    fun getSearchResult(
        @Header("Authorization") apiKey: String = "KakaoAK $REST_API_KEY",
        @Query("query") query: String,
        @Query("size") size: Int = 80
    ): Call<Search>
}

object NetworkClient {

    private const val BASE_URL = "https://dapi.kakao.com"

    private fun createOkHttpClient() : OkHttpClient {
        val interceptor = HttpLoggingInterceptor()

        if (BuildConfig.DEBUG) {
            interceptor.level = HttpLoggingInterceptor.Level.BODY
        } else {
            interceptor.level = HttpLoggingInterceptor.Level.NONE
        }

    private val searchRetrofit = Retrofit.Builder()
        .baseUrl(BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .client(createOkHttpClient())
        .build()

    val searchApi: NetworkInterface = searchRetrofit.create(NetworkInterface::class.java)

}

data class Search(
    @SerializedName("documents")
    val documents: MutableList<Document>
)

data class Document (
    @SerializedName("thumbnail_url")
    val thumbnailUrl: String,
    @SerializedName("display_sitename")
    val siteName: String,
    @SerializedName("datetime")
    val datetime: String
)

private fun callKeyword(keyword: String) {
        NetworkClient.searchApi.getSearchResult("KakaoAK $REST_API_KEY", query = keyword)
            .enqueue(object : Callback<Search> {
                @SuppressLint("NotifyDataSetChanged")
                override fun onResponse(call: Call<Search>, response: Response<Search>) {
                    val body = response.body()

                    body?.let {
                        response.body()!!.documents.forEach{document ->
                            val title = document.siteName
                            val datetime = document.datetime
                            val url = document.thumbnailUrl
                            mItems.add(SearchItem(title, datetime, url))
                        }
                    }
                    adapter.items = mItems
                    adapter.notifyDataSetChanged()
                    Log.d("api검사", "$mItems")
                }

                override fun onFailure(call: Call<Search>, t: Throwable) {
                    Log.d("api검사", "네트워크 오류 / 데이터변환 오류.")
                }
            })
    }

내일배움캠프는 개발에 필요한 핵심만 배웁니다

취업 준비, 어디서부터 시작해야 할지 모르겠다면?