Rails ガイド

目次

1. はじめに
2. 用語について
   • コネクション
   • コンシューマー
   • チャネル
   • サブスクライバ
   • Pub/Sub
   • ブロードキャスト
3. サーバー側のコンポーネント
   • コネクション
   • チャネル
4. クライアント側のコンポーネント
   • コネクション
5. クライアント-サーバー間のやりとり
   • ストリーム
   • ブロードキャスト
   • サブスクリプション
   • チャネルにパラメータを渡す
   • メッセージを再ブロードキャストする
6. フルスタックの例
   • 例1: ユーザーアピアランスの表示
   • 例2: 新しいWeb通知を受信する
   • より詳しい例
7. 設定
   • サブスクリプションアダプタ
   • 許可されたリクエスト送信元
   • コンシューマーの設定
   • ワーカープールの設定
   • クライアント側のログ出力
   • その他の設定
8. Action Cable専用サーバーを実行する
   • アプリケーションで実行
   • スタンドアロン
   • メモ
9. 依存関係
10. デプロイ
11. テスト

1 はじめに

Action Cableは、WebSocketとRailsのその他の部分をシームレスに統合します。Action Cableを導入すると、Rails アプリケーションのパフォーマンスとスケーラビリティを損なわずに、通常のRailsアプリケーションと同じスタイル・方法でリアルタイム機能をRubyで記述できるようになります。Action Cableはフルスタックのフレームワークであり、クライアント側のJavaScriptフレームワークとサーバー側のRubyフレームワークの両方を提供します。Active RecordなどのORMで書かれたドメインモデル全体にアクセスできます。

2 用語について

Action Cableは、通常のHTTPリクエスト・レスポンスプロトコルの代わりにWebSocketを利用します。Action CableとWebSocketでは、以下のような新しい用語がいくつか導入されます。

2.1 コネクション

コネクション（connection）は、クライアント・サーバーの関係の基礎をなすものです。 1個のAction Cableサーバーは、コネクションインスタンスを複数扱うことが可能で、WebSocketのコネクションごとに1つのコネクションインスタンスを持ちます。あるユーザーがブラウザタブを複数開いたり複数のデバイスを用いている場合は、アプリケーションに対して複数のWebSocketコネクションをオープンします。

2.2 コンシューマー

WebSocketコネクションのクライアントは、コンシューマー（consumer）と呼ばれます。 Action Cableのコンシューマーは、クライアント側のJavaScriptフレームワークによって作成されます。

2.3 チャネル

コンシューマごとに、複数のチャネル（channel）をサブスクライブできます。 各チャネルは論理的な機能単位をカプセル化しており、チャネル内ではコントローラが典型的なMVCセットアップで行っていることと同様のことを行います。たとえばChatChannelとAppearancesChannelが1つずつあると、あるコンシューマーはそれらチャネルの一方または両方でサブスクライブされることが可能です。1つのコンシューマーは、少なくとも1つのチャネルにサブスクライブされるべきです。

2.4 サブスクライバ

コンシューマーがチャネルでサブスクライブされると、サブスクライバ（subscriber）として振る舞います。サブスクライバとチャネルの間のコネクションは、（驚くことに）サブスクリプションと呼ばれます。あるコンシューマーは、何度でも指定のチャネルのサブスクライバとして振る舞えます。たとえば、あるコンシューマーが複数のチャットルームに同時にサブスクライブことも可能です（物理的なユーザーが複数のコンシューマーを持つことが可能で、コネクションはブラウザタブやデバイスごとにオープン可能であることを思い出しましょう）。

2.5 Pub/Sub

Pub/Sub（Publish-Subscribe）はメッセージキューのパラダイムの一種であり、情報の送信者（パブリッシャ）は個別の受信者を指定する代わりに、受信側の抽象クラスにデータを送信します。Action Cableでは、このPub/Subアプローチを用いてサーバーと多数のクライアントの間の通信を行います。

2.6 ブロードキャスト

ブロードキャスト（broadcasting）とは、あるブロードキャスター（broadcaster）によって転送されるあらゆる情報をチャネルのサブスクライバ（サブスクライバはその名前を持つブロードキャストをストリーミングします）に直接送信するpub/subリンクを指します。 各チャネルは、0個以上のブロードキャストをストリーミングできます。

