Crafting Rails 4 Application 読み会（第６章）

Slide 1

Slide 1 text

Cra$ing Rails4 Applica0on Masatoshi Iwasaki 6. Wri0ng DRY Controllers with Responders

Slide 2

Slide 2 text

概要 •  カスタムのResponderを使うことでよりDRYにコントローラが書ける。 •  ScaﬀoldのテンプレートをカスタムResponder 用にカスタマイズするとさらにDRYになる。 •  （青字になっている箇所は発表者注です。）

Slide 3

Slide 3 text

Introduc0on •  Scaﬀoldのコードはちょっと冗長。 – 繰り返し大杉。 – 特にrespond_to周辺。 •  これをrespond_withを使うことでさくっとDRYな感じにできる。

Slide 4

Slide 4 text

Scaﬀold的なコントローラ

Slide 5

Slide 5 text

respond_with使うとDRYに書ける

Slide 6

Slide 6 text

Ac0onController::Responder •  この辺をまとめて引き受けてるのが Responder。 •  自分でResponderを定義することでさらにいろんなことができる。

Slide 7

Slide 7 text

本章のゴール •  ２種類のResponderを作る。 – １）HTTPリクエストに対して適切なキャッシュを返すResponder – ２）Flashを管理するResponder。

Slide 8

Slide 8 text

Responderを理解する

Slide 9

Slide 9 text

HTTP verbs（method） •  ResponderはHTTP verbs（HTTPメソッド）と密接に関連してる。 •  Responderが具体的にどういうメソッドにどう対応しているかを見ていく。 •  なぜかここではRESTという単語が出てこないがで、本章後半で説明される。 •  Railsで開発してると当たり前な説明なので HTP verbsの結論までは省略。

Slide 10

Slide 10 text

要するにこんな感じ •  Naviga0onalはHTMLで返す場合の対応 •  APIはJSONやXMLで返す場合の対応

Slide 11

Slide 11 text

寄り道：RESTとは •  Representa0onal State Transferの略 •  Roy Fieldingsの博士論文で提唱された。 –  “Architectural Styles and the Design of Network-‐based So$ware Architectures” (2000) •  PDFとHTMLで公開されてる。 –  博士論文ということもあって前半は過去の研究のまとめで分量がヘビー。 –  一見シンプルでさくっと思いつきそうにみえるRESTも実際は様々なアーキテクチャを踏まえた上でのウェブにおける解だということが分かる。 •  HTTP 1.1とURIをデザインに影響を与えた。

Slide 12

Slide 12 text

寄り道：RESTで何が良くなった？ •  HTTP 1.0ではRFCで定義されていたのはGET, HEAD, POSTだけ。 – PUTやDELETEなどはaddi0onal feature扱い。 •  HTTP 1.1でRESTで使われているPUT, DELETE などが追加された。 – 元々URLに指定されたHTMLを取ってくるだけだったプロトコルがURIとHTTPメソッドによってサーバー上のリソース管理をできるように拡張された – （と、いうことが画期的だったんだと思う）。

Slide 13

Slide 13 text

Responderの呼び出しインターフェース •  Callメソッドを持っていて引数を受け取れればいいだけ。 – 引数は呼び出し元のコントローラ、リソース、オプションの３つ。 •  newしてすぐrespondメソッドが呼ばれる。

Slide 14

Slide 14 text

Responderのメソッド •  やってることは単純。 •  to_htmlとto_jsだけ定義されていて、他はsendで to_hogehogeを呼び出すだけ。

Slide 15

Slide 15 text

Responder#to_html •  テンプレートをレンダリングしようとして、なかったらnaviga0on_behaviorを呼ぶ。

Slide 16

Slide 16 text

Responder#naviga0on_behavior •  この動きが先ほど出てきたHTTP verbsとの対応関係に沿っている。

Slide 17

Slide 17 text

Responder#to_format •  こっちもテンプレートなかったらapi_behaviorを呼ぶ。 •  エラーがちゃんとされていればdisplay_errors のほうに行く。

Slide 18

Slide 18 text

Responder#api_behavior •  こちらもHTTP verbsに対応している。 – else以下はupdateやdestroyでテンプレートがない場合で、そのときはno_contentらしい。

Slide 19

Slide 19 text

Responder#display •  FormatはURIで指定された形式（index.jsonなど） •  Formatはini0alizeでcontrollerから読み込んでいる。

Slide 20

Slide 20 text

