Retrofit Android の例チュートリアル

チュートリアル
Android

ようこそ、Retrofit Androidの例のチュートリアルへ。今日は、Squareによって開発されたRetrofitライブラリを使用して、AndroidアプリケーションでREST API呼び出しを処理します。

Retrofit Android

Retrofitは、AndroidおよびJava向けのタイプセーフなRESTクライアントであり、RESTfulなWebサービスの消費を容易にすることを目指しています。Retrofit 1.xバージョンの詳細には触れず、直接Retrofit 2に進みます。これには、以前のバージョンと比較して多くの新機能と変更された内部APIがあります。 Retrofit 2はデフォルトでOkHttpをネットワーキングレイヤーとして活用し、それの上に構築されています。 Retrofitは、JSONレスポンスをPOJO（Plain Old Java Object）を使用して自動的にシリアル化します。これはJSON構造のために事前に定義されている必要があります。 JSONをシリアル化するには、最初にそれをGsonに変換するコンバータが必要です。 build.gradeファイルに次の依存関係を追加する必要があります。

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.google.code.gson:gson:2.6.2'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'

OkHttpの依存関係は既にRetrofit 2の依存関係と一緒に提供されています。別個のOkHttpの依存関係を使用したい場合は、Retrofit 2からOkHttpの依存関係を除外する必要があります：

compile ('com.squareup.retrofit2:retrofit:2.1.0') {  
  // RetrofitのOkHttp依存モジュールを除外し、独自のモジュールを定義する
  exclude module: 'okhttp'
}
compile 'com.google.code.gson:gson:2.6.2'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'
compile 'com.squareup.okhttp3:okhttps:3.4.1'
  • ログインターセプターは、返された完全なレスポンスのログ文字列を生成します。
  • JSONを必要な型にパースする他のコンバータもあります。いくつかは以下にリストされています。
  1. Jackson : com.squareup.retrofit2:converter-jackson:2.1.0
  2. Moshi : com.squareup.retrofit2:converter-moshi:2.1.0
  3. Protobuf : com.squareup.retrofit2:converter-protobuf:2.1.0
  4. Wire : com.squareup.retrofit2:converter-wire:2.1.0
  5. Simple XML : com.squareup.retrofit2:converter-simplexml:2.1.0

AndroidManifest.xmlファイルでインターネットへのアクセス許可を追加してください。

OkHttp Interceptors

インターセプターは、OkHttpに存在する強力なメカニズムで、呼び出しを監視、書き換え、再試行することができます。インターセプターは、主に2つのカテゴリに分けられます：

  • アプリケーションインターセプター：アプリケーションインターセプターを登録するには、OkHttpClient.BuilderのaddInterceptor()を呼び出す必要があります。
  • ネットワークインターセプター：ネットワークインターセプターを登録するには、addInterceptor()の代わりにaddNetworkInterceptor()を呼び出します。

Retrofitインターフェースの設定

package com.journaldev.retrofitintro;

import com.journaldev.retrofitintro.pojo.MultipleResource;

import okhttp3.OkHttpClient;
import okhttp3.logging.HttpLoggingInterceptor;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

class APIClient {

    private static Retrofit retrofit = null;

    static Retrofit getClient() {

        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient client = new OkHttpClient.Builder().addInterceptor(interceptor).build();


        retrofit = new Retrofit.Builder()
                .baseUrl("https://reqres.in")
                .addConverterFactory(GsonConverterFactory.create())
                .client(client)
                .build();



        return retrofit;
    }

}

上記のコード内のgetClient()メソッドは、Retrofitインターフェースを設定する際に毎回呼び出されます。 Retrofitは、各HTTPメソッドに対して一連の注釈を提供しています：@GET、@POST、@PUT、@DELETE、@PATCH、または@HEAD。では、APIInterface.javaクラスがどのように見えるかを見てみましょう。

package com.journaldev.retrofitintro;

import com.journaldev.retrofitintro.pojo.MultipleResource;
import com.journaldev.retrofitintro.pojo.User;
import com.journaldev.retrofitintro.pojo.UserList;

import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Query;

interface APIInterface {

    @GET("/api/unknown")
    Call<MultipleResource> doGetListResources();

    @POST("/api/users")
    Call<User> createUser(@Body User user);

    @GET("/api/users?")
    Call<UserList> doGetUserList(@Query("page") String page);

    @FormUrlEncoded
    @POST("/api/users?")
    Call<UserList> doCreateUserWithField(@Field("name") String name, @Field("job") String job);
}