3 サーバー側のコンポーネント

3.1 コネクション

サーバーがWebSocketを1個受信するたびに、コネクションオブジェクトのインスタンスが生成されます。 このオブジェクトは、以後作成されるすべてのチャネルサブスクリプションの親オブジェクトとなり、 認証（authentication）と認可（authorization）以後は、コネクション自身がアプリケーションロジックを扱うことはありません。WebSocketコネクションのクライアントは、コネクションのコンシューマーと呼ばれます。 ある個人ユーザーが「ブラウザタブ」「ウィンドウ」「デバイス」を開いて接続するたびに、コンシューマコネクションが1個ずつ作成されます。

コネクションはApplicationCable::Connectionのインスタンスで、ActionCable::Connection::Baseを継承しています。 ApplicationCable::Connectionでは、ユーザーを識別できる場合に、コネクションを認証したのち接続の確立を続行します。

3.1.1 コネクションの設定

# app/channels/application_cable/connection.rb
module ApplicationCable
  class Connection < ActionCable::Connection::Base
    identified_by :current_user

    def connect
      self.current_user = find_verified_user
    end

    private
      def find_verified_user
        if verified_user = User.find_by(id: cookies.encrypted[:user_id])
          verified_user
        else
          reject_unauthorized_connection
        end
      end
  end
end

上のidentified_byはコネクションidであり、後で特定のコネクションを見つけるときに利用できます。idとしてマークされたものは、そのコネクション以外で作成されるすべてのチャネルインスタンスに、同じ名前で自動的にデリゲート（delegate）を作成します。

この例は、アプリケーションの他の場所で既にユーザー認証が扱われており、認証が成功してユーザーIDに暗号化済みcookieが設定されていることを前提としています。

次に、新しいコネクションを試行すると、このcookieがコネクションのインスタンスに自動で送信され、current_userの設定に使われます。現在の同じユーザーによるコネクションが識別されれば、以後そのユーザーが開いているすべてのコネクションを取得することも、ユーザーが削除されたり認証できない場合に切断することも可能になります。

認証にセッションを含む場合、セッションにcookieストアを使用し、セッションcookieの_sessionとユーザーIDのキーとなるuser_idを使用するアプローチが使えます。

verified_user = User.find_by(id: cookies.encrypted['_session']['user_id'])

3.1.2 例外ハンドリング

デフォルトでは、補足されていない例外は補足されてRailsのログに出力されます。これらの例外をグローバルにインターセプトして外部のバグトラッキングサービスに通知したい場合は、たとえば以下のようにrescue_fromを使う方法があります。

# app/channels/application_cable/connection.rb
module ApplicationCable
  class Connection < ActionCable::Connection::Base
    rescue_from StandardError, with: :report_error

    private
      def report_error(e)
        SomeExternalBugtrackingService.notify(e)
      end
  end
end

3.2 チャネル

チャネル（Channel） は論理的な作業単位をカプセル化するものであり、典型的なMVCセットアップでコントローラが果たす役割と似ています。Railsはデフォルトで、チャネル間で共有されるロジックをカプセル化する以下のApplicationCable::Channelという親クラス（これはActionCable::Channel::Baseを継承します）を作成します。

3.2.1 親チャネルの設定

# app/channels/application_cable/channel.rb
module ApplicationCable
  class Channel < ActionCable::Channel::Base
  end
end

次に専用のチャネルクラスを作成します。たとえば以下のような ChatChannelクラスやAppearanceChannelクラスを作成できます。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
end

# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
end

これで、コンシューマーがチャネルをサブスクライブできるようになります。

3.2.2 サブスクリプション

コンシューマーはチャネルをサブスクライブして、サブスクライバ（Subscriber）の役割を果たします。それらのコンシューマーのコネクションはサブスクリプション（Subscription: 購読）と呼ばれます。生成されたメッセージは、Action Cableコンシューマーが送信するidに基いて、これらのチャネルサブスクライバ側にルーティングされます。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
  # コンシューマーがこのチャネルのサブスクライバになると
  # このコードが呼び出される
  def subscribed
  end
end

3.2.3 例外ハンドリング

