Share
Embed
Ruby on Railsの正体と向き合い方 / What is Ruby on Rails and how to deal with it?
Rails Developers Meetup 2019(2019/03/22 - 23)
Yuichi Goto
March 23, 2019
Transcript
68 slides
-
Ruby on Railsの正体と向き合い方 Yuichi Goto (@_yasaichi) March 23, 2019 @
Rails Developers Meetup 2019 -
Agenda !4 1. 背景と目的 2. 第一部: Ruby on Railsの正体 3.
第二部: Ruby on Railsとの向き合い方 4. まとめ -
Rails Developers Meetup(Railsdm)と私 2017/05 ⚫ Railsdm #1開催 2017/12 ⚫ Railsdm
2017開催、LT枠で初登壇 2018 Railsdm 2018 Day 1~4開催 一参加者として楽しむ 2019/03 ⚫ Railsdm 2019開催、2回目の登壇 !5 -
過去発表の振り返りと所感 • 前提: Railsは小〜中規模の開発に向いているが、どこかで限界が来る • 焦点: この限界に対して、コード・アーキテクチャレベルでどう対処するか • 所感: •
具体的な対処法(=向き合い方)に関しては多くの議論がされてきた • 「いつ、なぜ限界を迎えるのか?」という前提に関する議論はまだ少ない !7 -
Agenda !9 1. 背景と目的 2. 第一部: Ruby on Railsの正体 3.
第二部: Ruby on Railsとの向き合い方 4. まとめ -
Basecampとは • アメリカのシカゴに本社を置くBasecamp社(旧名37signals、DHHは 同社のCTO)の提供するプロジェクト管理ツール [1] • 2003年、当時本業だったWebデザインのコンサルティング業務で起きて いたコミュニケーションの問題を解決するために開発した [2] •
当初は社内と既存顧客の間で利用していたが、「(顧客の)社内でも使い たい」という声を受け、2004年にサービスとして提供を始めた [2] !12 -
DHHの関わり “Basecamp(注1)という新しいプロダクトの開発のとき,⾃分が開発 環境を決められるようになり,それなら⼀番美しいソースコードを書け る⾔語にしようということでRubyにしたんです。” 出典: 小飼弾のアルファギークに逢いたい♥ #2 (2006) “I did
all the original programming for Base Camp” 出典: Millionaire Story: David Heinemeier Hansson (2011) !13 ※ 太字強調は引用者によるもの -
Railsとの関係 “「Basecamp」と呼ぶ,Webベースのプロジェクト管理ツールを開発 しました。Ruby on Railsはそのために開発したフレームワークで,最 初は公開するつもりはなく,内部だけで使⽤していました。” 出典: 「美しいコードを書けるからRubyを選んだ」 ---Ruby on
Rails作者David Heinemeier Hansson氏 (2006) “Railsを作ったのは、⾃分の仕事をより良く、より速くするためです。” 出典: Ruby on Rails: DHHのインタビュー (2005) !14 ※ 太字強調は引用者によるもの -
DHHがRailsを作るまで 1. Railsを作る前は、DHHは主にPHPとJavaを書いていた [3] 2. Railsも最初PHPを使って作っていた(!)が、不満を感じていた [4] 3. Martin FowlerやDave
Thomasの書いた記事に影響されて、試しに Rubyを使ってみることを決める [5] 4. 1週間ほどですっかりRubyにハマり、後のRailsを作り始める [5] !17 -
DHHがRailsで目指したもの “I was mostly doing PHP on my own, and
I worked at a Java shop for a period of time. It was J EE to some extent and otherwise Java in general. Those were the two forming influences. With Ruby On Rails, I tried to form the best of both worlds to make it as quick as PHP and as solid and clean as something like Java.” 出典: Rails creator on Java and other 'junk' (2007) !19 ※ 太字強調は引用者によるもの -
Railsがある程度妥協しているもの 1. 柔軟さ • 例: CoC(Convention Over Configuration、「設定より規約」) • 柔軟さと引き換えに考える・書く量を減らしたことは、何度も話されてきた
2. 疎結合(↔密結合)であること • 「Railsは密結合な設計だ」と言われても、ピンと来ない方もいるのでは !22 ずっとRailsだけで仕事してきた方とか -
密結合度合いを比較で理解する • 何らかの機能をRailsとHanamiでそれぞれ実装し、比較してみる • なぜHanami? • Hanamiはクリーンアーキテクチャをほぼそのまま実装している [6] • クリーンアーキテクチャは疎結合な設計の代表例のひとつである
• どちらもRuby向けのWebフレームワークのため、設計の差が際立つ !23 -
お題: 簡易ユーザー登録機能 正常系のフローは次の通り: 1. ユーザーはメールアドレスを入力して送信ボタンを押す 2. 送信されたメールアドレスの形式が正しいことを確認する 3. アドレス存在確認用のトークンを作り、ユーザーにメールを送信する 4.
ユーザーをメールアドレス登録完了ページへリダイレクトする !29 https://github.com/yasaichi-sandbox/user_registration -
!30 Railsでの実装例: Controller class UserRegistrationsController < ApplicationController def create @user_registration
= UserRegistration.new(user_registration_params) if @user_registration.save redirect_to complete_user_registrations_url else render :new end end private def user_registration_params params.require(:user_registration).permit(:email) end end -
!31 Railsでの実装例: Model class UserRegistration < ApplicationRecord validates :email, format:
{ with: URI::MailTo::EMAIL_REGEXP } before_create :set_confirmation_token after_create :send_confirmation_instructions private def set_confirmation_token self.confirmation_token = SecureRandom.uuid end def send_confirmation_instructions UserRegistrationMailer.with(user_registration: self) .confirmation_instructions.deliver_now end end このへんは説明のためのコードなので、真似しないように -
!32 Hanamiでの実装例: Controller module Web::Controllers::UserRegistrations class Create include Web::Action expose
:error_messages def initialize(interactor: StartUserRegistration.new( mailer: Mailers::UserRegistrationConfirmation, repository: UserRegistrationRepository.new, token_generator: Utils::UrlSafeTokenGenerator )) @interactor = interactor end def call(params) result = @interactor.call(params[:user_registration]) if result.successful? redirect_to routes.complete_user_registrations_url else @error_messages = result.errors self.status = 422 end end end end メソッド呼び出しの対象がModelからInteractorへ -
!33 Hanamiでの実装例: Interactor (入力値チェック) class StartUserRegistration include Hanami::Interactor class Validator
include Hanami::Validations validations do required(:email).filled(:str?, format?: URI::MailTo::EMAIL_REGEXP) end end private def valid?(params) Validator.new(params).validate.yield_self do |result| result.messages.each_key { |key| error("#{key.capitalize} is invalid") } result.success? end end end #valid?がtrueを返すと#call(後述)が実行される -
!34 Hanamiでの実装例: Interactor (処理本体) class StartUserRegistration include Hanami::Interactor def initialize(mailer:,
repository:, token_generator:) @mailer = mailer @repository = repository @token_generator = token_generator end def call(params) @repository.transaction do user_registration = @repository.create( email: params[:email], confirmation_token: @token_generator.call ) @mailer.deliver(user_registration: user_registration) end end end #before_create → #save → #after_createに相当 -
Rails Model ≒ Hanami Interactor • お題のようなレコード作成+α時には、ModelはInteractorに相当する • Interactorの役割は、各ユースケースの処理の流れを組み立てること !35
RailsのModelは特定のユースケースと密結合している -
Interactor化を支える3つの技術 • Active Record(AR)パターンの適用: Modelとテーブルを1:1対応させ、 ビジネスロジックの記述も許すことで、EntityとRepositoryの役割を実現 • AR Validationsの発明: Modelの各属性が満たすべき条件を書く形で、
Interactorでの入力値チェック相当の処理を実現 • AR Callbacksの発明: ModelのCRUD操作に対するフックの形で、 Interactorでのユースケースの処理組み立て相当の処理を実現 !36 C(R)UD操作とコールバックが自動で同一トランザクションになるのがキモ -
Clean ArchitectureとRails Modelの対応 !37 Clean Architecture Ruby on Rails ビジネスロジックの記述
Entity Model ユースケースの組み立て Interactor Model (AR Callbacks) 入力値のバリデーション Interactor Model (AR Validations) DBアクセス・データ変換 Repository Model (AR Query Interface) -
Ruby on Railsの正体 • 次の2つの方法を組み合わせて、ModelのCRUD操作を中心にコードを 整理して考える・書く量を減らすことで、「早くてキレイ」を実現した • RESTfulルーティングとActiveRecordパターンによって、URLで表される リソースからDB上のテーブルまでが密結合する構造を作った •
ActiveRecordパターンとそのValidations/Callbacksによって、ビジネス ロジックとその組み立て処理を全てModelに書けるようにした !40 -
師曰く: Ruby on Railsの功績 “少なくともスタートアップ企業にとってスピードは本当にクリティカル な⼒なので、もし密結合の状態でも速く⾛れるソフトウェアの構造があ るのであれば、それはゆっくり安定して継続的に歩いていく疎結合のソ フトウェア設計より強いということをRailsはある程度証明していたわ けですね。そしていま、その構造のまま⼤きくなるとすごく⼤変になる ということも証明している。”
出典: マニアが潰したテスト駆動開発〜 『健全なビジネスの継続的成長のためには健全なコードが必要だ』対談 (5) (2018) !42 ※ 太字強調は原文のもの -
Railsはいつ、なぜ限界を迎えるのか? • いつ: あるModelが複数の異なるユースケースでC(R)UD操作される ようになったとき • なぜ: あるModelに書かれたValidations/Callbacksは特定のユース ケースと密結合しているため •
何が辛いのか: あるユースケースに特化したModelの中で、別のユース ケースの事情を考慮したコードを書かなければいけないこと !43 -
限界の表出の仕方 1. 特定の条件でValidations/Callbacksを実行する or スキップする • 例: `if: :condition?`, `on:
:context`, `save(validate: false)` • Modelに複数のユースケースの事情が詰め込まれていることを示す 2. Controller内に`ApplicationRecord.transaction`を書く • ModelのCRUD操作を中心に処理が組み立てられなくなったことを示す !45 -
Agenda !49 1. 背景と目的 2. 第一部: Ruby on Railsの正体 3.
第二部: Ruby on Railsとの向き合い方 4. まとめ -
過去に提案されたコードレベルでの向き合い方 • ActiveRecordの分割(by @hanachin) [10] 責務に応じてDB上の同一テーブルを参照する複数のModelを作る • Application Modelの導入(by @_h_s_)
[9] DB上のテーブルに紐付かないController専用のModelを作る • Form/Service(その他様々なPORO)の導入 [11][12][13] Controllerからの単一メソッド呼び出しで処理一式を実行する層を作る !51 -
画像出典: ApplicationModel のある風景 (2018) [9] !52 共通点: Controller or Actionと1:1対応する新しい層を導入する
この層(Interactor相当)の作り方が違うだけ -
アーキテクチャレベルでの向き合い方 • 基本方針: Railsの限界をコードレベルで解決しようとしない • オプション1: アプリケーションが対象とするドメインを小さくする • オプション2: 限界を迎える前に複数のサブシステムへ分割する
• 組織構造とアーキテクチャは不可分なので、実行の際にはこれら両方の 考慮が必要になることが多く、難易度は高い !54 -
PIXTAサービスの現状と取り組み • 2011年6月にPerlからリプレイスして現在8年目(事業自体は13年目) • これまで説明した限界に直面しているため、次の2つの対応を行っている • 「本体」と呼ばれるリポジトリをこれ以上肥大化させないため、独立性の 高い新機能は最初からサブシステムとして実装する • 「本体」からSoE(System
of Engagement)を抽出して、巨大なSoR (System of Record)を任意の単位で分割できるようにする !55 -
事例1: 素材タイトルの多言語翻訳機能 • 翻訳タイトルを素材のタグから自動生成していたのをやめるために開発 • ドメインが小さく独立性が高いため、最初からサブシステムとして実装 • I/O boundなアプリケーションだったこともあり、Node.jsを使って作った !56
アプリケーションが対象とするドメインを小さくすると、Railsを選ぶ 理由も少なくなるというジレンマがある -
事例2: SoEの抽出(実施中) • 解決したいこと: 「本体」を複数のチームで開発しているため、組織が持つ 本来の開発速度を発揮できていない • アプローチ: 「本体」を組織構造と一致するようにサブシステムに分割する •
問題点: Railsではフロントエンドとバックエンドもまた密結合しているため、 このままの状態だとページ単位で分割せざるを得ない !57 PIXTAではこの単位が組織の形とマッチしなかった(経験済み) -
解決策: 先にSoEを抽出してから縦方向に分割する !58 最初からSoE/SoRの構成なら縦方向の分割をすぐ始められるので、 次の新規サービス開発(未定)ではBFF + Rails APIでやりたい Rails Monolith
SoR (Rails API) SoE (Frontend + BFF) SoE (Frontend + BFF) … Micro Frontends? 任意の単位で分割可 -
もうひとつの未来への道 • とはいえ、成長中のプロダクトをひとつだけ持つ一般的なスタートアップで Railsの限界が見え始めたらすぐに分割を実施することは難しそう • 小規模での早さはそのままに、中規模を超えてもある程度走り続けられる フレームワークをRailsの上に作るのが現実的では? • Railsを構成する要素で作られている •
疎結合な設計に段階的に移行できる仕組みを持つ !59 Laravelのサービスコンテナが参考になりそう -
Agenda !60 1. 背景と目的 2. 第一部: Ruby on Railsの正体 3.
第二部: Ruby on Railsとの向き合い方 4. まとめ -
まとめ: Ruby on Railsの正体 • DHHが解決したかったこと: 少人数のスタートアップでのプロダクト開発で 「早くてキレイ」を実現する • Railsのアプローチ:
次の2つの方法により、ModelのCRUD操作を中心に コードを整理して考える・書く量を減らす • URLで表されるリソースからDB上のテーブルまでを密結合させる • ビジネスロジックとその組み立て処理を全てModelに書けるようにする !61 -
まとめ: Ruby on Railsの限界との向き合い方 • Railsの限界: あるModelが複数の異なるユースケースでC(R)UD操作 されるようになると、各々の事情がそのModelに集中して辛くなる • 限界との向き合い方:
• コードレベル: ユースケース固有の処理を書くための層を導入する • アーキテクチャレベル: 対象のドメインを小さくするか途中で分割する !62 -
参考文献 1. Basecamp, LLC "Basecamp: About our company", URL: https://basecamp.com/about
2. Basecamp, LLC "A letter from the CEO", URL: https://basecamp.com/about/story 3. IDG Communications, Inc. "Rails creator on Java and other 'junk'", URL: https:// www.infoworld.com/article/2649156/rails-creator-on-java-and-other--junk-.html 4. 角征典 "Ruby on Rails: DHHのインタビュー", URL: https://kdmsnr.com/translations/ interview-with-dhh/ 5. "David Heinemeier Hansson interviewed by Randal Schwartz", URL: http:// www.transcribed-interview.com/dhh-rails-david-heinemeier-hansson-interview- randal-schwartz-floss.html !63 -
参考文献 6. "Architecture: Overview", URL: https://guides.hanamirb.org/architecture/overview/ 7. Robert C. Martin
"The Clean Architecture", URL: https://blog.cleancoder.com/uncle- bob/2012/08/13/the-clean-architecture.html 8. "Rails 1.2: REST admiration, HTTP lovefest, and UTF-8 celebrations", URL: https:// weblog.rubyonrails.org/2007/1/19/rails-1-2-rest-admiration-http-lovefest-and-utf-8- celebrations/ 9. Hiroyasu Shimoyama "ApplicationModel のある風景", URL: https://speakerdeck.com/ hshimoyama/rails-with-applicationmodel !64 -
参考文献 10. Seiei Miyagi "ActiveRecordのモデルが1つだとつらい", URL: https://qiita.com/ hanachin_/items/ba1dd93905567d88145c 11. Bryan
Helmkamp "7 Patterns to Refactor Fat ActiveRecord Models", URL: https:// codeclimate.com/blog/7-ways-to-decompose-fat-activerecord-models/ 12. 諸橋恭介 "フォームオブジェクトとの向き合い方", URL: https://speakerdeck.com/moro/ grow-form-objects-up 13. Shinichi Maeshima "レールの伸ばし方", URL: https://speakerdeck.com/willnet/ rerufalseshen-basifang !65 -
6ページ掲載の各資料について • [上段左] 参考文献13と同じ • [上段中央] "「Railsでまだ消耗しているの?」─僕らがRailsで戦い続ける理由─", URL: https:// speakerdeck.com/toshimaru/why-we-use-ruby-on-rails
• [上段右] 森久太郎 "Microservices Maturity Model on Rails", URL: https://speakerdeck.com/ qsona/microservices-maturity-model-on-rails • [下段左] Tomohiro Hashidate "Realworld Domain Model on Rails", URL: https:// speakerdeck.com/joker1007/realworld-domain-model-on-rails • [下段中央] 参考文献12と同じ • [下段右] 参考文献9と同じ !68