上記のクラスでは、注釈を使用してHTTPリクエストを実行するいくつかのメソッドが定義されています。@GET("/api/unknown")はdoGetListResources();を呼び出します。doGetListResources()はメソッド名です。MultipleResource.javaは、レスポンスオブジェクトのモデルPOJOクラスであり、レスポンスパラメータをそれぞれの変数にマップするために使用されます。これらのPOJOクラスはメソッドの戻り値として機能します。

package com.journaldev.retrofitintro.pojo;

import com.google.gson.annotations.SerializedName;

import java.util.ArrayList;
import java.util.List;

public class MultipleResource {

    @SerializedName("page")
    public Integer page;
    @SerializedName("per_page")
    public Integer perPage;
    @SerializedName("total")
    public Integer total;
    @SerializedName("total_pages")
    public Integer totalPages;
    @SerializedName("data")
    public List<Datum> data = null;

    public class Datum {

        @SerializedName("id")
        public Integer id;
        @SerializedName("name")
        public String name;
        @SerializedName("year")
        public Integer year;
        @SerializedName("pantone_value")
        public String pantoneValue;

    }
}

@SerializedName注釈は、JSONレスポンス内のフィールド名を指定するために使用されます。POJOクラスをプレビューして、Android Studioプロジェクト構造にコピーします。 POJOクラスは、型付きのRetrofit Callクラスにラップされます。注意：JSONArrayはPOJOクラス内のオブジェクトのリストとしてシリアル化されます。メソッドパラメータ：メソッド内に渡す可能なパラメータの幅広いオプションがあります：

  • @Body – Javaオブジェクトをリクエストボディとして送信します。
  • @Url – 動的なURLを使用します。
  • @Query – @Queryとクエリパラメータ名を持つメソッドパラメータを追加するだけです。クエリをURLエンコードするには、次の形式を使用します：@Query(value = "auth_token",encoded = true) String auth_token
  • @Field – データをフォームエンコードとして送信します。これにはメソッドと関連付けられた@FormUrlEncodedアノテーションが必要です。 @Fieldパラメータは、POSTの場合にのみ機能します。

注意: @Fieldには必須パラメータが必要です。 @Fieldがオプションの場合は、代わりに@Queryを使用してnull値を渡すことができます。

Retrofit Androidの例のプロジェクト構造

pojoパッケージには、APIInterface.javaクラスで定義された各APIエンドポイントのレスポンスのモデルクラスが4つ定義されています。 User.java

package com.journaldev.retrofitintro.pojo;

import com.google.gson.annotations.SerializedName;

public class User {

    @SerializedName("name")
    public String name;
    @SerializedName("job")
    public String job;
    @SerializedName("id")
    public String id;
    @SerializedName("createdAt")
    public String createdAt;

    public User(String name, String job) {
        this.name = name;
        this.job = job;
    }


}

上記のクラスは、createUser()メソッドのレスポンスボディを作成するために使用されます。UserList.java

package com.journaldev.retrofitintro.pojo;

import com.google.gson.annotations.SerializedName;

import java.util.ArrayList;
import java.util.List;

public class UserList {

    @SerializedName("page")
    public Integer page;
    @SerializedName("per_page")
    public Integer perPage;
    @SerializedName("total")
    public Integer total;
    @SerializedName("total_pages")
    public Integer totalPages;
    @SerializedName("data")
    public List<Datum> data = new ArrayList();

    public class Datum {

        @SerializedName("id")
        public Integer id;
        @SerializedName("first_name")
        public String first_name;
        @SerializedName("last_name")
        public String last_name;
        @SerializedName("avatar")
        public String avatar;

    }
}

CreateUserResponse.java

package com.journaldev.retrofitintro.pojo;

import com.google.gson.annotations.SerializedName;

public class CreateUserResponse {

    @SerializedName("name")
    public String name;
    @SerializedName("job")
    public String job;
    @SerializedName("id")
    public String id;
    @SerializedName("createdAt")
    public String createdAt;
}

インターフェースクラスで定義された各APIエンドポイントを呼び出し、各フィールドをToast/TextViewで表示するのはMainActivity.javaです。

package com.journaldev.retrofitintro;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.widget.TextView;
import android.widget.Toast;

import com.journaldev.retrofitintro.pojo.CreateUserResponse;
import com.journaldev.retrofitintro.pojo.MultipleResource;
import com.journaldev.retrofitintro.pojo.User;
import com.journaldev.retrofitintro.pojo.UserList;