ApplicationCable::Connectionの場合と同様、rescue_fromを利用すると特定チャネルで発生する例外を扱えるようになります。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
  rescue_from 'MyError', with: :deliver_error_message

  private
    def deliver_error_message(e)
      broadcast_to(...)
    end
end

4 クライアント側のコンポーネント

4.1 コネクション

コンシューマー側でも、コネクションのインスタンスが必要になります。このコネクションは、Railsがデフォルトで生成する以下のJavaScriptコードによって確立します。

4.1.1 コンシューマーに接続する

// app/javascript/channels/consumer.js
// Action CableはRailsでWebSocketを扱うフレームワークを提供する
// WebSocketがある場所で`bin/rails generate channel`コマンドを使うと新しいチャネルを生成できる

import { createConsumer } from "@rails/actioncable"

export default createConsumer()

これにより、サーバーの/cableにデフォルトで接続するコンシューマーが利用可能になります。コネクションは、利用するサブスクリプションを1つ以上指定するまで確立しません。

このコンシューマーは、オプションとして接続先URLを指定する引数を1つ受け取れます。引数には文字列を渡すことも、WebSocketがオープンされるときに呼び出されて文字列を返す関数も渡すことも可能です。

// 異なる接続先URLを指定する
createConsumer('wss://example.com/cable')
// または、websockets over HTTPを使う場合
createConsumer('https://ws.example.com/cable')

// 動的にURLを生成する関数
createConsumer(getWebSocketURL)

function getWebSocketURL() {
  const token = localStorage.get('auth-token')
  return `wss://example.com/cable?token=${token}`
}

4.1.2 サブスクライバ

指定のチャネルでサブスクリプションを作成すると、コンシューマーがサブスクライバになります。

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" })

// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "AppearanceChannel" })

サブスクリプションは上のコードで作成されます。受信したデータに応答する機能については後述します。

コンシューマーは、指定のチャネルに対するサブスクライバとして振る舞えます（回数の制限はありません）。たとえば、コンシューマーでは以下のようにチャットルームを同時にいくつでもサブスクライブできます。

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "1st Room" })
consumer.subscriptions.create({ channel: "ChatChannel", room: "2nd Room" })

5 クライアント-サーバー間のやりとり

5.1 ストリーム

ストリーム（stream）は、パブリッシュされたコンテンツ（ブロードキャスト）をサブスクライバに配信するメカニズムです。 たとえば以下のコードは、roomパラメータの値が"Best Room"の場合に、stream_fromを用いてchat_Best Roomという名前のブロードキャストをサブスクライブしています。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
  def subscribed
    stream_from "chat_#{params[:room]}"
  end
end

これで、Railsアプリケーションのどのコードでも、以下のようにbroadcastを呼び出せばチャットルームにブロードキャストできるようになります。

ActionCable.server.broadcast("chat_Best Room", { body: "このチャットルーム名はBest Roomです" })

あるモデルに関連するストリームを作成すると、そのモデルとチャネルからブロードキャストが生成されます。以下の例は、comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzEのような形式のブロードキャストをstream_forでサブスクライブします（Z2lkOi8vVGVzdEFwcC9Qb3N0LzEはPostモデルのGlobalID）。

class CommentsChannel < ApplicationCable::Channel
  def subscribed
    post = Post.find(params[:id])
    stream_for post
  end
end

これで、以下のようにbroadcast_toを呼び出せばこのチャネルにブロードキャストできるようになります。

CommentsChannel.broadcast_to(@post, @comment)

5.2 ブロードキャスト

ブロードキャスト（broadcasting）は、pub/subのリンクです。パブリッシャからの送信内容がすべてブロードキャストを経由し、その名前のブロードキャストをストリーミングするチャネルサブスクライバに直接ルーティングされます。各チャネルは、0個以上のブロードキャストをストリーミングできます。

ブロードキャストは純粋なオンラインキューであり、時間に依存します。ストリーミング（指定のチャネルにサブスクライブされること）を行っていないコンシューマーは、後で接続してもブロードキャストを取得できません。

5.3 サブスクリプション

