[Android]Retrofit2와 REST API 통신 1 ( Kotlin )

Retrofit

: Android 와 Java 환경에서 HTTP API를 쉽고 안전하게 사용할 수 있도록 도와주는 라이브러리이다. REST API 통신을 위해 구현되었다.

​

​

REST API 설명

https://blog.naver.com/88yhtserof/222208916350

[Android] 안드로이드 REST API

​HTTP (Hypertext Transfer Protocol: 하이퍼본문 전송규약) : 인터넷에서, 웹 서버와 사용자의 인...

blog.naver.com

​

​

​

---

​

​

​

​

Retrofit2 를 이용한 JSON 데이터 HTTP 통신

​

Retrofit2 라이브러리를 사용하기 위해 Gradle 에 다음과 같이 추가해준다.​

dependencies{ implementation 'com.squareup.retrofit2:retrofit:(마지막 버전)' }

2021.01.21 기준 2.9.0 버전이 가능 마지막 버전이다. 버전 확인: https://github.com/square/retrofit

​

​

​

​

​

Retrofit은 HTTP API 를 인터페이스 형태로 사용할 수 있으며,

코틀린 사용 시 아래의 양식처럼 사용할 수 있다.

public interface RetrofitInterface { @HTTP요청메소드("/디렉토리/파일명") fun 함수명( @Annotation("변수") 변수: 변수 자료형 ): Call<Response자료형,즉 주고 받을 객체)> }

​

주로 사용되는 구성요소로 REST API 통신에 필요한 Annotation이 있다.

Annotation	설명	예시
@GET	​ HTTP통신에 사용되는 method 중 GET 요청을 명시한다. ​	​
@Path	​ URL 부분 중 일부의 경로가 필요에 따라 동적으로 바인딩 되어야 하는 경우에 사용하며 문자열을 정의 해두면 해당 문자열을 URL 부분 일부에 바인딩하여 동적으로 URL을 만들 수 있도록 도와준다. ​	//검색 ​ @GET("/search/{word}") fun requestSearch( @Path("word") word:String ): Call<Response자료형> ​
@Query	GET 방식에서만 가능한 Annotation. 예시의 경우, id에 "2021" 값이 들어가게 된다면 http://도메인/post?postId=2021 을 호출하게 된다. ​	//게시글 조회 ​ @GET("/post") fun requestPost( @Query("postId") id String ): Call<Response자료형>
@Field	​ 주로 POST 방식의 통신을 할 때 사용하는 Annotation(Patch 방식에서도 사용, GET에서는 사용불가) Field 형식을 사용할 때에는 Form이 Encoding 되어야한다. 따라서 @ FormUrlEncoding Annotation과 함께 사용한다. ​	//비밀번호 설정 ​ @FormUrlEncoding @POST("/user/{userId}") fun requestPassword( @Path("userId") id:String, @Field("password") password:String ): Call<Response자료형>
@FieldMap	​ Field 형식을 통해 넘겨주는 값들이 여러개일 때 @FieldMap Annotation 을 사용한다. Retrofit에서는 HashMap을 권장한다. ​	​
@Part	​ Mutipart 요청 시 사용하며 @Multipart Annotation과 함께 사용한다. (나중에 다시 알아보기) ​	​
@Headers/ @Header	​ 정적 헤더들은 @Headers를 통해 명시할 수 있다. +같은 이름이어도 값을 덮어씌우지 않기 때문에 동일한 이름의 헤더를 추가하게 되면 동일한 이름으로 요청에 추가된다. / 동적 헤더는 @Header 를 통해 명시할 수 있다. 반드시 @Header 에 대응하는 매개변수를 제공해야한다. ​	//정적 헤더 @Headers( "~:~" ) ​ //동적 헤더 fun 함수명( @Headers("변수") 변수: 변수자료형 )
@Body	전송하는 값이 특정 JSON 형식일 때 바로 객체를 통해 값을 넘겨주는 형식	//user 데이터 클래스가 있을 때 data class User( val name:String, val nickname:String ) ​ //user 정보 수정 @PUT("/user/{userId}") fun requestUserUpdate( @Path("userId") id:String, @Body body: User ): Call<Response자료형>

