Skip to content

Latest commit

 

History

History
146 lines (117 loc) · 4.47 KB

README.ja.md

File metadata and controls

146 lines (117 loc) · 4.47 KB
Raw

[WIP] Port of redux-saga to Dart

英語

Dart-Saga は Redux-saga の Dart への移植版です。

このライブラリは、チャンネルを通じた Dart のアイソレート間の協調をサポートします。

単独で動作しますが、今後 dart-redux に組込まれる予定です

dart-saga(及び redux-saga)の目的は、アプリケーションの副作用、たとえば非同期処理や非純粋操作などを容易かつ効率的に実行し、テストを完結にしたり、失敗をより良く扱うことです。

redux-saga は ES6 ジェネレータを用いたコルーチンを並行処理の基盤としていますが、dart-saga では Dart のアイソレートとストリームを使用します。これは Dart の流儀に馴染み、自然であり実装を容易にしてもいます。とはいえ、dart-saga の API 上は、アイソレートやストリームを意識する必要はありません。

dart-saga は、低レベルな Dart のアイソレートやストリームの操作を抽象化・隠蔽する、上位のライブラリ層だと言うこともできるでしょう。

注意: このパッケージは開発中であり、多くの機能がまだ利用できません。フィードバックやプルリクエストを歓迎します。

サンプルコード

import "dart:async";
import 'package:dart_saga/dart_saga.dart';

rootSaga([msg, greeting]) async* {
  print("rootSaga(${msg}) started greeting: ${greeting}");
  Completer<int> saga2handle = new Completer();
  yield fork(saga2, ["start saga2"], saga2handle);

  for (int i = 0; i < 10; i++) {
    yield delay(1000);
    if (i == 5) {
      yield cancel(await saga2handle.future);
    }
  }
}

saga2([msg]) async* {
  print("           saga2(${msg}) started");
  Completer<int> saga3handle;
  yield fork(saga3, ["start saga3"], saga3handle);

  for (int i = 0; true; i++) {
    print("           saga2");
    yield delay(1000);
    yield put(Action("HOGE", "From saga2"));
    if (i == 3) {
      yield cancel(await saga3handle.future);
    }
  }
}

saga3([msg]) async* {
  print("                      saga3(${msg}) started");
  while (true) {
    print("                      saga3");
    Completer takenAction = new Completer();
    yield take("HOGE", takenAction);
    print("                      taken ${await takenAction.future}");
  }
}

main() {
  var effectManager = new EffectManager();
  effectManager.run(rootSaga, ["start rootSaga", "hello"]);
}

Demo

% pub run example/simple_demo.dart
start _isolate context
Task.start 0
rootSaga(start rootSaga) started greeting: hello
Task.start 1
           saga2(start saga2) started
           saga2
Task.start 2
                      saga3(start saga3) started
                      saga3
           saga2
                      taken Action(HOGE, From saga2)
                      saga3
           saga2
                      taken Action(HOGE, From saga2)
                      saga3
           saga2
                      taken Action(HOGE, From saga2)
                      saga3
Task(taskId=2) terminated: null.
Task(taskId=1) terminated: null.
Task(taskId=0) terminated: null.

Redux-Saga のエフェクト実装状況

  • take
  • takeMaybe
  • put
  • putResolve
  • all
  • race
  • call
  • apply
  • cps
  • fork
  • spawn
  • join
  • cancel
  • select
  • actionChannel
  • cancelled
  • flush
  • getContext
  • setContext,
  • retry
  • takeEvery
  • takeLatest
  • takeLeading
  • throttle
  • delay

仕様上の制約

yield が値を返さない

Dart のジェネレータおよび非同期ジェネレータでは、Dart の言語仕様上 yield が値を返すことはできません(Python や ES2015 では可能)。このライブラリではエフェクトの yield で値を取得するために Completer を使用します。

たとえば、

  int sagaHandle = yield fork(saga2, []);

のように書きたいときでも、本ライブラリでは以下のように記述する必要があります。

  Completer<int> sagaHandle = new Completer();
  yield fork(saga2, [], sagaHandle);

Isolate 間の保護

Isolate 間ではメモリは共有できません。1 つの Isolate で Completeter から他の Isolate で待ち受ける Future を発火させることはできません。