Using retrofit2 in Android Studio - 51bootcamp/common GitHub Wiki

1. Why retrofit2?

REST API와 상당히 유사하게 interface를 만들어서 자동으로 Json을 parsing을 할 수 있다.

2. retrofit2 official tutorial

add this line in build.gradle

    implementation 'com.squareup.retrofit2:retrofit:2.5.0'

make interface

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

make retrofit object which implements of GitHubService interface

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

GitHubService service = retrofit.create(GitHubService.class);

Each Call from the created GitHubService can make a synchronous or asynchronous HTTP request to the remote webserver.

Call<List<Repo>> repos = service.listRepos("Ricci0708");

3. 실제로 사용하기

위에 tutorial만으로는 REST API를 이용한 JSONFILE을 파싱하거나 자동으로 클래스 object를 만드는 것은 어렵다. 이를 하기 위해서는 build.gradle에

    //for manage json file
    implementation 'com.squareup.retrofit2:converter-gson:2.5.0'
    //okhttp
    implementation "com.squareup.okhttp3:okhttp:3.12.1"
    implementation 'com.squareup.okhttp3:logging-interceptor:3.12.1'

gson은 google에서 만든 Java serialization/deserialization library이고 okhttp는 retrofit이 http를 이용해서 통신을 하는데 그냥 retrofit2로 만으로는 로깅을 하는 것이 불가능해서 logging을 위해서 implement를 한다.

RetrofitInstance라는 자바 파일을 만든후 아래의 내용을 붙여넣는다.

public class RetrofitInstance {
    private static Retrofit retrofit;
    private static OkHttpClient client;
    //URL can be easily changed
    private static final String BASE_URL = "http://10.0.2.2:8000/api/v1/";

