アンドロイドのレトロフィットの例のチュートリアル

2年 ago
陽, 向宇
7 minutes

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

アンドロイドの改修

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

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') {  
  // exclude Retrofit’s OkHttp dependency module and define your own module import
  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'
  • The logging-interceptor generates a log string of the entire response that’s returned.
  • There are other converters to parse the JSON to the necessary type. A few of them are listed below.
    1. Jackson: com.squareup.retrofit2:converter-jackson:2.1.0

 

    1. Moshi: com.squareup.retrofit2:converter-moshi:2.1.0

 

    1. Protobuf: com.squareup.retrofit2:converter-protobuf:2.1.0

 

    1. Wire: com.squareup.retrofit2:converter-wire:2.1.0

 

    1. Simple XML: com.squareup.retrofit2:converter-simplexml:2.1.0

Jackson: com.squareup.retrofit2:converter-jackson:2.1.0
Moshi: com.squareup.retrofit2:converter-moshi:2.1.0
Protobuf: com.squareup.retrofit2:converter-protobuf:2.1.0
Wire: com.squareup.retrofit2:converter-wire:2.1.0
Simple XML: com.squareup.retrofit2:converter-simplexml:2.1.0

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

OkHttpのインターセプター

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

  • Application Interceptors : To register an application interceptor, we need to call addInterceptor() on OkHttpClient.Builder
  • Network Interceptors : To register a Network Interceptor, invoke addNetworkInterceptor() instead of addInterceptor()

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

package com.scdev.retrofitintro;

import com.scdev.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.scdev.retrofitintro;

import com.scdev.retrofitintro.pojo.MultipleResource;
import com.scdev.retrofitintro.pojo.User;
import com.scdev.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クラスはメソッドの戻り値の型として機能します。MultipleResources.javaのためのシンプルなPOJOクラスは次のとおりです。

package com.scdev.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 – Sends Java objects as request body.
  • @Url – use dynamic URLs.
  • @Query – We can simply add a method parameter with @Query and a query parameter name, describing the type. To URL encode a query use the form: @Query(value = “auth_token”,encoded = true) String auth_token
  • @Field – send data as form-urlencoded. This requires a @FormUrlEncoded annotation attached with the method. The @Field parameter works only with a POST

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

Androidのレトロフィットの例のプロジェクト構造を変更する。

ポジョパッケージは、APIInterface.javaクラスで定義されているAPIエンドポイントの応答ごとに4つのモデルクラスを定義しています。User.java

package com.scdev.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;
    }


}

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

package com.scdev.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.scdev.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;
}

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

package com.scdev.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.scdev.retrofitintro.pojo.CreateUserResponse;
import com.scdev.retrofitintro.pojo.MultipleResource;
import com.scdev.retrofitintro.pojo.User;
import com.scdev.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サンプルプロジェクトをダウンロードする

コメントを残す 0

Your email address will not be published. Required fields are marked *

✖
广告
広告は10秒後に閉じます。
bannerAds