RxJavaでリアクティブなデータバインディング

旧ブログ(blog.ogaclejapan.com)から移行してきた古い記事です。 移行に伴い、一部のレイアウトが崩れている可能性もありますmm

Author's Avatar mini

Masaki Ogata

AuthorMasaki Ogata

Published

この記事は CyberAgent エンジニア Advent Calendar 2014 22日目の投稿です。 昨日は@k66dango さんの「Odd Sketchesを使ったJaccard係数の推定」でした。

22日目は今年の6月にサーバサイドJavaエンジニアからAndroiderへ暗黙な型変換した@ogaclejapanが担当します。

会社では9日目の記事を担当した 若手の有望株である@horimislimeさんと同じ部署で、 POAA(Plain Old Android Application)の開発を担当しています( ´∀｀)人(´∀｀ )

はじめに

弊社では、エンジニア各人が興味を持つ分野について研究レポートを発表する制度として、 「テックレポート」というものがあります。 Androiderへ型変換した直後にテックレポートを発表する機会があったので、 流行りの__リアクティブプログラミング__*1などを取り入れたAndroidアプリを作ってみました。

*1: 2015年に備えて知っておきたいリアクティブアーキテクチャの潮流 - hirokidaichi

当初はすぐアプリを公開する予定でしたが、、、 コードやMaterialデザインのリファクタを繰り返してたら時は過ぎ、今に至る今日この頃です。。

…ということで「今日というよき日」にリリースしましたーー！！　(　；∀；) ﾅﾝﾃｲｲﾋﾀﾞﾅｰ

Image

Githubでコードも公開してますので、ぜひ興味のある方は見てください。

https://github.com/ogaclejapan/Qiitanium

はい、前置きが若干長くなってしまいました。。

公開したアプリの中でRxJavaをベースにしたデータバインディングを自作してみましたので、 これをテーマに書きたいと思います。

※RxJavaについてはある程度知識がある前提で書いてますので、 初めて聞いた人は先にこのあたりの記事を読むとわかりやすいかもしれません。

RxBinding

RxJavaは実行スレッドの制御や非同期処理やデータ加工、結合などにとても優れている強力なライブラリです。 APIへ非同期リクエストして結果を内部データ形式に変換して返すようなバックエンド部分から導入してみるのがベストだと思います。 そして実際に使っていくと、すごい便利なのでObservable<T>でどんどんデータを返却したくなってきます。

しかし、Androidアプリ全体に適用するにはいくつか注意が必要です

  • Android固有のActivity/Fragmentライフサイクル
  • UIスレッド以外でのGUI操作
Android固有のActivity/Fragmentライフサイクル問題

Androidアプリでネットワーク通信を非同期処理して結果をUIへ反映するコールバック処理を書く場合、 このようなコードが最初に書いてあります。


class HogeActivity extends Activity {

	void requestOnNetwork() {

		AsyncHttp.get("http://ogaclejapan.com/api/hoge", new OnCompletionListener() {

			@Override
			public void onSuccess(Hoge hoge) {
				if (isFinishing()) {
					return;
				}

				/* ここからUI操作処理 */
			}

			@Override
			public void onFailure(Throwable t) {
				if (isFinishing()) {
					return;
				}

				/* ここからUI操作処理 */
			}

		});
	}
}

isFinishing()の定義が無い状態でリクエスト中にBackキーなどで他画面へ遷移した後にリクエストが返却されると、 予期せぬエラーでアプリが落ちる可能性があります。

UIスレッド以外でのGUI操作問題

Androidに限らず、大抵のGUIアプリケーションではUIスレッド以外からのGUI操作はエラーとなります。 RxJavaは実行スレッドを柔軟に制御できるため大変便利ですが、反面UIスレッドの指定が漏れると実行時エラーになります。

例外メッセージ: Only the original thread that created a view hierarchy can touch its views

class HogeActivity extends Activity {

	private TextView mTextView;

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
		mTextView = (TextView) findViewById(R.id.text);

		Observable.create(new Observable.OnSubscribe<String>() {
			@Override
			public void call(Subscriber<? super String> subscriber) {
				SystemClock.sleep(1000);
				subscriber.onNext("hoge");
				subscriber.onCompleted();
			}
		})
		.subscribeOn(Schedulers.io()) //.observeOn(xx)の定義漏れ！！
		.subscribe(setTextAction());

	}

	Action1<String> setTextAction() {
		return new Action1<String>() {
			@Override
			public void call(String text) {
				mTextView.setText(text);
			}
		};
	}

}