あるチャネルでサブスクライブされたコンシューマーは、サブスクライバとして振る舞います。このコネクションもサブスクリプションと呼ばれます。受信メッセージは、Action Cableコンシューマーが送信するidに基いて、これらのチャネルサブスクライバにルーティングされます。

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
  received(data) {
    this.appendLine(data)
  },

  appendLine(data) {
    const html = this.createLine(data)
    const element = document.querySelector("[data-chat-room='Best Room']")
    element.insertAdjacentHTML("beforeend", html)
  },

  createLine(data) {
    return `
      <article class="chat-line">
        <span class="speaker">${data["sent_by"]}</span>
        <span class="body">${data["body"]}</span>
      </article>
    `
  }
})

5.4 チャネルにパラメータを渡す

サブスクリプション作成時に、以下のようにクライアント側のパラメータをサーバー側に渡せます。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
  def subscribed
    stream_from "chat_#{params[:room]}"
  end
end

subscriptions.createに第1引数として渡されるオブジェクトは、そのAction Cableチャネルのparamsハッシュになります。キーワードchannelは必須です。

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
  received(data) {
    this.appendLine(data)
  },

  appendLine(data) {
    const html = this.createLine(data)
    const element = document.querySelector("[data-chat-room='Best Room']")
    element.insertAdjacentHTML("beforeend", html)
  },

  createLine(data) {
    return `
      <article class="chat-line">
        <span class="speaker">${data["sent_by"]}</span>
        <span class="body">${data["body"]}</span>
      </article>
    `
  }
})

# このコードはアプリケーションのどこか（NewCommentJobあたり）で呼び出される
ActionCable.server.broadcast(
  "chat_#{room}",
  {
    sent_by: 'Paul',
    body: 'This is a cool chat app.'
  }
)

5.5 メッセージを再ブロードキャストする

あるクライアントから、接続している別のクライアントに、メッセージを再ブロードキャストすることはよくあります。

# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
  def subscribed
    stream_from "chat_#{params[:room]}"
  end

  def receive(data)
    ActionCable.server.broadcast("chat_#{params[:room]}", data)
  end
end

// app/javascript/channels/chat_channel.js
import consumer from "./consumer"

const chatChannel = consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
  received(data) {
    // data => { sent_by: "Paul", body: "This is a cool chat app." }
  }
}

chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })

再ブロードキャストは、送信元クライアント自身も含め、接続しているすべてのクライアントで受信されます。paramsは、チャネルをサブスクライブするときと同じである点にご注意ください。

6 フルスタックの例

以下の設定手順は、2つの例で共通です。

1. コネクションの設定
2. 親チャネルの設定
3. コンシューマーの接続

6.1 例1: ユーザーアピアランスの表示

これは、ユーザーがオンラインかどうか、ユーザーがどのページを開いているかという情報を追跡するチャネルの簡単な例です（オンラインユーザーの横に緑の点を表示する機能を作成する場合などに便利です）。

サーバー側のアピアランスチャネルを作成します。

# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
  def subscribed
    current_user.appear
  end

  def unsubscribed
    current_user.disappear
  end

  def appear(data)
    current_user.appear(on: data['appearing_on'])
  end

  def away
    current_user.away
  end
end

サブスクリプションが開始されると、subscribedコールバックがトリガーされ、そのユーザーがオンラインであることが示されます。このアピアランスAPIをRedisやデータベースなどと連携することも可能です。

クライアント側のアピアランスチャネルを作成します。

// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"

consumer.subscriptions.create("AppearanceChannel", {
  // サブスクリプション作成時に1度呼び出される
  initialized() {
    this.update = this.update.bind(this)
  },

  // サブスクリプションがサーバーで利用可能になると呼び出される
  connected() {
    this.install()
    this.update()
  },

  // WebSocket接続がクローズすると呼び出される
  disconnected() {
    this.uninstall()
  },

  // サブスクリプションがサーバーで却下されると呼び出される
  rejected() {
    this.uninstall()
  },

  update() {
    this.documentIsActive ? this.appear() : this.away()
  },

  appear() {
    // サーバーの`AppearanceChannel#appear(data)`を呼び出す
    this.perform("appear", { appearing_on: this.appearingOn })
  },

  away() {
    // サーバーの`AppearanceChannel#away`を呼び出す
    this.perform("away")
  },

  install() {
    window.addEventListener("focus", this.update)
    window.addEventListener("blur", this.update)
    document.addEventListener("turbo:load", this.update)
    document.addEventListener("visibilitychange", this.update)
  },

  uninstall() {
    window.removeEventListener("focus", this.update)
    window.removeEventListener("blur", this.update)
    document.removeEventListener("turbo:load", this.update)
    document.removeEventListener("visibilitychange", this.update)
  },

  get documentIsActive() {
    return document.visibilityState === "visible" && document.hasFocus()
  },

  get appearingOn() {
    const element = document.querySelector("[data-appearing-on]")
    return element ? element.getAttribute("data-appearing-on") : null
  }
})