    public static Retrofit getRetrofitInstance() {
        if (retrofit == null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(getOkhttpClient())
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
    private static OkHttpClient getOkhttpClient(){
        if (client == null){
            HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
            interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
            client = new OkHttpClient.Builder().addInterceptor(interceptor).build();
        }
        return client;
    }
}

이 자바 파일과 같은 경우에는 retrofit object를 반환해주는 자바 파일이다. getRetrofitInstance는 retrofit object가 존재한다면 그 object를 반환하고 없다면 생성을 한후에 return한다. 이와 같이 하는 이유는 retrofit object를 필요없이 많이 생성하지 않기 위해서이다. 또한 BASE_URL이라는 String만을 바꿈으로써 요청하는 서버의 주소를 쉽게 반환가능하다. 주의!BASE_URL과 같은 경우에는 반드시 'http://'로 시작하고 '/'로 끝이 나야한다. 또한 안드로이드 스튜디오 에뮬레이터의 loopback ipaddress는 10.0.2.2이다. localhost를 서버와 통신을 하기 위해서는 10.0.2.2로 설정을 해야 가능하다.

그 후 project에 interface를 하나 생선한다. common과 같은경우에는

public interface ApiInterface {
    @GET("class/{date}/")
    Call<ClassList> getClassList(@Path("date") String date);
    @GET("class/{date}/{classID}")
    Call<Class> getClassInfo(@Path("date") String date,
                             @Path("classID") Integer classID);
    @POST("login/")
    Call<User>login(@Body User user);
}

이 interface를 보면 REST API와 상당히 유사한 구조를 가지고 있음을 확인할 수 있다. 이를 통해서 REST API문서를 보면서 쉽게 적용이 가능하다.

@GET("class/{date}/")
Call<ClassList> getClassList(@Path("date") String date);

위의 API는 get method로 class/{date}에 request를 보낸다는 의미이다. {date}의 경우에는 @Path("date") String date에 의해서 주어지는 인자에 date가 들어간다는 의미이다.Call는 이 Call의 return type은 ClassList라는 의미이다. 만약 단순히 인자를 하나만을 받지 않고 여러개를 받는다면

@GET("class/{date}/{classID}")
Call<Class> getClassInfo(@Path("date") String date,
                         @Path("classID") Integer classID);

위와 같은 방법으로 요청을 보내면 된다.

@POST("login/")
Call<User>login(@Body User user);

위의 API는 POST method로 login/에 request보낸 다는 것을 의미하는 것이고, @Body에는 User user를 넣어서 요청을 한다는 의미이다. retrun type또한 User라는 의미이다.

이를 위해서는 각각 API를 통해서 받는 JSON Object를 파싱해서 담을 클래스가 필요하다.

예를 들자면 common api중 하나인 @GET api/v1/class/$date/$classID/ 의 경우에는 return 되는 Json object는

{
    "classID": 1,
    "className": "Booktalking with Author",
    "expertName": "lkh",
    "minGuestCount": 4,
    "maxGuestCount": 8,
    "availableTimeTable": [
        {
            "timeTableIdx": 11,
            "startTime": "03 : 00 PM",
            "endTime": "05 : 00 PM",
            "isBooked": false
        },
        {
            "timeTableIdx": 12,
            "startTime": "05 : 00 PM",
            "endTime": "07 : 00 PM",
            "isBooked": false
        }
    ]
}

의 형태를 가지고 있다. 이를 담을 Class를 만드는 것은 매우 귀찮고 짜증나는 일이다. 이를 자동으로 해주는 site가 있다! http://www.jsonschema2pojo.org/ 에 들어가서 반환받는 json response를 넣으면 java class를 자동으로 생성해준다. 이를 통해서 생성된 Class 클래스는

public class Class implements Parcelable {
    @SerializedName("classID")
    @Expose
    private Integer classID;
    @SerializedName("className")
    @Expose
    private String className;
    @SerializedName("expertName")
    @Expose
    private String expertName;
    @SerializedName("minGuestCount")
    @Expose
    private Integer minGuestCount;
    @SerializedName("maxGuestCount")
    @Expose
    private Integer maxGuestCount;
    @SerializedName("availableTimeTable")
    @Expose
    private List<TimeTable> availableTimeTable = new ArrayList<TimeTable>();
    @SerializedName("coverImage")
    @Expose
    private List<String> coverImage = new ArrayList<String>();

와 같은 구조를 가지고 있다. 이를 통해서 API로 요청을 하고 그 결과를 확인하면 제대로 주고 받음을 확인할수있다!

실제 Common에서 retrofit을 통해서 주고 받는 code의 예시이다.

ApiInterface service = RetrofitInstance.getRetrofitInstance()
                        .create(ApiInterface.class);
                //TODO(woonjin): get the today's date and change the arguments
Call<Class> request = service.getClassInfo(selectedDate,
        classList.getClassList().get(position).getClassID());
request.enqueue(new Callback<Class>() {
    @Override
    public void onResponse(Call<Class> call, Response<Class> response) {
        Context context = container.getContext();
                selectedClass = response.body();
                Log.d("ClassName", selectedClass.getClassName());
    }
    @Override
    public void onFailure(Call<Class> call, Throwable t) {
    //TODO (woongjin) : how to deal with failure
    }
});

D/OkHttp: --> GET http://10.0.2.2:8000/api/v1/class/2019-01-17/4
D/OkHttp: --> END GET
D/OkHttp: <-- 200 OK http://10.0.2.2:8000/api/v1/class/2019-01-17/4 (10ms)
    Date: Thu, 17 Jan 2019 20:54:03 GMT
    Server: WSGIServer/0.2 CPython/3.7.0
    Content-Type: application/json
    X-Frame-Options: SAMEORIGIN
    Content-Length: 223
    {"classID": 4, "className": "A Wine Tasting", "expertName": "jmj", "minGuestCount": 6, "maxGuestCount": 10, "availableTimeTable": [{"timeTableIdx": 9, "startTime": "09 : 00 AM", "endTime": "11 : 00 AM", "isBooked": false}]}
    <-- END HTTP (223-byte body)
D/ClassName: A Wine Tasting

이런식으로 로그가 찍힌다!

4. 더 생각해볼것

물론 이것은 거의 간단하게만 사용하기 위해서 한것이다. 원래라면 on failure에서 예외처리를 해주어야한다. On failure의 경우에는 서버가 아예 응답이 없거나, json파일을 파싱에 실패했을때, 들어가는 블럭이다. 서버에서 400번대의 response를 보내더라도 on success로 넘어가기 때문에 on success내에서 예외처리를 해주어야 한다. 또한 enqueue는 비동기화 방식을 사용함으로 만약 동기화 방법을 사용해야 한다면 조금더 알아봐야할 필요가 있다. 같이 공부해봐요~

Using retrofit2 in Android Studio - 51bootcamp/common GitHub Wiki

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️