Android Architecture Blueprints での コルーチンの使われ方

良い記事がたくさんあります。

Kotlin の Coroutine を概観する

入門Kotlin coroutines

読んでみましたが、きちんと理解できてる自信がありません!

MVPの中で、どのように使われているかAndroid Architecture Blueprintsで見てみましょう。

todo-mvp-kotlin-coroutines

すべての非同期処理をコルーチンで置き換えます。シンプルな非同期プログラミングとなり、直感的にコード書くことができます。

 

Presenter

非同期処置の記述はここが起点になります。


private fun loadTasks(forceUpdate: Boolean, showLoadingUI: Boolean) = launchSilent(uiContext) {
    // ...
    val result = tasksRepository.getTasks()
    // ...
}

TasksPresenter.kt#L69

メインのデータをリポジトリから取得する部分です。


launchSilent(uiContext) {
  // ...
}

CoroutineExt.kt#L18-L25

と見慣れない コルーチンビルダーがありますが、元の形に戻すと、


launch(
  context = UI,
  start = CoroutineStart.DEFAULT,
  parent = null) {
  // ...
}

AppExecutors.kt#L32-L35

です。

Presenterでは、launch() でコルーチンの起点を作っています。

Viewのメソッドを利用しないメソッドでは、コルーチンコンテクストは、DefaultDispatcher となり省略することができます。

 

Repository


override suspend fun getTasks(): Result<List<Task>> {
  // ...
  val result = tasksLocalDataSource.getTasks()
  // ...
 }

TasksRepository.kt#L49-L69


override suspend fun getTasks(): Result<List<Task>> = withContext(appExecutors.ioContext) {
  // ...
  Result.Success(tasksDao.getTasks())
  // ...
}

TasksLocalDataSource.kt#L34-L41

Repository -> LocalDataSource とサスベンドなfunctionが深く呼ばれていきます。

LocalDataSource では、Presenterでのlauch()時のコルーチンコンテキストから、withContext(appExecutors.ioContext) として、すべて、ioContext としての DefaultDispatcher に一時的に切り替えています。

 

まとめ

ざっくり、コルーチン関連の入れ子関係を書いてみると、


// presenter
launch(context = UI, parent = null) {

  // repository
  withContext(DefaultDispatcher) {
    // fetch data from database
  }

}

Presenter で launch() して、Repository末端(local/remote) で withContext() でコンテクスト切り替え。

もちろん、コルーチン内から呼ばれるのは、repository の suspend な functionず。


SharedPreferences で putStringSet() が1つしか保存できない。

何ですか、この動きは。

「Preference から Set を取得後、追加して再保存する」

問題なく以下のようなテストも通過します。


@Test fun getStringSet() {

  val key = "key"
  val preferences = context.getSharedPreferences(key, Context.MODE_PRIVATE)
  val beforeData = preferences.getStringSet(key, mutableSetOf())
  val beforeSize = beforeData.size

  beforeData.add(System.currentTimeMillis().toString())
  preferences.edit()
      .putStringSet(key, beforeData)
      .commit()

  val afterData = preferences.getStringSet(key, mutableSetOf())
  val afterSize = afterData.size

  println("$beforeData -> $afterData")
  println("$beforeSize -> $afterSize")
  assertEquals(beforeSize + 1, afterSize)

}


I/System.out: [1520865219872, 1520865358333] -> [1520865219872, 1520865358333]
I/System.out: 1 -> 2

しかし、何回実行してもデータが1つのままで増えていきません。


I/System.out: [1520865219872, 1520865504185] -> [1520865219872, 1520865504185]
I/System.out: 1 -> 2

I/System.out: [1520865219872, 1520865553254] -> [1520865219872, 1520865553254]
I/System.out: 1 -> 2

実際にファイルを確認してみると、


mako:/data/data/com.example.cryptocurrency/shared_prefs # cat key.xml
<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
    <set name="key">
        <string>1520865219872</string>
    </set>
</map>

1つしか保存されてないですね!

クソですね!

なぜなのか?

android - Misbehavior when trying to store a string set using SharedPreferences - Stack Overflow

Android compares the modified HashSet that you are trying to save using SharedPreferences.Editor.putStringSet with the current one stored on the SharedPreference, and both are the same object!!!

A possible solution is to make a copy of the Set returned by the SharedPreferences object

どうやら、同じオブジェクトの比較となるので保存してくれないようです。

読み出し後、すぐコピーすればいいのですね!


val beforeData = preferences.getStringSet(key, mutableSetOf()).toMutableSet()

なんとなく、よくある話のような気がします。


【Kotlin】coroutine 複数の非同期処理をまとめてキャンセルする

非同期処理には必ず絡んでくるのがライフサイクル。

RxJava のようにまとめたいですよね。


private CompositeDisposable compositeDisposable =
    new CompositeDisposable();

@Override public void onCreate() {
  compositeDisposable.add(backendApi.loadUser()
      .subscribe(this::displayUser, this::handleError));
}

@Override public void onDestroy() {
  compositeDisposable.clear();
}

SendChannel を使って同様にこのような。


interface JobHolder {
  val job: Job
}


class MainActivity : AppCompatActivity(), JobHolder {

  override val job: Job = Job()

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    addJob {
      while (true) {
        delay(500)
        println("A")
      }
    }

    addJob {
      while (true) {
        delay(1000)
        println("B")
      }
    }

  }

  // Job の actor として action を登録する
  private fun addJob(action: suspend () -> Unit) {

    val actor = actor<Unit>(job + UI, capacity = Channel.CONFLATED) {
      for (event in channel) action()
    }
    actor.offer(Unit)
  }


  override fun onDestroy() {
    super.onDestroy()
    job.cancel()
  }

}