6.1.1 クライアント-サーバー間のやりとり

1. クライアントは、サーバーにcreateConsumer()経由で接続する（consumer.js）。サーバーは、このコネクションをcurrent_userで識別する。

2. クライアントは、アピアランスチャネルにconsumer.subscriptions.create({ channel: "AppearanceChannel" })経由で接続する（appearance_channel.js）。

3. サーバーは、アピアランスチャネル向けに新しいサブスクリプションを開始したことを認識し、サーバーのsubscribedコールバックを呼び出し、current_userのappearメソッドを呼び出す（appearance_channel.rb）。

4. クライアントは、サブスクリプションが確立したことを認識し、connectedを呼び出す（appearance_channel.js）。これにより、installとappearが呼び出される。appearはサーバーのAppearanceChannel#appear(data)を呼び出して{ appearing_on: this.appearingOn }のデータハッシュを渡す。なお、この動作が可能なのは、クラスで宣言されている（コールバックを除く）全パブリックメソッドが、サーバー側のチャネルインスタンスから自動的に公開されるからです。公開されたパブリックメソッドは、サブスクリプションでperformメソッドを使うとRPC（リモートプロシージャコール）として利用できます。

5. サーバーは、current_userで認識したコネクションのアピアランスチャネルで、appearアクションへのリクエストを受信する（appearance_channel.rb）。サーバーは:appearing_onキーを使ってデータをデータハッシュから取り出し、 current_user.appearに渡される:onキーの値として設定する。

6.2 例2: 新しいWeb通知を受信する

この例では、WebSocketコネクションを使って、クライアントの機能をサーバーからリモート実行するときのアピアランスを扱います。WebSocketでは双方向通信を利用できます。そこで、例としてサーバーからクライアントでアクションを起動してみましょう。

このWeb通知チャネルは、関連するストリームにブロードキャストを行ったときに、クライアント側でWeb通知を表示します。

サーバー側のWeb通知チャネルを作成します。

# app/channels/web_notifications_channel.rb
class WebNotificationsChannel < ApplicationCable::Channel
  def subscribed
    stream_for current_user
  end
end

クライアント側のWeb通知チャネルを作成します。

// app/javascript/channels/web_notifications_channel.js
// クライアント側では、サーバーからWeb通知の送信権を
// リクエスト済みであることが前提
import consumer from "./consumer"

consumer.subscriptions.create("WebNotificationsChannel", {
  received(data) {
    new Notification(data["title"], { body: data["body"] })
  }
})

以下のように、アプリケーションのどこからでもWeb通知チャネルのインスタンスにコンテンツをブロードキャストできます。

# このコードはアプリケーションのどこか（NewCommentJobあたり）で呼び出される
WebNotificationsChannel.broadcast_to(
  current_user,
  title: '新着情報！',
  body: '印刷しておきたいニュース記事リスト'
)

WebNotificationsChannel.broadcast_to呼び出しでは、現在のサブスクリプションアダプタのpub/subキューにメッセージを設定します。ユーザーごとに異なるブロードキャスト名が使われます。idが1のユーザーなら、ブロードキャスト名はweb_notifications:1のようになります。

このチャネルは、web_notifications:1で受信したものすべてをreceivedコールバック呼び出しでクライアントに直接ストリーミングするようになります。引数として渡されるデータは、サーバー側のブロードキャスト呼び出しに第2パラメータとして渡されたハッシュです。このハッシュはJSONでエンコードされ、receivedとして受信したデータ引数から取り出されます。

6.3 より詳しい例

