play2stub さらっと概要

play2stub の概要を少し作成しました。処理イメージのページを中心に御覧ください。

Transcript

1. play2stub さらっと概要 @scova0731 as of 2015.02.21
2. play2stub のユースケース play2stubの役割がわかりにくいということで軽く文書化。 ✓ クライアント開発時のスタブサーバとして ✓ あるリクエストにはあるJSONを返す、特定のHTMLを描画して返す。 ✓ Aeromock さんに出発点は似てそうですが、もっと簡易で、Play Framework に 依存。 ✓ プロキシっぽいサーバとして ✓ クライアントからのJSONでのリクエストを、更に内部の API サーバに経由し、 レスポンスをそのまま返したい場合 ✓ 一方、認証やHTML生成、HTTPヘッダーの修正などもおこないたい
3. play2stub を使うメリット 1. 前提知識は Play だけ。Play 環境のためのツール。 Play Framework に大部分を依存しているので、独自 感が薄い 2. とりあえずダミーレスポンスをおいて、クライアント開発を並行に進められる。ダミーのレスポンスは段階的 に本実装に置き換えていける 3. 簡単で冗長な部分が設定のみでよくなる 4. Filter、Processor、Renderer など処理の各所を変更可 (次ページ) 5. play2stub 自体が Play のプラグインに過ぎないので、使えない部分は普通にコードを書けばいいという安 心感 6. メンバーが多い時にコードに一定の規律を与えられるという副作用
4. 処理イメージ Web Server (Play) HTML JSON Controller play2stub Controller Before Filter After Filter Processor Param Injector API Server (Play) Template Resolver ・・・ Device Aware Template Resolver Renderer Handlebars Template Processor JSON Processor Proxy Processor Add Special Header Form to JSON Error Pages Rendering JSON 特定のエラーの場合 (Forbidden)に、 エラーページを描画する 例えばヘッダーを加えたりとか、 フォームの値は、すべて JSONに置換 したりとか。 たとえば、モバイルの場合にテンプ レートを分けることができる テンプレートで、 QueryStringやURL の情報を使えるようにする サーブレット的な発想。 Before Filter で Request を変更したり(イミュー タブルなので実際にはコピーすることになりそうですが )し、Processor で Result を作成、その後に After Filter で Result を改変したりする。 your play app. play2stub 特別なリクエストは特別なコード を書く。ここから部分的に Processorだけ呼んだり等も可能 開発時には、 Proxyを経由せずに Template/JSONで直接返せる (もとも とのstubの由来) 開発時には、 Proxyを経由せずに Template/JSONで直接返せる
5. Getting Started とりあえず動かしてみましょう。 $ git clone git@github.com:bizreach/play2-stub.git $ cd play2-stub/src/test/play2-sample1-stub $ ./activator run http://localhost:9000/ にアクセス！ - conf/routes をチェック - conf/application.conf をチェック
6. FAQ Q. 実績は？継続してメンテされるの？ A. BizReach の新サービス中の複数の Play サーバで利用されています。しばらくは継 続的に更新されるのではないかと。 Q. 中を見てみたんですが・・・ A. はい、微妙です。テストコードはなく、可読性が低い箇所も。。