Respond_withでのオプション指定 •  respond_toと同様に特定のケースでは上書きできる。 –  これがさっき出てきた Responder#to_formatの default_render。

Slide 21

Slide 21 text

Responderの読み込み方 •  特定のコントローラでも。 •  conﬁg/applica0on.rbなどから。

Slide 22

Slide 22 text

Flash Responderを作るというか具体的なコードみないとよく分からん。

Slide 23

Slide 23 text

Flash Responderのゴール •  ScaﬀoldでcreateとupdateでFlashだすけど、処理は同じだからResponderにいれてしまえ。 – でも文言は完全に一緒じゃないのでI18nで参照できるようにしておく。 •  まずはおきまりのplugin作成。

Slide 24

Slide 24 text

とりあえずTDD 至って普通のscaﬀold向け。Destroyでもエラーを出すようにしてる。

Slide 25

Slide 25 text

Dummyアプリでのscaﬀold作成 •  普通のRailsアプリと同様に作ります。

Slide 26

Slide 26 text

Responderを使うように変更 •  当然scaﬀoldは responderを使うようになってないので respond_toを respond_withに変える。 •  Flashの記述をコントローラから消したので、テストはこける。

Slide 27

Slide 27 text

Flash Responderの実装開始 •  まずcreateから。 •  Createが成功したら – ﬂash.users.create.no0ceを表示。 •  Createが失敗したら – ﬂash.users.create.alertを表示。

Slide 28

Slide 28 text

こんな感じに実装 •  I18nのスコープ作るところだけがちょっとややこしい。

Slide 29

Slide 29 text

I18n_lookupを詳しく見るたとえば、createが成功してstatusがno0ceの場合、scopeも含めて探す翻訳のパスと、見つからなかったときのデフォルトパスは以下のようになる。欲しい物: ﬂash.users.create.no0ce デフォルト: ﬂash.ac0ons.create.no0ce なお、最後の引数のresource_nameは翻訳テキストのプレースホルダに対応する。

Slide 30

Slide 30 text

従ってこんな感じのyamlを作る

Slide 31

Slide 31 text

Responderをコントローラに •  ここではアプリ全体で標準のresponderにしている。 •  翻訳ファイルも同時にload_pathに読み込ませている。

Slide 32

Slide 32 text

テスト書く •  I18n.backend.store_transla0onsでデフォルトの翻訳文を上書きして、その上書きした文章が ﬂashに出るかどうかというテストをしている。

Slide 33

Slide 33 text

でもこける •  Destroy出来ないときのエラーなので。。。 •  Destroyしようとしたらエラーにするようにしないとだめ。 •  ここであえてdestroyでエラーが返る例にしているのは、HTTP verbsの説明でDELETEメソッドでもfailureになるケースがあることに触れていたためと思われる。

Slide 34

Slide 34 text

HTTP Cache Responderを作る

Slide 35

Slide 35 text

REST •  Railsは1.2の頃からRESTを利用している。 – API作るのに便利。 •  だけど、APIの実装と同時にパフォーマンスの最適化が必要になる。 •  ブラウザからリソースを生成した後、何回か読み取るケースがあるが、その都度同じレスポンスを返すのは非効率。 – これをブラウザ側のキャッシュで対応したい。

Slide 36

Slide 36 text

寄り道：RESTでのキャッシュ •  $がキャッシュ（cashとかけてる）。 •  Server+CacheとClient+Cacheの二種類が共存できる。 From: Architectural Styles and the Design of Network-‐based So$ware Architectures

Slide 37

Slide 37 text

ブラウザキャッシュ •  HTTP 1.1のLast-‐Modiﬁed/ If-‐Modiﬁed-‐since ヘッダを使ってリソースが更新されてなければペイロードを空にしてヘッダだけ返す。

Slide 38

Slide 38 text

実装方針 •  If-‐Modified-‐Sinceが含まれないリクエストの場合、通常のレスポンスにLast-‐Modifiedヘッダーを付与。 •  If-‐Modified-‐Sinceが含まれていてリソースが更新されていなければ、304コードを返してレスポンスのbodyは空。 •  If-‐Modified-‐Sinceが含まれていてリソースが更新されていれば、通常のレスポンスにLast-‐ Modifiedヘッダーを付与。

Slide 39

Slide 39 text

図にするとこんな感じ特にRailsではアセット系のファイルで効果大。更新頻度が低くて参照頻度の高いHTMLはサーバー側キャッシュとサーバー構成をうまくやることでRailsのプロセス自体へのアクセスを抑えることができるのもポイント。