このようにちょっとした定義漏れで例外によりアプリが落ちてしまいます。 実はRxJavaにはAndroidのUIスレッドを指定できるSchdulerクラスがありません^^;

そこでRxBinding！！

RxJavaのrx.Observable<T>をUI側でより使いやすく、安全にデータバインディングできるようなライブラリを作ってみました。 あくまで補完するラッパー的な目的で作っているので非常にコンパクトなライブラリです^^;

RxBinding: https://github.com/ogaclejapan/RxBinding

Image

もともとは.NetのReactiveUIライクなMVVMバインディングをRxJavaでも作れないかな〜？ という感じで作り始めたので、TupleとかUnitというClass名は.Netで使われている名前が由来になってます。

主なClass

Rx<T>

Rx<T>はデータバインディングの対象となるオブジェクトをデータバインディングするためのInterfaceです。 このInterface実装したClassをいくつか用意してあります。

各実装は対象オブジェクトのライフサイクルに応じてデータバインディングを制御したり、 データ変更を反映する実行スレッドを内部で制御してます。


public class RxActivity<T extends Activity> extends RxWeakRef<T> {

    protected RxActivity(final T activity) {
        super(activity);
    }

    public static <T extends Activity> RxActivity<T> of(T activity) {
        return new RxActivity<T>(activity);
    }

    @Override
    protected boolean isBindable(final T activity) {
        return !activity.isFinishing();
    }

