Android
RxJavaを使ったRetrofit2
サーチ…
RxJavaを使ったRetrofit2
まず、関連する依存関係をbuild.gradleファイルに追加します。
dependencies {
....
compile 'com.squareup.retrofit2:retrofit:2.3.0'
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.3.0'
....
}
次に、受信したいモデルを作成します。
public class Server {
public String name;
public String url;
public String apikey;
public List<Site> siteList;
}
リモートサーバーとのデータ交換に使用されるメソッドを含むインターフェイスを作成します。
public interface ApiServerRequests {
@GET("api/get-servers")
public Observable<List<Server>> getServers();
}
次に、 Retrofitインスタンスを作成します。
public ApiRequests DeviceAPIHelper ()
{
Gson gson = new GsonBuilder().create();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://example.com/")
.addConverterFactory(GsonConverterFactory.create(gson))
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
api = retrofit.create(ApiServerRequests.class);
return api;
}
次に、コードのどこからでもメソッドを呼び出します。
apiRequests.getServers()
.subscribeOn(Schedulers.io()) // the observable is emitted on io thread
.observerOn(AndroidSchedulers.mainThread()) // Methods needed to handle request in background thread
.subscribe(new Subscriber<List<Server>>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
}
@Override
public void onNext(List<Server> servers) {
//A list of servers is fetched successfully
}
});
データを非同期的に取得するためのRxJavaによる更新
RxJavaのGitHubリポジトリから、 RxJavaは、Reactive ExtensionsのJava VM実装です。これは、観察可能なシーケンスを使用して非同期およびイベントベースのプログラムを作成するためのライブラリです。これはオブザーバパターンを拡張してデータ/イベントのシーケンスをサポートし、低レベルのスレッド、同期、スレッドセーフティ、および同時データ構造などの懸案事項を抽象化しながらシーケンスを宣言的に組み合わせる演算子を追加します。
Retrofitは、AndroidとJavaのためのタイプセーフなHTTPクライアントです。これを使用すると、開発者はすべてのネットワークをより簡単にすることができます。例として、いくつかのJSONをダウンロードし、それをRecyclerViewにリストとして表示します。
入門：
アプリケーションレベルのbuild.gradleファイルにRxJava、RxAndroid、Retrofitの依存関係を追加します： compile "io.reactivex:rxjava:1.1.6"
compile "io.reactivex:rxandroid:1.2.1"
compile "com.squareup.retrofit2:adapter-rxjava:2.0.2"
compile "com.google.code.gson:gson:2.6.2"
compile "com.squareup.retrofit2:retrofit:2.0.2"
compile "com.squareup.retrofit2:converter-gson:2.0.2"
ApiClientとApiInterfaceを定義してサーバーからデータを交換する
public class ApiClient {
private static Retrofit retrofitInstance = null;
private static final String BASE_URL = "https://api.github.com/";
public static Retrofit getInstance() {
if (retrofitInstance == null) {
retrofitInstance = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.addConverterFactory(GsonConverterFactory.create())
.build();
}
return retrofitInstance;
}
public static <T> T createRetrofitService(final Class<T> clazz, final String endPoint) {
final Retrofit restAdapter = new Retrofit.Builder()
.baseUrl(endPoint)
.build();
return restAdapter.create(clazz);
}
public static String getBaseUrl() {
return BASE_URL;
}}
パブリックインターフェイスApiInterface {
@GET("repos/{org}/{repo}/issues")
Observable<List<Issue>> getIssues(@Path("org") String organisation,
@Path("repo") String repositoryName,
@Query("page") int pageNumber);}
getRepos（）は、問題のリストだけでなくObservableを返すことに注意してください。
モデルを定義する
これの例が示されています。 JsonSchema2Pojoなどの無料サービスを利用できます。
public class Comment {
@SerializedName("url")
@Expose
private String url;
@SerializedName("html_url")
@Expose
private String htmlUrl;
//Getters and Setters
}
レトロフィットインスタンスの作成
ApiInterface apiService = ApiClient.getInstance().create(ApiInterface.class);
次に、このインスタンスを使用してサーバーからデータを取得します
Observable<List<Issue>> issueObservable = apiService.getIssues(org, repo, pageNumber);
issueObservable.subscribeOn(Schedulers.newThread())
.observeOn(AndroidSchedulers.mainThread())
.map(issues -> issues) //get issues and map to issues list
.subscribe(new Subscriber<List<Issue>>() {
@Override
public void onCompleted() {
Log.i(TAG, "onCompleted: COMPLETED!");
}
@Override
public void onError(Throwable e) {
Log.e(TAG, "onError: ", e);
}
@Override
public void onNext(List<Issue> issues) {
recyclerView.setAdapter(new IssueAdapter(MainActivity.this, issues, apiService));
}
});
これで、RetrofitとRxJavaを使用してサーバーからデータを正常に取得できました。
ネストされたリクエストの例：複数のリクエスト、結果の結合
1つのリクエスト（ getAllPets ）と1つのリソース（ getSinglePet ）の完全なデータを持つ他のリクエストでオブジェクトメタデータを取得できるAPIがあるとします。どのようにしてそれらのすべてを単一のチェーンでクエリできますか？
public class PetsFetcher {
static class PetRepository {
List<Integer> ids;
}
static class Pet {
int id;
String name;
int weight;
int height;
}
interface PetApi {
@GET("pets") Observable<PetRepository> getAllPets();
@GET("pet/{id}") Observable<Pet> getSinglePet(@Path("id") int id);
}
PetApi petApi;
Disposable petsDisposable;
public void requestAllPets() {
petApi.getAllPets()
.doOnSubscribe(new Consumer<Disposable>() {
@Override public void accept(Disposable disposable) throws Exception {
petsDisposable = disposable;
}
})
.flatMap(new Function<PetRepository, ObservableSource<Integer>>() {
@Override
public ObservableSource<Integer> apply(PetRepository petRepository) throws Exception {
List<Integer> petIds = petRepository.ids;
return Observable.fromIterable(petIds);
}
})
.flatMap(new Function<Integer, ObservableSource<Pet>>() {
@Override public ObservableSource<Pet> apply(Integer id) throws Exception {
return petApi.getSinglePet(id);
}
})
.toList()
.toObservable()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<List<Pet>>() {
@Override public void accept(List<Pet> pets) throws Exception {
//use your pets here
}
}, new Consumer<Throwable>() {
@Override public void accept(Throwable throwable) throws Exception {
//show user something goes wrong
}
});
}
void cancelRequests(){
if (petsDisposable!=null){
petsDisposable.dispose();
petsDisposable = null;
}
}
}