​

​

---

​

​

​

​

헤더를 모든 요청마다 추가해야한다면, OkHttp interceptor 를 사용하면 좋다.

​

OkHttp

: HTTP를 간편하고 효율적으로 사용할 수 있도록 도와주는 Client

interceptor:특정 Url 요청시 Controller로 가는 요청을 가로챈다.

​

​

OkHttp 라이브러리를 사용하기 위해 Gradle 에 다음과 같이 추가해준다.

버전 확인: https://github.com/square/okhttp

dependencies{ implementation 'com.squareup.okhttp3:okhttp:(마지막 버전)' }

​

 

통신

Retrofit 클래스를 이용해 API주소가 연결되도록 retrifit 객체(인스턴스)를 생성한다.

object RequestToServer { private const val EveryHeader="모든헤더" //로그 기록에 사용할 HttpLoggingInterceptor val httpLoggingInterceptor =HttpLoggingInterceptor() .setLevel(HttpLoggingInterceptor.Level.BODY) //고정 헤더 값에 사용할 Interceptor val headerInterceptor = Interceptor{ //Interceptor 인터페이스 val request = it.request() .newBuilder() .addHeader("EveryHearder", EveryHeader) //헤더 추가 .build() return@Interceptor it.proceed(request) //request가 실행할 연결 반환 } //client val client: OkHttpClient=OkHttpClient.Builder() .addInterceptor(headerInterceptor) //Interceptor 추가 .build() //Retrofit 빌드 var retrofit: Retrofit = Retrofit.Builder() .baseUrl(주소) .client(client) .addConverterFactory(GsonConverterFactory.create()) .build() val api:RetrofitInterface = retrofit.create(RetrofitInterface::class.java) }

addConverterFactory(GsonConverterFactory.create()) : 객체와 JSON의 자동으로 변화시켜준다.

​

​

​

호출은 Retrofit2와 REST API 통신 2에서..

​

​

​

---

​

​

+

JSON ​JavaScript Object Notation

: 속성-값 쌍 또는 키-값 쌍으로 이루어진 데이터 오브젝트를 전달하기 위해 인간이 읽을 수 있는 텍스트를 사용하는 개방형 표준 포맷이다. JSON은 서버통신에 사용된다.

자료형으로는 기본자료형, 문자열, 배열, 객체가 있다.

{ "name": "임뚝딱", "id": "20210117", "like": ["여행", "그림"] }

​

JSON 형식으로 데이터 클래스 생성

data class DataClassItem ( val name:String, val nickname:String, val age:Int?,//null 허용 val like:ArrayList<String> )

​

DataClassItem을 원소로 가진 ArrayList 자료형 데이터 클래스

data class DataClass : ArrayList<DataClassItem>()

​

​

​

​

​

​

​

​

<공부 자료>

https://blog.yena.io/studynote/2020/01/08/Android-Kotlin-Retrofit.html

★ Retrofit + OkHttp

https://kor45cw.tistory.com/5

★ Retrofit, HTTP Annotation

https://square.github.io/retrofit/

★ Retrofit 공식문서

https://codingnotes.tistory.com/73

https://github.com/HwangEunmi/Retrofit-Sample#@Body

https://abss.tistory.com/155

https://medium.com/@joycehong0524/android-studio-retrofit2-%EA%B8%B0%EB%B3%B8-%EC%82%AC%EC%9A%A9%EB%B2%95-retrofit-%EC%9D%98%EB%AC%B8%EC%A0%90-%ED%92%80%EC%96%B4%ED%97%A4%EC%B9%98%EA%B8%B0-%EC%8A%A4%EC%95%95-f150db436add

https://kumgo1d.tistory.com/m/2

https://mommoo.tistory.com/60

https://mcflynn.tistory.com/10

https://zzandoli.tistory.com/48

​