    @Override
    protected final Scheduler observeOn() {
        return MAIN_THREAD_SCHEDULER;
    }

先ほど書いた注意が必要な点はこのクラスを使うことで、 各ライフサイクルに応じて強制的に制御されるので開発者の定義漏れによるエラーなどは解消されます。


/* Rxの使い方 */

//どのクラスも'RxXX.of(T)'staticメソッドで既存のオブジェクトから変換できます。
Rx<HogeActivity> mThisActivity = RxActivity.of(this);
Rx<HogeFragment> mThisFragment = RxFragment.of(fragment);
Rx<HogeView> mHogeView = RxView.of(view);

//RxViewのみButterKnifeみたいに'RxView.findById(..)'で直接View/Activityから取得し変換することもできます。
Rx<TextView> mTextView = RxView.findById(activity, R.id.text);
Rx<ImageView> mImageView = RxView.findById(view, R.id.image);

//上記に図にも書いてある通り、後述するRxPropery<E>やRxEvent<E>, Observable<E>からバインディングできます
Rx<TextView> mTextView = RxView.findById(activity, R.id.text);
Subscription s = mTextView.bind(Observable.from("hoge"), RxActions.setText());

RxProperty<String> mText = RxProperty.of("hoge");
Subscription s = mTextView.bind(mText, RxActions.setText());

RxEvent<String> mOnTextChanged = RxEvent.create();
Subscription s = mTextView.bind(mOnTextChanged, RxActions.setText());
mOnTextChanged.post("hoge");
RxProperty<E>

RxProperty<E>はRxjavaのBehaviorSubjectを内部に利用しています。 BehaviorSubjectは初期値をもつことができ、最後に更新された値を保持し続ける無限ストリームです。


/* RxPropertyの使い方 */

//RxProperty<E>は初期値を制御できます
RxProperty<String> mHoge = RxProperty.of("hoge");
RxProperty<String> mHoge = RxProperty.create(); //初期値なし

//RxProperty<E>はpull型の'E get()'とpush型の'Observable<E> asObservable()'メソッドを公開しています
String hoge = mHoge.get();
Observable<String> hoge = mHoge.asObservable();

//'set(E)'メソッドで値の更新します
mHoge.set("age") //mHoge.get() => "age"

//値を更新できない参照用のRxReadOnlyProperty<E>をベースClassにもってます
RxReadOnlyProperty<E> mNotWritableHoge = mHoge;

//RxPropertyは他のRxPropertyや'Observable<E>'からデータを連結することもできます
RxProperty<String> mAge = RxProperty.of("age");
Subscription s = mHoge.bind(mAge); //mHoge.get() => "age"
RxProperty<Date> mNow = RxProperty.of(new Date());
Subscription s = mHoge.bind(mNow, RxUtils.formatDate("yyyy-MM-dd")); //mHoge.get() => "2014-12-22"
RxEvent<E>

RxEvent<E>はRxJavaのPublishSubjectを内部に利用しています。 PublishSubjectは値を一切保持せず、AndroidのUIイベント同じく一度限りの値をpostする無限ストリームです。


/* RxEventの使い方 */

//RxPropertyと違い、生成メソッドは１つしかありません
RxEvent<String> mOnTextChanged = RxEvent.create();

//post(E)メソッドで値を通知します
mOnTextChanged.post("hoge");

//値を保持していないのでpush型の'E asObservable()'メソッドしかありません
Observable<String> mHogeObservable = mOnTextChanged.asObservable();

//RxPropertyと同様に他のObservableなどからデータを連結通知させることができます
RxEvent<Date> mNow = RxEvent.create();
Subscription s = mOnTextChanged.bind(mNow, RxUtils.formatDate("yyyy-MM-dd"));
mNow.post(new Date()); //=> mOnTextChanged.post("yyyy-MM-dd")
RxList<E>

RxList<E>はJavaでおなじみのList<E>を実装したClassです


/* RxListの使い方 */

//RxListは生成メソッドが2種類あります
RxList<String> mList = RxList.create(); //=>デフォルトはArrayList型になります
RxList<String> mList = RxList.of(list); //=>指定したList型になります

//他のList型とデータ連動できます
RxList<String> mMasterList = RxList.create();
Subscription s = mList.bind(mMasterList);
RxListAdapter<E>

RxListAdapter<E>はListView,GridViewに使うListAdapterを実装したClassです


/* RxListAdapterの使い方 */

//RxListAdapterはabstractなので継承して使います
class RxStringListAdapter extends RxListAdapter {...};
RxStringListAdapter<String> mListAdapter = RxStringListAdapter.create();

//List型とデータ連動できます
RxList<String> mMasterList = RxList.create();
Subscription s = mStringListAdapter.bind(mMasterList);

mMasterList.add("hoge");
mMasterList.add("age");
mMasterList.add("foo");
//MasterList.toString() => ["hoge", "age", "foo"]
//mListAdapter.list => ["hoge", "age", "foo"]
うーん、、実際にどう使うかイメージ沸きませんな。。。

当初はDemoアプリをライブラリに同封する予定でしたが、全く間に合う気がしませんでした(´・ω・｀)ｼｮﾎﾞｰﾝ　　

公開した「Qiitanium」には過剰なほどRxBindingを使ってます。

presentationパッケージあたりを見てもらえると、 モデルが更新されて表示面のビューも更新されるようなデータバインディングの仕組みを理解できると思います。

…えっ、それRxAndroidでも解決できない？

はい、RxAndroidでもAndroidアプリ全体をリアクティブに処理するときの注意点は解決できます。

RxAndroid: https://github.com/ReactiveX/RxAndroid

実行スレッドにUIスレッドを指定できるAndroidSchedulers#mainThread()に含まれています。 (RxBindingもUIスレッド実行用のSchdulerはこのコードを使ってます)

ライフサイクルまわりを制御するメソッドは、6月頃にはなかったような記憶ですが、 非常に開発が活発でいつのまにかも用意されてました。

あとRxAndroidはUIまわりのイベントをObservable化する機能をもってたりするので、 RxBindingと組み合わせて使うとMVVMライクな双方向データバインディングも作れるかもしれません。

まとめ

ザ・Bootstrapのサイトでブログが大変読みづらくてすみませんｍ（＿＿）ｍ 次回参加する機会があればそのときは格好良くしておきます。

Material…　…　…Bootstrapとかに( ；∀；)

CyberAgent エンジニア Advent Calendar 2014 の23日目は@brfrn169さんが担当します。

それではAndroiderにとって来年も良い年でありますようにー☆

Author's Avatar

Masaki Ogata ( a.k.a. ogaclejapan )

5年間ほどAndroidアプリ開発者へ型変換していましたが、Designも含めてサービス開発に必要な技術をすべて吸収していきたいマン。WebとBackendの記憶を只今アップデート中 :P

もし気に入っていただけたら記事シェアのご協力をお願いします！！