[안드로이드] Retrofit2 란? (사용법 예제)

들어가기에 앞서

Retrofit 외에도 통신을 편하게 할 수 있도록 도와주는 라이브러리가 몇 개 있었다.

HttpClient, Volley, Okhttp 등 하지만 HttpClient, Volley는 Deprecated 되었고,

Okhttp을 이용하여 더 편하고 사용하기 쉽게 만든 것이 Retrofit이다.

 

Okhttp를 기반으로 Retrofit을 만들었기 때문에 Retrofit 라이브러리를 추가하면 OKhttp의 메서드도 사용할 수 있다.

반응형

Retrofit2 이란?

안드로이드에서 네트워크 통신을 쉽게 구현할 수 있도록 도와주는 오픈 소스 라이브러리입니다.

Retrofit은 HTTP API를 호출하기 위한 인터페이스를 정의하고, 이를 기반으로 실제로 네트워크 호출을 수행합니다.

• API 통신을 위해 구현된 OkHTTP의 HTTP 통신을 간편하게 만들어주는 라이브러리를 뜻한다.
• Async Task가 없이 Background 쓰레드를 실행한다. 즉, CallBack을 통하여 Main Thread에서 UI를 업데이트한다.
• 동일 Squareup사의 OkHttp 라이브러리의 상위 구현체이다.

Retrofit 2 장점

Retrofit2의 장점은 크게 3가지로 볼 수 있다.

속도 / 편의성 / 가독성

• OkHTTP 사용 시에 AsyncTask를 통해 비동기를 실행하여 속도가 느린 이슈가 있다. 하지만 Retrofit2에서는 자체적으로 비동기 실행과 스레드 관리가 가능하여 속도가 빠르다. 
• 함수 호출 시에 파라미터를 넘겨주어 작업량이 감소한다.
• Interface 내에서 어노테이션을 사용하여 호출 함수를 미리 지정, 구현 없이 해당 함수를 호출만 해주면 되기 때문에 코드를 읽기 편리하다. 또한 콜백 함수를 통한 직관적 설계가 가능하다.
• Retrofit은 동기/비동기를 모두 지원한다.

Retrofit 2 구성요소

• DTO (POJO) - 'Data transfer Object', 'Plain Old Java Object' 형태의 모델(Model) / JSON 타입변환에 사용
  DTO (Data transfer Object) 란?
  계층간 데이터 교환이 이루어 질 수 있도록 하는 객체(Java Beans)이기 때문에, 특별한 로직을 가지지 않는 순수한 데이터 객체여야 한다.
• Interface - 사용할 HTTP CRUD 동작(메소드)들을 정의해 놓는 인터페이스
• Retrofit.Builder 클래스 - interface를 사용할 인스턴스, baseUrl(URL) / Converter(변환기) 설정

---

Retrofit 2 예제

Retrofit2을 이용하여 URL을 통해 데이터를 가져오는 예제

 

AndroidManifest.xml

인터넷 권한 설정

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

build.gradle

retrofit 라이브러리 추가 

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

 

Post.kt

가져올 데이터의 데이터 클래스를 만든다.

data class Post (
    val userId : Int,
    val id : Int,
    val title : String,
    val body : String
)

 

MyApi.kt

interface 정의, number 매개변수를 통해 URL 뒤에 오는 디테일한 주소를 잡아준다.

interface MyApi {

    @GET("posts/{number}")
    fun getPostNumber(
        @Path("number") number : Int
    ) : Call<Post>

}

RetrofitInstance.kt

retrofit 인스턴스를 싱글톤 패턴으로 만들어준다.

object RetrofitInstance {

    val BASE_URL = "https://jsonplaceholder.typicode.com/"

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

    fun getInstance() : Retrofit {
        return client
    }

}

MainActivity.kt

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

            val api = RetrofitInstance.getInstance().create(MyApi::class.java)

            api.getPostNumber(2).enqueue(object : Callback<Post> {
                override fun onResponse(call: Call<Post>, response: Response<Post>) {
                    if (response.isSuccessful){
                        // 정상적으로 통신 성공한 경우
                        // URL의 데이터를 가져온다.
                        Log.d("API2", response.body().toString())
                    }else{
                        // 통신이 실패한 경우(응답코드 3xx, 4xx 등)
                        Log.d("API2", "통신 실패")
                    }
                }
                override fun onFailure(call: Call<Post>, t: Throwable) {
                    // 통신 실패 (인터넷 끊킴, 예외 발생 등 시스템적인 이유)
                    Log.d("API2", "fail")
                }

            })

        }
    }
}

반응형

 

실행 화면

Post 클래스에 데이터 클래스를 정의해 놓은 것 처럼 출력되는 것을 볼 수 있다. 

 

 

---

참고

https://minchanyoun.tistory.com/44