CorutinとRetrofitを使用したAndroidのネットワーキング

Kotlinのコルーチンに関するレポートを読んで見れば見るほど、この言語ツールを賞賛しました。 彼らの安定版リリースは最近Kotlin 1.3でリリースされました。つまり、例として既存のRxJavaコードを使用して、ダイブを開始し、コルーチンを実際に試してみましょう。 この投稿では、RxJavaをコルーチンに置き換えることにより、既存のネットワーク要求を取得して変換する方法に焦点を当てます。

率直に言って、コルーチンを試す前は、以前とはまったく違うと思いました。 ただし、corutinの基本原則には、RxJavaリアクティブフローで使用されるものと同じ概念が含まれています。 例として、単純なRxJava構成を使用して、アプリケーションの1つからネットワーク要求を作成しましょう。

• Rxアダプター（ retrofit2：adapter-rxjava2 ）を使用して、 Retrofitのネットワークインターフェイスを定義します。 関数は、 SingleやObservableなどのRxフレームワークからオブジェクトを返します。 （古いコードもKotlinで作成されていると想定されているため、メソッドではなく関数がここで使用されます。まあ、またはAndroid Studioを介してJavaから変換されます）。
• 別のクラスから特定の関数（リポジトリ、アクティビティなど）を呼び出します。
• スケジューラを実行するスレッドを決定し、結果を返します（メソッド.subscribeOn（）および.observeOn（） ）。
• 登録解除のためにオブジェクトへのリンクを保存します（たとえば、CompositeObservableに）。
• イベントのストリームを購読します。
• アクティビティライフサイクルのイベントに応じて、ストリームの購読を解除します。

これは、Rxを使用するための基本的なアルゴリズムです（マッピング関数や他のデータ操作の詳細は考慮していません）。 コルチンに関しては、原則はあまり変わりません。 同じ概念、用語のみが変更されています。

• corutinのアダプターを使用して、Retrofitのネットワークインターフェイスを定義します。 関数はCorutin APIからDeferredオブジェクトを返します。
• これらの関数を別のクラス（リポジトリ、アクティビティなど）から呼び出します。 唯一の違い：各機能はsuspendとしてマークされる必要があります。
• コルーチンに使用されるディスパッチャーを定義します。
• 購読を解除するためにJobオブジェクトへのリンクを保存します。
• 可能な方法でコルーチンを実行します。
• アクティビティライフサイクルのイベントに応じてコルーチンをキャンセルします。

上記のシーケンスからわかるように、RxとCorutinの実行プロセスは非常に似ています。 実装の詳細を考慮しない場合、これは、既存のアプローチを維持できることを意味します-実装をコルーチンに優しいものにするためにいくつかのことを置き換えるだけです。

最初に行う必要がある手順は、Retrofitが遅延オブジェクトを返すことを許可することです。 遅延オブジェクトは、必要に応じて元に戻すことができる非ブロッキング先物です。 これらのオブジェクトは、本質的には対応するジョブの値を含むコルーチンジョブです。 Deferredタイプを使用すると、Jobと同じアイデアを組み合わせて、成功または失敗などの追加の状態を取得する機能を追加できます。これにより、ネットワーク要求に最適です。

RxJavaでRetrofitを使用している場合、RxJava Call Adapter Factoryを使用している可能性があります。 幸いなことに、Jake Wortonは彼女の同等のコルーチンを書いた。

Retrofitビルダーでこの呼び出しアダプターを使用して、RxJavaと同じ方法でRetrofitインターフェースを実装できます。

private fun makeService(okHttpClient: OkHttpClient): MyService { val retrofit = Retrofit.Builder() .baseUrl("some_api") .client(okHttpClient) .addCallAdapterFactory(CoroutineCallAdapterFactory()) .build() return retrofit.create(MyService::class.java) }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、上記で使用されているMyServiceインターフェイスを見てみましょう。 Retrofitインターフェイスで返されたObservable型をDeferredに置き換える必要があります。 以前は次のようでした：

 @GET("some_endpoint") fun getData(): Observable<List<MyData>>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次のように置き換えます：

 @GET("some_endpoint") fun getData(): Deferred<List<MyData>>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

