action_cable

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

ActionCable は、Rails の ActionCable の Dart クライアント実装であり、Flutter および Dart アプリケーションで WebSocket を介してリアルタイムの双方向通信を可能にします。Web、DartVM、および Android、iOS、macOS、Windows、Linux などのモバイルプラットフォームをサポートしています。このパッケージは、ライブアップデート、チャットシステム、通知などの機能のために ActionCable サーバーとシームレスに統合できます。チャンネルへの購読、メッセージ受信、接続の管理を可能にするクリーンな API を提供し、組み込みの再接続ロジックも備えています。リアルタイムデータ同期が必要なアプリに最適です。

用途

リアルタイムチャットアプリケーション
ライブダッシュボードの更新
通知システム
共同編集ツール
ストリーミングデータフィード

主な機能

WebSocket をベースとしたリアルタイム通信
クロスプラットフォーム対応（ウェブ、モバイル、デスクトップ）
チャンネル購読管理
自動再接続
シンプルなイベント駆動型 API

適している対象

リアルタイム機能を必要とするFlutterアプリ
Railsバックエンドを使用するDartプロジェクト
ライブインタラクティブUIを構築する開発者
低遅延更新を必要とするアプリ
サーバーサイドでActionCableを使用するチーム

注意事項

互換性のある ActionCable サーバーが必要です
ネットワークの信頼性はパフォーマンスに影響します
成熟した代替品と比べてドキュメントが限られている
メッセージ解析の手動処理が必要です
調整なしでは、高周波・低レイテンシーのシナリオには適していません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Pub

ActionCable in Dart

ActionCable is the default realtime websocket framework and protocol in Rails.

This is a dart port of the client and protocol implementation which is available in web, dartVM and flutter.

Usage

Connecting to a channel 🙌

cable = ActionCable.connect(
  "ws://10.0.2.2:3000/cable",
  headers: {
    "Authorization": "Some Token",
  },
  onConnected: (){
    print("connected");
  },
  onConnectionLost: () {
    print("connection lost");
  },
  onCannotConnect: () {
    print("cannot connect");
});

Subscribing to channel 🎉

cable.subscribe(
  "Chat", // either "Chat" and "ChatChannel" is fine
  channelParams: { "room": "private" },
  onSubscribed: (){}, // `confirm_subscription` received
  onDisconnected: (){}, // `disconnect` received
  onMessage: (Map message) {} // any other message received
);

Unsubscribing from a channel 🎃

cable.unsubscribe(
  "Chat", // either "Chat" and "ChatChannel" is fine
  {"room": "private"}
);

Perform an action on your ActionCable server 🎇

Requires that you have a method defined in your Rails Action Cable channel whose name matches the action property passed in.

cable.performAction(
  "Chat",
  action: "send_message",
  channelParams: { "room": "private" },
  actionParams: { "message": "Hello private peeps! 😜" }
);