Androidの通信周りを軽くLTしました。

1. Retrofit2 & OkHttp
でAndroidのHTTP通信が快適だにゃん
1
日本Androidの会埼玉支部 @sakura_bird1
2016/01/23

2. さくら@sakura_bird1
ABOUT ME
• 多分ハタチ
• 野良プログラマー3年目ぐらい
• Android受託開発で糊口をしのぐ
• 最近Player!というアプリを作ってます。
もうすぐAndroid版リリース(?)
• 一生プログラマー
• 今年はSwiftやりたい

3. OkHttp
• Square社のHTTPクライアント(http://square.github.io/okhttp/)
• http通信が簡単に書ける
• 通信状況が悪い時は再接続してくれる
• HTTP/2 ,SPDYをサポート
• Okio(java.io)に依存
• 強力なInterceptor (request前処理,ロギング,ヘッダー,gzip圧縮 )
• コネクションプーリング、キャッシング、同期／非同期call、リダイレクト他
3

4. Retrofit
• Square社のHTTPクライアント用ライブラリ(http://square.github.io/retrofit/)
• REST APIをJava Interface、アノテーションの形でシンプルに書ける
• 最新のバージョンはRetrofit version2.0.0-beta3
• Retrofit2系と1系はかなり大きく違っている
• Http bodyの変換用にいくつかのselialization用ライブラリに使えるコンバーターが
用意されている(Gson, Jackson, Moshi, Protobuf, Wire, Simple XML)
• RxAndroidと相性がいいらしいがここでは割愛
4

5. 使用例

6. public interface GitHubService {
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first,
@Field("last_name") String last);
}
Interfaceでエンドポイント、メソッド、パラメータを定義
Request body変換用エンティティクラスを指定

7. Retrofit retrofit = new Retrofit.Builder()
.baseUrl(“https://api.github.com")
.client(httpClient)
.addConverterFactory(GsonConverterFactory.create())
.build();
GitHubService service = retrofit.create(GitHubService.class);
OkHttpClient httpClient = new OkHttpClient();
↑これがなくてもOK。自動的にOkHttpを使用する。
通信処理 Retrofit セットアップ
Retrofitのオブジェクトを生成する Request body変換用converterを指定

8. Call<User> task = service.updateUser(firstName, lastName);
task.enqueue(new Callback<User>() {
@Override
public void onResponse(Response<User> response, Retrofit retrofit) {
if (response != null && response.body() != null) {
// response.body()にUserクラスに変換されたオブジェクト
// が入っている
}
}
@Override
public void onFailure(Throwable t) {
}
});
APIをcallする

9. 便利な使い方

10. @Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call<User> getUser(@Path("username") String username);
HEADER
1. Interfaceに記述する方法
Headerやendpointに変数を指定できる

11. HEADER
2. OkHttpのinterceptorを使って記述する方法
どのrequestでも必ず指定するヘッダーはこっちを使った方が便利
httpClient.interceptors().add(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request original = chain.request();
Request request = original.newBuilder()
.header(“Hoge-Version”,”1.0”)
.header(“Client-OS”,”Android”)
.method(original.method(), original.body())
.build();
return chain.proceed(request);
}
});

12. LOGGING
LoggingInterceptorを使う
if (BuildConfig.DEBUG) {
HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
httpClient.networkInterceptors().add(interceptor);
}

13. 共通処理をまとめたい
その１．エラー処理
retrofit.Callbackインターフェイスを実装し独自クラスを使う

14. Call<User> task = service.updateUser(firstName, lastName);
task.enqueue(new Callback<User>() {
@Override
public void onResponse(Response<User> response, Retrofit retrofit) {
}
}
@Override
public void onFailure(Throwable t) {
}
});
デフォルトのCallback<T>
このあたりに毎回同じエラー処理を書きたい

15. 例えばこんなCallbackクラスを用意します
public class NetworkCallback<T> implements Callback<T> {
private Context mContext;
public NetworkCallback(Context context) {
mContext = context;
}
@Override
public void onResponse(Response<T> response, Retrofit retrofit) {
if (response != null && response.errorBody() != null) {
try {
if (response.code() > 400) {
String errorBody = response.errorBody().string();
Logger.e("error :" + errorBody + " code:" + response.code());
ClientHelper.ApiError apiError = ClientHelper.onApiError(response.code(), errorBody);
showDialog(mContext, mContext.getString(R.string.errorOccured), apiError.getMessage());
return;
}
} catch (IOException e) {
e.printStackTrace();
showDialog(mContext, mContext.getString(R.string.errorOccured), ClientHelper.ApiError.UNKNOWN.getMessage());
return;
}
}
if (response == null || response.body() == null) {
Logger.e("response or response body=null");
showDialog(mContext, mContext.getString(R.string.errorOccured), ClientHelper.ApiError.UNKNOWN.getMessage());
}
}
@Override
public void onFailure(Throwable t) {
if (t != null) {
t.fillInStackTrace();
Logger.e("Throwable t:" + t.getCause() + " " + t.getMessage());
} else {
Logger.e("Cound not access server");
}
showDialog(mContext, mContext.getString(R.string.errorOccured), ClientHelper.ApiError.OFFLINE.getMessage());
}
}

16. UserClient client = ClientHelper.createService(UserClient.class);
Call<User> task = client.show();
task.enqueue(new NetworkCallback<User>(mContext) {
@Override
public void onResponse(Response<User> response, Retrofit retrofit) {
super.onResponse(response, retrofit);
if (response != null && response.errorBody() != null) {
return;
}
if (response != null && response.body() != null) {
// somethings
}
}
@Override
public void onFailure(Throwable t) {
super.onFailure(t);
}
});
デフォルトのCallbackの代わりに指定する

17. 共通処理をまとめたい
その２．Retrofitにセットする値はいつも同じ
汎用メソッドを用意しておく

18. private static Retrofit.builder builder;
public static <S> S createService(Class<S> serviceClass) {
builder.baseUrl(PlayerApplication.getContext().getString(R.string.API_BASE_URL));
Retrofit retrofit = builder
.client(httpClient)
.addConverterFactory(GsonConverterFactory.create())
.build();
return retrofit.create(serviceClass);
}
汎用メソッド
汎用メソッドを使ってオブジェクトを生成
UsersClient client = ClientHelper.createService(UsersClient.class);