getData（）を呼び出すたびに、Deferredオブジェクトが返されます。これは、ネットワーク要求のJobに相当します。 以前は、RxJavaでこの関数を何らかの方法で呼び出していました。

 override fun getData(): Observable<List<MyData>> { return myService.getData() .map { result -> result.map { myDataMapper.mapFromRemote(it) } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このRxJavaストリームでは、ユーティリティ関数を呼び出し、RxJava APIからマップ操作を適用して、リクエストから返されたデータをUIレイヤーで使用されるものにマッピングします。 コルーチンを使用した実装を使用すると、これは少し変わります。 まず、関数の本体内で遅延操作を実行するには、関数を中断 （遅延） する必要があります。 また、このために、呼び出し関数も延期する必要があります。 遅延関数は非ブロッキングであり、最初に呼び出された後に制御できます。 開始、一時停止、再開、キャンセルできます。

 override suspend fun getData(): List<MyData> { ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、ユーティリティ関数を呼び出す必要があります。 一見、同じことをしていますが、 ObservableではなくDeferredになったことを覚えておく必要があります。

 override suspend fun getData(): List<MyData> { val result = myService.getData() ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この変更により、RxJava APIのマップ操作チェーンを使用できなくなりました。 そしてこの時点でも、データは利用できません-Deferredインスタンスしかありません。 ここで、クエリの結果を待つためにawait（）関数を使用し、関数内のコードの実行を継続する必要があります。

 override suspend fun getData(): List<MyData> { val result = myService.getData().await() ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この時点で、完了したリクエストとそのデータを使用できるようになります。 したがって、マッピング操作を実行できるようになりました。

 override suspend fun getData(): List<MyData> { val result = myService.getData().await() return result.map { myDataMapper.mapFromRemote(it) } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Retrofitインターフェースを呼び出しクラスと一緒に使用し、コルーチンを使用しました。 ここで、Activityまたはフラグメントからこのコードを呼び出し、ネットワークから取得したデータを使用します。

アクティビティでは、Jobへのリンクを作成することから始めます。このリンクにコルーチン操作を割り当て、それを使用して、 onDestroy（）呼び出し中に要求のキャンセルなどを制御します。

 private var myJob: Job? = null override fun onDestroy() { myJob?.cancel() super.onDestroy() }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これで、myJob変数に何かを割り当てることができます。 コルーチンを使用してリクエストを見てみましょう。

 myJob = CoroutineScope(Dispatchers.IO).launch { val result = repo.getLeagues() withContext(Dispatchers.Main) { //do something with result } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この投稿では、これは他の投稿のトピックであるため、Dispatcherを掘り下げたり、コルーチン内で操作を実行したりすることはしたくありません。 要するに、ここで何が起こるか：

• IO Dispatcherをパラメーターとして使用してCoroutineScopeインスタンスを作成します。 このディスパッチャは、ネットワーク要求などのブロッキングI / O操作を実行するために使用されます。
• launch関数でコルーチンを起動します-この関数は新しいコルーチンを起動し、Job型の変数へのリンクを返します。
• 次に、リポジトリへのリンクを使用して、ネットワーク要求を実行してデータを受信します。
• 最後に、メインディスパッチャーを使用してUIスレッドで作業を行います。 ここで、受信したデータをユーザーに表示できます。

次の投稿では、著者は詳細をもう少し掘り下げることを約束しますが、コルーチンの研究を始めるには現在の資料で十分なはずです。

この投稿では、Retrofit応答のRxJava実装をCorutin APIのDeferredオブジェクトに置き換えました。 これらの関数を呼び出してネットワークからデータを取得し、アクティビティに表示します。 コルーチンの使用を開始するために必要な変更がどれだけ少ないかを理解し、特にコードの読み取りと書き込みを行う際にAPIのシンプルさを高く評価してください。

元の投稿のコメントで、私は伝統的なリクエストを見つけました：コード全体を表示します。 したがって、起動時にYandex。Schedules APIを使用して列車のスケジュールを受け取り、RecyclerViewに表示する単純なアプリケーションを作成しました。 リンク： https : //github.com/AndreySBer/RetrofitCoroutinesExample

また、コルーチンは、スレッドを同期するための同等の操作セットを提供しないため、RxJavaの劣った代替と思われることを付け加えます。 この点で、KotlinのReactiveX実装RxKotlinを見る価値があります。

Android Jetpackを使用している場合、Retrofit、コルーチン、LiveData、MVVMの例も見つけました： https ://codinginfinite.com/kotlin-coroutine-call-adapter-retrofit/