[Kotlin] Retrofit

🤔 What?

레트로핏은 안드로이드 앱 개발 시 백엔드와의 통신을 위해서 사용하는 라이브러리이다!

레트로핏은 OkHttp기반의 라이브러리인데, 사실상 OkHttp만 사용해도 큰 어려움 없이 백엔드와의 통신이 가능하다!

---

🤷‍♂️ Why?

그렇다면 왜 OkHttp를 두고 OkHttp기반의 라이브러리인 Retrofit 사용할까? 그 이유는 아래와 같다!

• 성능 : 3배 가까이 차이나는 속도
• 편리성 : OkHttp에서 직접 손 봐주어야 할 부분들을 Retrofit 안해도 괜찮다!
• 가독성 : Annotation 사용으로 코드의 가독성이 뛰어남

public interface retropitService {
 	@Get("/get")
    Call<String>..;
}

@다음에 REST API에 어디에 해당하는지 직관적으로 확인이 가능!

🔍 How?

기본 설정

• build.gradle 추가
• permission Internet관련 추가

인터페이스 선언

레트로핏을 사용하기 위한 첫 단계!
API의 구조를 정의하는 인터페이스를 만들어야한다!

interface ApiService {
    @GET("getUser/{id}")
    suspend fun getPost(@Path("id") postId: Int): Response<Post>
}

• @GET("posts/{id}")
  여기서 일단 @부분은 어노테이션이라고 하는 부분인데 직관적으로 어떤 API를 사용하는지 알 수 있다!
  { } 부분은 나중에 함수를 직접 사용할 때 매개변수로 전달되는 값을 대체하는데 사용된다!

• suspend fun getPost(@Path("id") postId: Int): Response

  • suspend : 코루틴을 사용하여 비동기적으로 호출!

  • @Path("id") postId: Int : Retrofit 주석!
    "id"라는 경로 매개변수를 지정하며, 통신할 엔드포인트 경로의 {id} 부분에 들어갈 값을 나타낸다! 이 값을 메서드의 postId 매개변수로 전달

  • Response<Post>: Retrofit에서 제공하는 Response라는 클래스를 반환한다! 이 클래스는 서버와 통신한 HTTP 응답을 나타내고 Post는 응답 데이터를 변환하고 파싱하기 위한 Kotlin이 인식할 수 있는 데이터 클래스!

인스턴스 생성

이제 위에서 만들어둔 인터페이스를 실제 인스턴스로 만들어야한다!
그 전에 Retropit을 이용해 create할 것이기 때문에 retropit부터 먼저 인스턴스 생성!

• Retrofit 인스턴스를 만들 때 API통신을 할 때 기본이 되는 URL을 지정
• 서버의 응답 데이터를 Kotlin이 인식할 수 있는 객체로 파싱하기 위한 컨버터 팩토리를 추가
• 일반적으로 앱 전체에 하나의 Retrofit 인스턴스를 만들어 관리한다!(싱글턴 패턴을 적용해 일관되게 관리하기 위함이라 생각!)

val retrofit = Retrofit.Builder()
    .baseUrl("통신할 주소")
    .addConverterFactory(GsonConverterFactory.create())
    .build()

API 서비스 생성

이제 정말 위에서 우리가 만든 인터페이스 apiService를 인스턴스로 만들자!

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

API 호출

위에서 만든 apiService를 이용해서 이제 API를 호출한다!
apiService에 만들어두었던 getPost를 사용해서 통신을 시작!
이 후 넘어오는 반응에 따라 코드를 쭉 구현하면 된다!

val response = apiService.getPost(1)
if (response.isSuccessful) {
    val post = response.body()
    // 응답 받은 데이터에 따른 처리!
} else {
    // 에러 처리
}