まとめてキャンセルできましたね!

どうせなら作って置いたらどうだろう。


class JobHolder {

  private val job = Job()

  fun add(action: suspend () -> Unit) {
    val actor = actor<Unit>(job + UI, capacity = Channel.CONFLATED) {
      for (event in channel) action()
    }
    actor.offer(Unit)
  }

  fun cancel() {
    job.cancel()
  }
}

Lifecycle and coroutine parent-child hierarchy
Children of a coroutine

 

こうでもいけるってよ: 2018-04-27追記


val rootParent = Job()

fun foo() {
  launch(UI, parent = rootParent) {
    // ...
  }
}

fun bar() {
  launch(CommonPool, parent = rootParent) {
    // ...
  }
}

fun destroy() { rootParent.cancel() }

Kotlin Coroutines on Android: Things I Wish I Knew at the Beginning


Soundflower と Audio MIDI設定

なんとなく接続できてるがなんだかきもいです。

OBS 音声設定の Soundflower。

Releases · mattingalls/Soundflower · GitHub

自在に利用したいので接続のつながりを少し整理しておきます。

どうしてSoundFlowerとかいるのか。

以下の問題があるそうです。

macOS版 OBS Studio既知の問題一覧 (公式サイトより引用)
・デスクトップオーディオをキャプチャする場合は、仮想音声デバイスを利用する必要があります。

OBS Studio for macOS インストール / アップデート 方法解説:OBS Studioに関する情報投稿ブロマガ - ブロマガ

ここでいう「仮想音声デバイス」が Soundflower らしいです。

OBSで設定-音声をみてみます。

選択肢には Soundflower しかありませんね。

「既定」は何なのか謎ですがとりあえず音声は受け取れてないようでした。

「デスクトップ音声」の設定

OBSがデスクトップ音声をSoundflowerからしか受け取れないことは分かりました。

あとはこの先に「デスクトップ音声」を接続すればいいのですね!

Mac設定から「サウンド」「出力」で 「Soundflower(2ch)」を選択します。

これで、いけるっちゃあいけるのですが、Macからは音がでなくなりました。

クソですね!

Audio MIDIの設定

「OBS」と「内蔵出力(スピーカーやヘッドホン)」の2つに「デスクトップ音声」をわたしたいですよね!

しかし、Mac設定から「サウンド」「出力」では「サウンドを出力する装置」は一つしか選択できません。

Mac上で「アプリケーション」「ユーティリティ」に「AudioMIDI設定」というのがあります。

これは、Macの設定「サウンド」の詳細設定ができるものです。

赤い四角のスピーカーマークが「デスクトップ音声」です。サウンド設定から「Soundflower(2ch)」を選択しましたよね。

ここで「複数出力装置」なるものを作ると分岐できるようになります。

「内蔵出力(スピーカー)」を有効にして、「標準出力装置」を右クリックで「デスクトップ音声」を接続します。

これは以下のようにつながっています。

これで、Mac上の音声を聞きながらOBS経由でゲーム配信できますね!

まとめ

「OBS」は「Soundflower」からしか「デスクトップ音声」を取得できない。

「デスクトップ音声」はひとつのデバイスしか接続できないのでその先で分岐する。

「複数出力装置」や「Soundflower」は、複数の入出力を行えるデバイスである。

だが、さまざまな理由からソフトウェアによって利用できない入出力デバイスがある。

ゲーム配信者はすごいなあ。

👉 【Catalina】SoundFlowerからBlackHoleに移行してOBS接続おさらい 

Soundflower - ニコニコ生主のためのwiki
機器セットを作成して複数のオーディオインターフェイスを組み合わせる - Apple サポート
「Audio MIDI 設定.app」を紐解く | scribble warehouse


Flip Tables で List を見やすくログに表示する

安定のJake産です。

JakeWharton/flip-tables: Because pretty-printing text tables in Java should be easy.

例えば、ログに、List<Item> を


println(list)

このように表示されているのが、


I/System.out: [Item(exchange=quoine, pair=bchjpy, price=127989.3), Item(exchange=bitflyer, pair=btcfxjpy, price=1073351.0), Item(exchange=kraken, pair=btcjpy, price=1046576.0), Item(exchange=bitflyer, pair=btcjpy, price=1038000.0), Item(exchange=quoine, pair=btcjpy, price=1035870.94), Item(exchange=kraken, pair=ethjpy, price=91402.0), Item(exchange=quoine, pair=ethjpy, price=90595.82), Item(exchange=kraken, pair=xrpjpy, price=109.815), Item(exchange=kraken, pair=zecjpy, price=41855.0)]

こう書くだけで、


println(FlipTableConverters.fromIterable(list, Item::class.java))

こんなテキストで表で整形されて表示されます。


I/System.out: ╔══════════╤══════════╤════════════╗
I/System.out: ║ Exchange │ Pair     │ Price      ║
I/System.out: ╠══════════╪══════════╪════════════╣
I/System.out: ║ quoine   │ bchjpy   │ 127989.3   ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ bitflyer │ btcfxjpy │ 1073351.0  ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ kraken   │ btcjpy   │ 1046576.0  ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ bitflyer │ btcjpy   │ 1038000.0  ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ quoine   │ btcjpy   │ 1035870.94 ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ kraken   │ ethjpy   │ 91402.0    ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ quoine   │ ethjpy   │ 90595.82   ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ kraken   │ xrpjpy   │ 109.815    ║
I/System.out: ╟──────────┼──────────┼────────────╢
I/System.out: ║ kraken   │ zecjpy   │ 41855.0    ║
I/System.out: ╚══════════╧══════════╧════════════╝

数秒で使えます。

 

なんだかスッキリな気分となったりで気分転換にもよいですよー。