Slide 40

Slide 40 text

この辺の話については •  「ハイパフォーマンスWebサイト」がおすすめです。 –  「サービス遅いからってサーバーサイドだけ速くすればいいってもんじゃねぇぞ」的な。 –  今となっては基本中の基本。

Slide 41

Slide 41 text

んでTDD •  さっきの実装方針をそのまんまテストに落としただけ。

Slide 42

Slide 42 text

Resopnders#HipCacheを作る •  RailsはHTTP cacheをうまく扱うヘルパーメソッドをすでに持っているので、それらを使う。

Slide 43

Slide 43 text

こんな感じ •  シンプルに渡されたリソースの最終更新時間をチェックしている。

Slide 44

Slide 44 text

細かく見ていく（to_format） •  to_formatのところでHTTP cacheのハンドリングをかぶせてる。

Slide 45

Slide 45 text

細かく見ていく（do_hip_cache?） •  Perform_cachingが有効で、かつGETの場合のみ対応。

Slide 46

Slide 46 text

細かく見ていく（do_hip_cache!） •  Request.fresh? はこんな感じ。

Slide 47

Slide 47 text

細かく見ていく（max_0mestamp） •  実際のサービスのindex ac0onあたりではこんなresourcesのupdated_at見るとかするよりSQL 叩いた結果とかを使いたい場合のほうが多いと思われる。

Slide 48

Slide 48 text

そして組み込む •  これでテストが通った。

Slide 49

Slide 49 text

Generatorのカスタマイズ

Slide 50

Slide 50 text

Scaffoldのテンプレート変えちゃえ •  Responderの仕様を前提にすれば、最初から flashやrespond_toのところをrespond_withだけに一本化できる。 •  だったら、scaffold生成時に出来るコントローラのテンプレートを変えてしまえばいい。

Slide 51

Slide 51 text

Scaffoldのカスタマイズ方法 •  ２種類ある。 – Scaffold generatorを作る。 – Scaffold用のテンプレートを変更する。 •  今回は後者でいく。 •  前者の方法はすでに4章で取り上げたためと思われる。

Slide 52

Slide 52 text

Scaﬀoldテンプレートの上書き •  Rails generatorにこんなコードがある。 – ってことはコピー元のファイルを変えればいい？ •  source_pathの存在 –  Generatorは複数のパスを見ることが出来る。 –  パスを追加してそちらを優先させればいい。 •  幸い、lib/templatesを優先してみるように作られている。

Slide 53

Slide 53 text

Rails::Generatorsを読む •  controller.rbというファイルがコントローラのテンプレートだと分かる。

Slide 54

Slide 54 text

カスタムテンプレートを生成するようにする

Slide 55

Slide 55 text

カスタムテンプレートを生成するようにする

Slide 56

Slide 56 text

テンプレートを詳しく •  ERBを使ってDSLっぽくなっている。 – orm_classが対象となるモデル名。 •  plural / singular はこの手の奴でよく出てくる。

Slide 57

Slide 57 text

テンプレートを詳しく •  set_リソース名で @user = User.ﬁnd的なものを定義。 •  64行目はStrongParameters用のメソッド。

Slide 58

Slide 58 text

Generatorのインストール •  これでカスタムtemplateがデフォルトになる。

Slide 59

Slide 59 text

GeneratorのORM Agnos0cism （ＯＲＭ不可知論） •  さっき出てきたorm_classの話。 – ORMがAc0veRecordからMongoidとかいろいろ変わったらどうする？ •  ORMが変わっても対応できるような機構が Railsに用意されている。

Slide 60

Slide 60 text

Ac0veModelの例 •  さっきの <%= orm_class.ﬁnd %> はこれを使っていた。

Slide 61

Slide 61 text

例：DataMaper •  ﬁndに相当するメソッドをgetに変えている •  これにより、datamapper gemをインストールした後、今回のpluginをインストールしても scaﬀold templateはそのままでいい。

Slide 62

Slide 62 text

まとめ •  Responderがどう動いているか、どうカスタマイズすればいいかを学んだ。 •  HTTP cacheとﬂash メッセージのハンドリングを responderで実装した。 •  今回実装したのはCondi0onal GET。 •  Condi0onal PUTというものもあるよ。 – リソース更新時に最終更新日が変わっていたら 409 Conﬂictを返す。