サブドメインを使用したマルチテナントRubyonRailsアプリの構築

config.action_dispatch.tld_length = 0

サブドメインをマルチテナンシーで機能させる

これで、任意の作成者を記事に割り当てることができます。サブドメインが使用されている場合は不可能です。 ArticlesControllerの動作を変更する必要があります 、およびすべての作成者を設定する代わりに、サブドメインが要求された作成者を設定する必要があります：

 
class ArticlesController < ApplicationController
 before_action :set_author
 before_action :set_article, only: [:show, :edit, :update, :destroy]
 
 # GET /articles
 # GET /articles.json
 def index
   @articles = Article.where(tenant_id: @author.id)
 end
 
 # ...
 
 private
   def set_article
     @article = Article.find_by!(id: params[:id], tenant_id: @author.id)
   end
 
   # ...
 
   def set_author
     @author = Author.find_by!(slug: request.subdomain)
   end
end

コントローラにいくつか変更を加えました：

• set_authorsの代わりに メソッド、 set_authorを定義しました サブドメインを介して要求された作成者を設定するメソッド。 before_filterでこのメソッドを呼び出すことが重要です set_articleの前 と呼ばれます。記事を設定する前に、著者を割り当てる必要があります。
• set_articleを更新しました 指定されたIDと割り当てられた作成者を持つ記事を検索するメソッド。現在のテナントがジョンである間は、トムが作成した記事をレンダリングしたくありません。
• 現在のテナントに割り当てられている記事のみを選択するようにインデックスアクションを更新しました。

マルチテナントアプリで作業し、1つのスキーマで1つのデータベースを使用する場合は、常に Tenant_idでクエリのスコープを設定することを忘れないでください。 桁;それ以外の場合は、要求されたテナントに割り当てられていないデータを提供します。

コントローラが更新されるので、次のステップはフォームビューを更新することです。 app / views / articles / _form.html.erbを開きます ファイルを作成し、前のセクションを単純な非表示フィールドに置き換えます：

<%= form.hidden_field :tenant_id, value: @author.id %>

これらの変更の前に、ユーザーはフォームを使用して記事の著者を選択することができました。ユーザーは、Webサイトアドレスの特定のサブドメインを使用して、すべてのアクションの作成者を選択できます。

これで、作成したコードをテストできます。たとえば、JohnDoeという名前で新しい作成者を作成します。johndoeをスラッグします。 。 https://johndoe.localhost:3000/articles/new addressにアクセスして、新しい記事を追加します。新しい記事を追加すると、http：//johndoe.localhost：3000/articlesの下にあるリストでその記事を表示できます。

おめでとう！各作成者がサブドメインを持つマルチテナントアプリを作成しました。

さらなる改善

新しい機能を追加して、アプリケーションのコードを拡張できるようになりました。私たちのブログプラットフォームは単純です。コメントセクションを追加する時が来たのでしょうか？追加する機能に関係なく、 Tenant_idを追加することを忘れないでください。 列を新しいモデルに変換し、リソースをクエリするときに使用します。

特別なスコープを作成して、懸念事項にラップすることができます：

module Tenantable
 extend ActiveSupport::Concern
 
 included do
   scope :for_author, -> (author) { where(tenant_id: author.id) }
 end
end

次に、テナントのデータを含むすべてのモデルで使用します。

class Article < ApplicationRecord
 include Tenantable
end
 
author = Author.find(1)
Article.for_author(author)

上記のアプローチでは、 Tenant_id の名前を変更する場合は、1か所だけ更新する必要があります。 テナント関連データのクエリに関しては、列またはより多くの条件を導入します。

複数のデータベースを備えたマルチテナントRailsアプリケーション

前の段落では、1つのデータベースと1つのスキーマで複数のテナントをサポートするRailsアプリケーションを構築しました。このようなアプローチの最も重大な欠点は、データ漏洩の可能性が高いことです。

幸いなことに、Ruby on Railsフレームワークの最新バージョンには、複数のデータベースを管理するためのサポートが組み込まれています。それを調べて、それを使用して、多数のデータベースとカスタムサブドメインを備えたマルチテナントRailsアプリケーションを構築する方法を示します。

計画は次のとおりです。

• 利用可能な最新バージョンのRubyおよびRubyonRailsフレームワークを使用して、Railsアプリケーションのスケルトンを作成します
• 操作できるデータを取得するために、いくつかのモデルの足場を作成します
• カスタムサブドメインのサポートを追加します。
• 新しいデータベースを作成して構成することにより、新しいテナントを追加する方法を学習します。
• 最後のステップは、指定されたサブドメインが要求されたときにデータベースを切り替えるようにアプリケーションを更新することです。

テストデータの準備

ユーザーが複数の著者によって公開された記事を表示できるブログプラットフォームを構築していると仮定しましょう。各著者には専用のデータベースがあります。

Authorの作成から始めます 新しい作成者を表示および作成するのに役立つスキャフォールド機能を備えたモデル：

rails g scaffold author slug:string name:string description:string
rake db:create
rake db:migrate

これで、http：// localhost：3000 / authorsにアクセスして、Railsが生成したものを確認できます。

新しい作成者の追加

JohnDoeという名前で新しい作者を作成しました。johndoeをスラッグします。 。スラッグ値は、サブドメインを使用して情報を表示する必要がある作成者を検出するために後で使用されます。

各作成者は個別のデータベースを持っているため、Johnの新しいデータベースを手動で追加する必要があります。 config / database.ymlを開きます 次の変更を追加します：

development:
 primary:
   <<: *default
   database: tenantapp_development
 primary_johndoe:
   <<: *default
   database: tenantapp_johndoe_development
   migrations_paths: db/tenants_migrations