RailsアプリケーションにAction Cableを設定する方法や、チャネルの追加方法の完全な例については、rails/actioncable-examples を参照してください。

7 設定

Action Cableで必須となる設定は、「サブスクリプションアダプタ」と「許可されたリクエスト送信元」の2つです。

7.1 サブスクリプションアダプタ

Action Cableは、デフォルトでconfig/cable.ymlの設定ファイルを利用します。Railsの環境ごとに、アダプタとURLを1つずつ指定する必要があります。アダプタについて詳しくは、依存関係を参照してください。

development:
  adapter: async

test:
  adapter: test

production:
  adapter: redis
  url: redis://10.10.3.153:6381
  channel_prefix: appname_production

7.1.1 利用できるアダプタ設定

以下は、エンドユーザー向けに利用できるサブスクリプションアダプタの一覧です。

7.1.1.1 Asyncアダプタ

asyncアダプタはdevelopment環境やtest環境で利用するためのものなので、production環境では使わないでください。

7.1.1.2 Redisアダプタ

Redisアダプタでは、Redisサーバーを指すURLを指定する必要があります。 また、複数のアプリケーションが同一のRedisサーバーを用いる場合は、チャネル名衝突を避けるためにchannel_prefixの指定が必要になることもあります。詳しくはRedis Pub/Subドキュメントを参照してください。

RedisアダプタではSSL/TLS接続もサポートされています。SSL/TLS接続に必要なパラメータは、設定用yamlファイルのssl_paramsで指定できます（注: rediss://はRedisのHTTPS接続を表します）。

production:
  adapter: redis
  url: rediss://10.10.3.153:tls_port
  channel_prefix: appname_production
  ssl_params: {
    ca_file: "/path/to/ca.crt"
  }

ssl_paramsオプションに渡したパラメータはOpenSSL::SSL::SSLContext#set_paramsメソッドに直接渡され、SSLコンテキストで有効な任意の属性を指定できます。その他に利用可能な属性名についてはOpenSSL::SSL::SSLContextドキュメントを参照してください。

ファイアウォールの内側にあるRedisアダプタ用の自己署名証明書を使うときに、証明書のチェックをスキップしたい場合は、SSLのverify_modeにOpenSSL::SSL::VERIFY_NONEを指定します。

7.1.1.3 PostgreSQLアダプタ

PostgreSQLアダプタはActive Recordコネクションプールを利用するため、アプリケーションのデータベース設定ファイル（config/database.yml）でコネクションを設定します。これについては将来変更される可能性があります（#27214）。

7.2 許可されたリクエスト送信元

Action Cableは、指定されていない送信元からのリクエストを受け付けません。送信元リストは、配列の形でサーバー設定に渡します。送信元リストには文字列のインスタンスや正規表現を利用でき、これに対して一致するかどうかがチェックされます。

config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}]

すべての送信元からのリクエストを許可または拒否するには、以下を設定します。

config.action_cable.disable_request_forgery_protection = true

デフォルトでは、development環境で実行中のAction Cableは、localhost:3000からのすべてのリクエストを許可します。

7.3 コンシューマーの設定

URLを設定するには、HTMLレイアウトのHEADセクションにaction_cable_meta_tag呼び出しを追加します。通常、環境の設定ファイルconfig.action_cable.urlで設定されたURLかパスを指定します。

7.4 ワーカープールの設定

ワーカープールは、サーバーのメインスレッドから隔離された状態でコネクションのコールバックやチャネルのアクションを実行するために用いられます。Action Cableでは、アプリケーションのワーカープール内で同時に処理されるスレッド数を次のように設定できます。

config.action_cable.worker_pool_size = 4

サーバーが提供するデータベースコネクション数は、少なくとも利用するワーカー数と同じでなければならない点にもご注意ください。デフォルトのワーカープールサイズは4に設定されているので、データベースコネクション数は少なくとも4以上を確保しなければなりません。この設定はconfig/database.ymlのpool属性で変更できます。

7.5 クライアント側のログ出力

クライアント側のログ出力はデフォルトで無効になります。以下のようにActionCable.logger.enabledにtrueを設定することで、クライアントログ出力有効にできます。

import * as ActionCable from '@rails/actioncable'

ActionCable.logger.enabled = true