import java.util.List;

import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;

public class MainActivity extends AppCompatActivity {

    TextView responseText;
    APIInterface apiInterface;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        responseText = (TextView) findViewById(R.id.responseText);
        apiInterface = APIClient.getClient().create(APIInterface.class);


        /**
         GET List Resources
         **/
        Call<MultipleResource> call = apiInterface.doGetListResources();
        call.enqueue(new Callback<MultipleResource>() {
            @Override
            public void onResponse(Call<MultipleResource> call, Response<MultipleResource> response) {


                Log.d("TAG",response.code()+"");

                String displayResponse = "";

                MultipleResource resource = response.body();
                Integer text = resource.page;
                Integer total = resource.total;
                Integer totalPages = resource.totalPages;
                List<MultipleResource.Datum> datumList = resource.data;

                displayResponse += text + " Page\n" + total + " Total\n" + totalPages + " Total Pages\n";

                for (MultipleResource.Datum datum : datumList) {
                    displayResponse += datum.id + " " + datum.name + " " + datum.pantoneValue + " " + datum.year + "\n";
                }

                responseText.setText(displayResponse);

            }

            @Override
            public void onFailure(Call<MultipleResource> call, Throwable t) {
                call.cancel();
            }
        });

        /**
         Create new user
         **/
        User user = new User("morpheus", "leader");
        Call<User> call1 = apiInterface.createUser(user);
        call1.enqueue(new Callback<User>() {
            @Override
            public void onResponse(Call<User> call, Response<User> response) {
                User user1 = response.body();

                Toast.makeText(getApplicationContext(), user1.name + " " + user1.job + " " + user1.id + " " + user1.createdAt, Toast.LENGTH_SHORT).show();

            }

            @Override
            public void onFailure(Call<User> call, Throwable t) {
                call.cancel();
            }
        });

        /**
         GET List Users
         **/
        Call<UserList> call2 = apiInterface.doGetUserList("2");
        call2.enqueue(new Callback<UserList>() {
            @Override
            public void onResponse(Call<UserList> call, Response<UserList> response) {

                UserList userList = response.body();
                Integer text = userList.page;
                Integer total = userList.total;
                Integer totalPages = userList.totalPages;
                List<UserList.Datum> datumList = userList.data;
                Toast.makeText(getApplicationContext(), text + " page\n" + total + " total\n" + totalPages + " totalPages\n", Toast.LENGTH_SHORT).show();

                for (UserList.Datum datum : datumList) {
                    Toast.makeText(getApplicationContext(), "id : " + datum.id + " name: " + datum.first_name + " " + datum.last_name + " avatar: " + datum.avatar, Toast.LENGTH_SHORT).show();
                }


            }

            @Override
            public void onFailure(Call<UserList> call, Throwable t) {
                call.cancel();
            }
        });


        /**
         POST name and job Url encoded.
         **/
        Call<UserList> call3 = apiInterface.doCreateUserWithField("morpheus","leader");
        call3.enqueue(new Callback<UserList>() {
            @Override
            public void onResponse(Call<UserList> call, Response<UserList> response) {
                UserList userList = response.body();
                Integer text = userList.page;
                Integer total = userList.total;
                Integer totalPages = userList.totalPages;
                List<UserList.Datum> datumList = userList.data;
                Toast.makeText(getApplicationContext(), text + " page\n" + total + " total\n" + totalPages + " totalPages\n", Toast.LENGTH_SHORT).show();

                for (UserList.Datum datum : datumList) {
                    Toast.makeText(getApplicationContext(), "id : " + datum.id + " name: " + datum.first_name + " " + datum.last_name + " avatar: " + datum.avatar, Toast.LENGTH_SHORT).show();
                }

            }

            @Override
            public void onFailure(Call<UserList> call, Throwable t) {
                call.cancel();
            }
        });

    }
}

apiInterface = APIClient.getClient().create(APIInterface.class);はAPIClientをインスタンス化するために使用されます。モデルクラスをレスポンスにマップするには、MultipleResource resource = response.body();を使用します。アプリケーションを実行すると、各エンドポイントが呼び出され、それに応じてToastメッセージが表示されます。これでRetrofit Androidの例のチュートリアルが終了します。Android Retrofitの例プロジェクトは以下のリンクからダウンロードできます。

Retrofit Androidの例プロジェクトをダウンロード

Source:
https://www.digitalocean.com/community/tutorials/retrofit-android-example-tutorial