テナントが使用する移行には、別のディレクトリを使用します。中央データベースには必要ありません。これで、デフォルトのコマンドを使用してJohnのデータベースを作成できます。

rake db:create

記事の追加

これで、 Articleの足場を作ることができます コントローラーとビューを含むモデル：

rails g scaffold article title:string content:text --database primary_johndoe

-databaseを渡しました 移行をデフォルトのdb/ migrationsに配置してはならないことをRailsに通知するパラメータ プライマリデータベースによって使用されるディレクトリ。これで、migrateコマンドを実行できます：

rake db:migrate

現在、2つのスキーマがあります： db / schema.rb およびdb/ primary_johndoe_schema.rb 。テナント用に異なるテーブルを作成する場合は、一意の migrations_pathを設定することでこれを実現できます。 config / database.ymlの値 指定されたテナントのファイル。この記事では、すべてのテナントで同じテーブルを使用するため、移行へのパスは同じになります。

マルチテナンシーサポートの追加

1つのデータベースでマルチテナンシーがサポートされているアプリケーションでは、特定のテナントのデータを取得するには、適切な Tenant_idを使用してデータベースへのクエリを更新する必要があります。 価値。この場合、各テナントにはデータベースがあるため、データベースを切り替える必要があります。

Rails 6.1には、水平シャーディングのサポートが組み込まれています。シャードは、データセット全体のサブセットを含む水平方向のデータパーティションです。すべての著者の記事を1つのデータベースの1つのテーブルに保存できますが、シャーディングのおかげで、データを同じ構造で別々のデータベースに配置された複数のテーブルに分割できます。

すべてのモデルの親クラスでシャードを定義しましょう。これらはapp/ models / application_record.rbに保存されます ：

ActiveRecord::Base.connected_to(role: :reading, shard: :johndoe) do
  Article.all # get all articles created by John
end

呼び出しをconnected_toにラップせずに ブロックの場合、デフォルトのシャードが使用されます。先に進む前に、もう1つの変更を導入する必要があります。すべてのシャードが同じデータ構造を共有しているため、 app / models / primary_johndoe_record.rbを削除できます。 記事の足場を作ったときに自動的に作成されたモデル。

app / models / article.rbも編集する必要があります 親クラスをモデル化し、 PrimaryJohndoeRecordから変更します ApplicationRecordへ ：

class Article < ApplicationRecord
end

テナントの追加

現在、データベースには1人の著者しかいません。テナント（データベース）間の切り替え機能をテストするには、作成者をもう1人追加する必要があります。 http：// localhost：3000 / authors / new addressを開き、新しい作成者を追加します。著者をTimDoeという名前で追加し、 timdoeをスラッグしました。 。

新しい作成者のレコードがあるため、新しいデータベースを定義する必要があります：

development:
 primary:
   <<: *default
   database: tenantapp_development
 primary_johndoe:
   <<: *default
   database: tenantapp_johndoe_development
   migrations_paths: db/tenants_migrations
 primary_timdoe:
   <<: *default
   database: tenantapp_timdoe_development
   migrations_paths: db/tenants_migrations

次に、新しいデータベースを作成して移行を実行します。

rake db:create
rake db:migrate

最後のステップは、 ApplicationRecordを更新することです 新しいシャードをモデル化して定義します：

class ApplicationRecord < ActiveRecord::Base
 self.abstract_class = true
 
 connects_to shards: {
   default: { writing: :primary, reading: :primary },
   johndoe: { writing: :primary_johndoe, reading: :primary_johndoe },
   timdoe: { writing: :primary_timdoe, reading: :primary_timdoe },
 }
end

著者ごとに記事を作成できるようになりました：

ActiveRecord::Base.connected_to(role: :writing, shard: :johndoe) do
  Article.create!(title: 'Article from John', content: 'content')
end
 
ActiveRecord::Base.connected_to(role: :writing, shard: :timdoe) do
  Article.create!(title: 'Article from Tim', content: 'content')
end

カスタムサブドメインのサポートの追加

ジョンとティムの記事をいつ表示するかわからないため、特定の著者の記事リストにアクセスすることはできません。カスタムサブドメインを実装することで、この問題を解決します。 http：//johndoe.localhost：3000 / articlesにアクセスすると、Johnの記事が表示され、http：//timedoe.localhost：3000 / articlesにアクセスすると、Timの記事が表示されます。

サブドメインの構成

入居時に記事を管理・訪問したいと思います。これは、 config / routers.rbを更新することで実現できます。 ファイルを作成し、記事リソースの定義を制約ブロックにラップします：

Rails.application.routes.draw do
 constraints subdomain: /.*/ do
   resources :articles
 end
 
 resources :authors
end

デフォルトでは、Railsはトップレベルドメインの長さを1に設定しますが、localhostを使用してこの設定を0に設定します。これを行うには、ファイル config / environment /development.rb<に次の行を追加します。 / code> ：

config.action_dispatch.tld_length = 0

module Tenantable
 extend ActiveSupport::Concern
 
 private
 
 def read_with_tenant(&block)
   author = Author.find_by!(slug: request.subdomain)
 
   ActiveRecord::Base.connected_to(role: :reading, shard: author.slug.to_sym) do
     block.call
   end
 end
end

class ArticlesController < ApplicationController
 include Tenantable
 
 before_action :set_article, only: [:show, :edit, :update, :destroy]
 
 def index
   read_with_tenant do
     @articles = Article.all
   end
 end
 # ...
end

ActiveRecord::Base.establish_connection(:primary_timdoe)