7.6 その他の設定

その他によく使われるオプションとして、コネクションごとのロガーにタグを保存するオプションがあります。以下の例は、ユーザーアカウントidがある場合はそれをタグ名にし、ない場合は「no-account」をタグ名にします。

config.action_cable.log_tags = [
  -> request { request.env['user_account_id'] || "no-account" },
  :action_cable,
  -> request { request.uuid }
]

利用可能なすべての設定オプションについては、ActionCable::Server::Configurationクラスを参照してください。

8 Action Cable専用サーバーを実行する

8.1 アプリケーションで実行

Action CableはRailsアプリケーションと一緒に実行できます。たとえば、/websocketでWebSocketリクエストをリッスンするには、以下のようにconfig.action_cable.mount_pathにパスを指定します。

# config/application.rb
class Application < Rails::Application
  config.action_cable.mount_path = '/websocket'
end

レイアウトでaction_cable_meta_tagが呼び出されると、ActionCable.createConsumer()でAction Cableサーバーに接続できるようになります。それ以外の場合は、パスがcreateConsumerの最初の引数として指定されます（例: ActionCable.createConsumer("/websocket")）。

この場合、サーバーのインスタンスを作成するか、サーバーがワーカーを生成するたびに、Action Cableの新しいインスタンスも含まれます。RedisやPostgreSQLのアダプタは、コネクション間でメッセージを同期します。

8.2 スタンドアロン

アプリケーションサーバーとAction Cableサーバーを分けることもできます。Action Cableサーバーは引き続きRackアプリケーションのまま、独自のRackアプリケーションとなります。推奨される基本設定は次のとおりです。

# cable/config.ru
require_relative "../config/environment"
Rails.application.eager_load!

run ActionCable.server

続いて、bin/cableのbinstubを使ってサーバーを起動します。

#!/bin/bash
bundle exec puma -p 28080 cable/config.ru

これで、Action Cableサーバーがポート28080で起動します。

8.3 メモ

WebSocketサーバーはセッションにアクセスできませんが、cookieにはアクセスできます。これを利用して認証を処理できます。ブログ記事「Action CableとDeviseでの認証（英語）」を参照してください。

9 依存関係

Action Cableは、pub/subの内部を処理するためのサブスクリプションアダプタインターフェイスを提供します。デフォルトで利用できるアダプタは「非同期」「インライン」「PostgreSQL」「Redis」などです。新規Railsアプリケーションのアダプタは、デフォルトで非同期（async）アダプタになります。

Ruby側は、websocket-driver、 nio4r、concurrent-rubyの上に構築されています。

10 デプロイ

Action Cableは、WebSocketとスレッドの組み合わせによって支えられています。フレームワーク内部のフローや、ユーザー指定のチャネルの動作は、Rubyのネイティブスレッドによって処理されます。すなわち、スレッドセーフを損なわない限り、Railsの既存のモデルはすべて問題なく利用できます。

Action CableサーバーはRackのソケットハイジャックAPIを実装しているので、アプリケーションサーバーがマルチスレッドであるかどうかにかかわらず、内部のコネクションをマルチスレッドパターンで管理できます。

これによって、Action Cableは、Unicorn、Puma、Passengerなどの有名なサーバーと問題なく対応できます。

11 テスト

Action Cableで作成した機能のテスト方法について詳しくは、テスティングガイドを参照してください。

🖋 GitHubで編集を提案する / 📕 英語で読む

フィードバックについて

Railsガイドは GitHub の yasslab/railsguides.jp で管理・公開されております。本ガイドを読んで気になる文章や間違ったコードを見かけたら、気軽に Pull Request を出して頂けると嬉しいです。Pull Request の送り方については GitHub の README をご参照ください。

原著における間違いを見つけたら『Rails のドキュメントに貢献する』を参考にしながらぜひ Rails コミュニティに貢献してみてください 🛠💨✨

本ガイドの品質向上に向けて、皆さまのご協力が得られれば嬉しいです。

Railsガイド運営チーム (@RailsGuidesJP)

支援・協賛

Railsガイドは下記の協賛企業から継続的な支援を受けています。支援・協賛にご興味あれば協賛プランからお問い合わせいただけると嬉しいです。

1. Star
2.