الفرق بين المراجعتين لصفحة: «Rails/action cable overview»
جميل-بيلوني (نقاش | مساهمات) مراجعة وتدقيق |
جميل-بيلوني (نقاش | مساهمات) طلا ملخص تعديل |
||
سطر 1: | سطر 1: | ||
<noinclude>{{DISPLAYTITLE:نظرة عامة على | <noinclude>{{DISPLAYTITLE:نظرة عامة على Action Cable في ريلز}}</noinclude> | ||
ستتعرف في هذا الدليل على كيفية عمل | ستتعرف في هذا الدليل على كيفية عمل [[Rails/action cable|Action Cable]] وكيفية استخدام WebSockets لدمج ميزات الوقت الفعلي في تطبيق ريلز. | ||
بعد قراءة هذا الدليل، ستتلعم: | بعد قراءة هذا الدليل، ستتلعم: | ||
* ماهية | * ماهية [[Rails/action cable|Action Cable]] وكيفية دمج الواجهة الخلفية والأمامية الخاصة به. | ||
* كيفية إعداد | * كيفية إعداد [[Rails/action cable|Action Cable]]. | ||
* كيفية إعداد القنوات. | * كيفية إعداد القنوات. | ||
* النشر وإعداد المعمارية لتشغيل | * النشر وإعداد المعمارية لتشغيل [[Rails/action cable|Action Cable]]. | ||
== المقدمة == | == المقدمة == | ||
يدمج | يدمج [[Rails/action cable|Action Cable]] مقابس الويب [[wikipedia:WebSocket|WebSockets]] مع باقي تطبيق ريلز بسلاسة. يسمح ذلك بكتابة الميزات في الوقت الحقيقي في روبي بنفس الأسلوب والشكل كبقية تطبيقات ريلز، مع الاستمرار في الأداء وقابلية التطوير. إنه عرض كامل يوفر كلًا من إطار عمل [[JavaScript]] من جانب العميل وإطار عمل روبي من جانب الخادم. لديك حق الوصول إلى نموذج المجال الكامل الخاص بك المكتوب مع [[Rails/active record|Active Record]] أو تقنية ORM الخاص بك في الاختيار. | ||
== ماهو Pub/Sub == | == ماهو Pub/Sub == | ||
يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى صنف مجرد من المستلمين (المشتركين) دون تحديد مستلمين فرديين. يستخدم | يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى صنف مجرد من المستلمين (المشتركين) دون تحديد مستلمين فرديين. يستخدم [[Rails/action cable|Action Cable]] هذا الأسلوب للتواصل بين الخادم والعديد من العملاء. | ||
== مكونات من جانب الخادم == | == مكونات من جانب الخادم == | ||
سطر 391: | سطر 391: | ||
=== المزيد من الأمثلة الكاملة === | === المزيد من الأمثلة الكاملة === | ||
راجع المستودع [https://github.com/rails/actioncable-examples rails/actioncable-examples] لمثال كامل عن كيفية إعداد | راجع المستودع [https://github.com/rails/actioncable-examples rails/actioncable-examples] لمثال كامل عن كيفية إعداد Action Cable في تطبيق ريلز وإضافة القنوات. | ||
== الضبط == | == الضبط == | ||
يتطلب " | يتطلب "Action Cable" إعداد ضبطين هما: محول الاشتراك (subscription adapter) والأصول المسموح طلبها. | ||
=== محول الاشتراك === | === محول الاشتراك === | ||
بشكل افتراضي، يبحث | بشكل افتراضي، يبحث Action Cable عن ملف ضبط في config/cable.yml. يجب أن يحدد الملف محولًا لكل بيئة ريلز. انظر قسم [[Rails/action cable overview#.D8.A7.D9.84.D8.AA.D8.A8.D8.B9.D9.8A.D8.A7.D8.AA|التبعيات]] للحصول على معلومات إضافية حول المحولات. | ||
<syntaxhighlight lang="rails"> | <syntaxhighlight lang="rails"> | ||
development: | development: | ||
سطر 415: | سطر 415: | ||
* المحول Async: المحول المتزامن (async adapter) هو من أجل التطوير / الاختبار ويجب عدم استخدامه في الإنتاج. | * المحول Async: المحول المتزامن (async adapter) هو من أجل التطوير / الاختبار ويجب عدم استخدامه في الإنتاج. | ||
* المحول Redis: يتطلب المحول Redis من المستخدمين توفير عنوان URL يشير إلى خادم Redis. بالإضافة إلى ذلك، قد يُوفَّر <code>channel_prefix</code> لتجنب تضارب اسم القناة عند استخدام خادم Redis نفسه لتطبيقات متعددة. راجع [https://redis.io/topics/pubsub#database-amp-scoping توثيق Redis للنشر/الاشتراك] لمزيد من التفاصيل. | * المحول Redis: يتطلب المحول Redis من المستخدمين توفير عنوان URL يشير إلى خادم Redis. بالإضافة إلى ذلك، قد يُوفَّر <code>channel_prefix</code> لتجنب تضارب اسم القناة عند استخدام خادم Redis نفسه لتطبيقات متعددة. راجع [https://redis.io/topics/pubsub#database-amp-scoping توثيق Redis للنشر/الاشتراك] لمزيد من التفاصيل. | ||
* المحول PostgreSQL: يستخدم المحول PostgreSQL مُجمَّع اتصال [[Rails/active record | * المحول PostgreSQL: يستخدم المحول PostgreSQL مُجمَّع اتصال [[Rails/active record|Active Record]]، وبالتالي ضبط قاعدة البيانات config/database.yml للتطبيق، للاتصال به. هذا قد يتغير في المستقبل. [https://github.com/rails/rails/issues/27214 #27214]. | ||
=== الأصول المسموح لها بالطلب === | === الأصول المسموح لها بالطلب === | ||
يقبل | يقبل [[Rails/action cable|Action Cable]] طلبات من أصول محددة فقط، والتي مُررت إلى ضبط الخادم كمصفوفة. يمكن أن تكون الأصول عبارة عن نسخ من السلاسل النصية أو التعبيرات النمطية، والتي تجري تطابقًا محددًا. | ||
<syntaxhighlight lang="rails"> | <syntaxhighlight lang="rails"> | ||
config.action_cable.allowed_request_origins = ['http://rubyonrails.com', %r{http://ruby.*}] | config.action_cable.allowed_request_origins = ['http://rubyonrails.com', %r{http://ruby.*}] | ||
سطر 428: | سطر 428: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
بشكل افتراضي، يسمح | بشكل افتراضي، يسمح [[Rails/action cable|Action Cable]] بجميع الطلبات من localhost:3000 عند التشغيل في بيئة التطوير. | ||
=== ضبط المستهلك === | === ضبط المستهلك === | ||
سطر 450: | سطر 450: | ||
=== في التطبيق === | === في التطبيق === | ||
يمكن تشغيل | يمكن تشغيل [[Rails/action cable|Action Cable]] بشكل منفصل ومستقل مع تطبيق ريلز الخاص بك. على سبيل المثال، للاستماع لطلبات مقبس ويب WebSocket على /websocket، حدد ذلك المسار في الضبط <code>config.action_cable.mount_path</code>: | ||
<syntaxhighlight lang="rails"> | <syntaxhighlight lang="rails"> | ||
# config/application.rb | # config/application.rb | ||
سطر 466: | سطر 466: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
لكل نسخة تنشئها من خادمك ولكل عملية عاملة (worker) يولدها خادمك، سيكون لديك أيضًا نسخة جديدة من | لكل نسخة تنشئها من خادمك ولكل عملية عاملة (worker) يولدها خادمك، سيكون لديك أيضًا نسخة جديدة من [[Rails/action cable|Action Cable]]، ولكن استخدام Redis يبقي الرسائل متزامنة عبر الاتصالات. | ||
=== الاستقلالية === | === الاستقلالية === | ||
سطر 491: | سطر 491: | ||
== التبعيات == | == التبعيات == | ||
يوفر " | يوفر "[[Rails/action cable|Action Cable]]" واجهة محول اشتراك لمعالجة عمليات النشر والاشتراك (pubsub) الداخلية الخاصة به. بشكل افتراضي، تُضمَّن المحولات غير متزامنة والسطرية و PostgreSQL و Redis. المحول الافتراضي في تطبيق ريلز جديد هو محول غير متزامن (async). | ||
تم بناء أشياء من طرف روبي فوق [https://github.com/faye/websocket-driver-ruby websocket-driver]، و [https://github.com/celluloid/nio4r nio4r]، و [https://github.com/ruby-concurrency/concurrent-ruby conjurrent-ruby]. | تم بناء أشياء من طرف روبي فوق [https://github.com/faye/websocket-driver-ruby websocket-driver]، و [https://github.com/celluloid/nio4r nio4r]، و [https://github.com/ruby-concurrency/concurrent-ruby conjurrent-ruby]. | ||
== النشر == | == النشر == | ||
يعمل | يعمل [[Rails/action cable|Action Cable]] من خلال مزيج من مقابس الويب WebSockets و<nowiki/>[[Ruby/Thread|الخيوط]]. تعالج كل من أعمال أنابيب الإطار وعمل القناة المحددة من قبل المستخدم داخليًا من خلال الاستفادة من دعم روبي الأصلي. هذا يعني أنه يمكنك استخدام جميع نماذج ريلز العادية الخاصة بك دون أي مشكلة، طالما أنك لم ترتكب أي خطأ في سلامة الصفحات. | ||
ينفذ خادم | ينفذ خادم [[Rails/action cable|Action Cable]] الواجهة البرمجية لاختطاف المقبس Rack (أي Rack socket hijacking API)، مما يسمح باستخدام أنماط ذات خيوط متعددة (multithreaded pattern) لإدارة الاتصالات داخليًا، بغض النظر عن ما إذا كان خادم التطبيق متعدد الخيوط أم لا. | ||
وفقًا لذلك، يعمل | وفقًا لذلك، يعمل [[Rails/action cable|Action Cable]] مع خوادم شائعة مثل Unicorn و Puma و Passenger. | ||
== مصادر == | == مصادر == |
المراجعة الحالية بتاريخ 08:52، 25 مارس 2019
ستتعرف في هذا الدليل على كيفية عمل Action Cable وكيفية استخدام WebSockets لدمج ميزات الوقت الفعلي في تطبيق ريلز.
بعد قراءة هذا الدليل، ستتلعم:
- ماهية Action Cable وكيفية دمج الواجهة الخلفية والأمامية الخاصة به.
- كيفية إعداد Action Cable.
- كيفية إعداد القنوات.
- النشر وإعداد المعمارية لتشغيل Action Cable.
المقدمة
يدمج Action Cable مقابس الويب WebSockets مع باقي تطبيق ريلز بسلاسة. يسمح ذلك بكتابة الميزات في الوقت الحقيقي في روبي بنفس الأسلوب والشكل كبقية تطبيقات ريلز، مع الاستمرار في الأداء وقابلية التطوير. إنه عرض كامل يوفر كلًا من إطار عمل JavaScript من جانب العميل وإطار عمل روبي من جانب الخادم. لديك حق الوصول إلى نموذج المجال الكامل الخاص بك المكتوب مع Active Record أو تقنية ORM الخاص بك في الاختيار.
ماهو Pub/Sub
يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى صنف مجرد من المستلمين (المشتركين) دون تحديد مستلمين فرديين. يستخدم Action Cable هذا الأسلوب للتواصل بين الخادم والعديد من العملاء.
مكونات من جانب الخادم
الاتصالات
تشكل الاتصالات أساس العلاقة بين العميل والخادم. لكل مقبس ويب WebSocket مقبول من قبل الخادم، تُنشأ نسخة من كائن الاتصال. يصبح هذا الكائن الأب لكل اشتراكات القناة (channel subscriptions) التي أُنشأت من هناك. لا يتعامل الاتصال نفسه مع أي شيفرة تطبيق معين يتجاوز الاستيثاق والترخيص. يسمى عميل اتصال مقبس الويب WebSocket مستهلك الاتصال (connection consumer). سينشئ مستخدم فردي زوجًا واحدًا لمستهلك الاتصال في كل لسان أو نافذة أو جهاز يفتحه المتصفح.
الاتصالات هي نُسخ من ApplicationCable::Connection
. في هذا الصنف، أنت تسمح بالاتصال الوارد، وتشرع في تأسيسه إذا كان من الممكن التعرف على المستخدم.
إعدادات الاتصال
# 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
يكون ident_by
هنا هو معرف اتصال يمكن استخدامه للعثور على اتصال محدد في وقت لاحق. لاحظ أن أي شيء مُيز كمعرف سيُنشِئ تلقائيًا مفوَّضًا (delegate) بنفس الاسم على أي نُسخة قناة أُنشأت خارج الاتصال.
يعتمد هذا المثال على حقيقة أنك ستتولى بالفعل الاستيثاق من المستخدم في مكان آخر في التطبيق الخاص بك، ويُعيِّن ذلك الاستيثاق الناجح ملف تعريف ارتباط موقّع مع معرف المستخدم.
بعد ذلك، يُرسَل ملف تعريف الارتباط تلقائيًا إلى نسخة الاتصال عند محاولة إجراء اتصال جديد، ويمكنك استخدام ذلك من تعيين current_user
. من خلال تحديد الاتصال بواسطة هذا المستخدم الحالي نفسه، فإنك أيضًا تتأكد من أنه يمكنك في وقت لاحق استرداد جميع الاتصالات المفتوحة من قبل مستخدم معين (ومن المحتمل فصلها كلها إذا حذف المستخدم أو كان غير مصرح به).
القنوات
تغلف القناة وحدة منطقية من العمل، مشابهة لما تفعله وحدة التحكم في إعداد MVC عادي. بشكل افتراضي، ينشئ ريلز الصنف الأب ApplicationCable::Channel
لتغليف شيفرة مشتركة بين قنواتك.
إعداد القناة الأب
# app/channels/application_cable/channel.rb
module ApplicationCable
class Channel < ActionCable::Channel::Base
end
end
ثم يمكنك إنشاء أصناف قناتك (channel classes) الخاصة. على سبيل المثال، قد يكون لديك ChatChannel
و AppearanceChannel
:
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
end
# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
end
يمكن بعد ذلك أن يشترك المستهلك في أي من هاتين القناتين أو كليهما.
الاشتراكات
يشترك المستهلكون في القنوات، كمشتركين (subscribers). اتصالهم يسمى «الاشتراك» (subscription). ثم توجه الرسائل التي أُنتجت إلى اشتراكات القنوات هذه استنادًا إلى معرّف أُرسل بواسطة مستهلك الوصل (cable consumer).
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
# يُستدعى عندما يصبح المستهلك مشتركًا بهذه القناة
def subscribed
end
end
مكونات من جانب العميل
الاتصالات
يحتاج المستهلكون إلى نسخة من الاتصال على جانبهم. ينشأ هذا باستخدام شيفرة JavaScript التالية، والتي تُولَّد افتراضيًا بواسطة ريلز:
مستهلك الاتصال
// app/assets/javascripts/cable.js
//= require action_cable
//= require_self
//= require_tree ./channels
(function() {
this.App || (this.App = {});
App.cable = ActionCable.createConsumer();
}).call(this);
هذا سوف يُجهِّز مستهلكًا سيتصل بـ /cable على الخادم الخاص بك بشكل افتراضي. لن يُنشَأ الاتصال حتى تحدد أيضًا اشتراكًا واحدًا على الأقل ترغب في الحصول عليه.
المشترك
يصبح المستهلك مشتركًا عن طريق إنشاء اشتراك لقناة معينة:
# app/assets/javascripts/cable/subscriptions/chat.coffee
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" }
# app/assets/javascripts/cable/subscriptions/appearance.coffee
App.cable.subscriptions.create { channel: "AppearanceChannel" }
بينما يُنشِئ هذا الاشتراك، ستوصف الوظيفة المطلوبة للرد على البيانات المستلمة في وقت لاحق.
يمكن للمستهلك التصرف كمشترك في قناة معينة في أي عدد من المرات. على سبيل المثال، يمكن للمستهلك الاشتراك في غرف دردشة متعددة في نفس الوقت:
App.cable.subscriptions.create { channel: "ChatChannel", room: "1st Room" }
App.cable.subscriptions.create { channel: "ChatChannel", room: "2nd Room" }
تفاعلات الخادم والعميل
المجاري
توفر المجاري آلية توجه القنوات عبرها المحتوى المنشور (البث) لجميع المشتركين في ذلك المجرى.
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
إذا كان لديك مجرًى مرتبطًا بنموذج، فيمكن توليد البث المستخدم من النموذج والقناة. سوف يشترك المثال التالي في بث مثل comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE:
class CommentsChannel < ApplicationCable::Channel
def subscribed
post = Post.find(params[:id])
stream_for post
end
end
يمكنك بعد ذلك البث إلى هذه القناة كما يلي:
CommentsChannel.broadcast_to(@post, @comment)
البث (Broadcasting)
البث هو رابط pub / sub حيث يوجه أي شيء أُرسل من قبل ناشر مباشرة إلى المشتركين في القناة الذين يقومون ببث تلك الإذاعة المسماة. يمكن لكل قناة أن تبث بثًا أو أكثر من بث.
البث هو طابور على الإنترنت يعتمد على الوقت. إذا كان المستهلك لا يجري بثًا (اشترك في قناة معينة)، فلن يحصل على البث إذا اتصل به لاحقًا.
تُستدعَى عمليات البث في أي مكان آخر في تطبيق ريلز:
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)
يضع الاستدعاء WebNotificationsChannel.broadcast_to
رسالةً في قائمة انتظار الاشتراك في محول الاشتراك الحالي (بشكل افتراضي redis للإنتاج و التزامن لبيئات التطوير والاختبار) تحت اسم بث منفصل لكل مستخدم. بالنسبة لمستخدم ذي المعرف 1، سيكون اسم البث web_notifications:1
.
توجه القناة لبث كل شيء يصل إلى web_notifications:1
مباشرة إلى العميل عن طريق استدعاء رد النداء received
.
الاشتراكات
عندما يشترك المستهلك في قناة، يكون بمثابة مشترك (subscriber). هذا الاتصال يسمى الاشتراك (subscription). ثم توجه الرسائل الواردة إلى اشتراكات القنوات هذه استنادًا إلى مُعرّف أُرسل بواسطة مستهلك الربط (cable consumer).
# app/assets/javascripts/cable/subscriptions/chat.coffee
# افترض أن طلبت مسبقًا الإذن لإرسال تنبيهات ويب
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
received: (data) ->
@appendLine(data)
appendLine: (data) ->
html = @createLine(data)
$("[data-chat-room='Best Room']").append(html)
createLine: (data) ->
"""
<article class="chat-line">
<span class="speaker">#{data["sent_by"]}</span>
<span class="body">#{data["body"]}</span>
</article>
"""
تمرير المعاملات إلى القنوات
يمكنك تمرير المعاملات من جانب العميل إلى جانب الخادم عند إنشاء اشتراك. فمثلًا:
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
يصبح الكائن الذي مُرر ليكون الوسيط الأول إلى subscriptions.create
المعاملات params
(التي هي جدول Hash) في قناة الربط (cable channel). الكلمة المفتاحية channel
مطلوبة:
# app/assets/javascripts/cable/subscriptions/chat.coffee
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
received: (data) ->
@appendLine(data)
appendLine: (data) ->
html = @createLine(data)
$("[data-chat-room='Best Room']").append(html)
createLine: (data) ->
"""
<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.'
)
إعادة بث رسالة
حالة الاستخدام الشائعة هي إعادة رب (rebroadcast) رسالة أُرسلت بواسطة عميل واحد إلى أي عملاء آخرين متصلين.
# 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/assets/javascripts/cable/subscriptions/chat.coffee
App.chatChannel = App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
received: (data) ->
# data => { sent_by: "Paul", body: "This is a cool chat app." }
App.chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })
سيُستلَم إعادة البث من قبل جميع العملاء المتصلين، بما في ذلك العميل الذي أرسل الرسالة. لاحظ أن params
هي نفسها كما كانت عند الاشتراك في القناة.
أمثلة كاملة
خطوات الإعداد التالية متماثلة في كلا المثالين:
مثال 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
، وننتهز هذه الفرصة لنقول "لقد ظهر المستخدم الحالي بالفعل". يمكن دعم واجهة برمجة التطبيقات التي تظهر / تختفي بواسطة Redis أو قاعدة بيانات أو أي شيء آخر.
إنشاء اشتراك قناة تظهر العميل:
# app/assets/javascripts/cable/subscriptions/appearance.coffee
App.cable.subscriptions.create "AppearanceChannel",
# يُستدعَى عندما يصبح الاشتراك جاهزًا للاستعمال في الخادم
connected: ->
@install()
@appear()
# WebSocket يُستدعَى عندما يُغلَق اتصال مقبس الويب
disconnected: ->
@uninstall()
# يُستدعَى عندما يُرفَض الاشتراك من طرف الخادم
rejected: ->
@uninstall()
appear: ->
# على الخادم `AppearanceChannel#appear(data)` يستدعي
@perform("appear", appearing_on: $("main").data("appearing-on"))
away: ->
# على الخادم `AppearanceChannel#away` يستدعي
@perform("away")
buttonSelector = "[data-behavior~=appear_away]"
install: ->
$(document).on "turbolinks:load.appearance", =>
@appear()
$(document).on "click.appearance", buttonSelector, =>
@away()
false
$(buttonSelector).show()
uninstall: ->
$(document).off(".appearance")
$(buttonSelector).hide()
تفاعل الخادم - العميل
1 - يتصل العميل بالخادم عبر:
App.cable =
ActionCable.createConsumer("ws://cable.example.com"). (cable.js)
يحدد الخادم هذا الاتصال بواسطة current_user
.
2 - يشترك العميل في قناة آخر ظهور عبر:
App.cable.subscriptions.create(channel: "AppearanceChannel"). (appearance.coffee)
3 - يتعرف الخادم على الاشتراك الجديد المُنشَأ للتو بقناة آخر ظهور ويشغل رد النداء subscribed
الخاص به، مع استدعاء التابع appear
على current_user
. (الملف appearance_channel.rb)
4 - يدرك العميل أنه أُنشأ الاشتراك ويستدعي appearance.coffe) connected
) والذي يستدعي بدوره @install
و appear@
. يستدعي appear@
بعدئذٍ (AppearanceChannel.appear(data
على الخادم، ويزود جدول Hash من البيانات من { appearing_on: $("main").data("appearing-on") }
. هذا ممكن لأن نسخة القناة من جانب الخادم تكشف تلقائيًا كل التوابع العامة المصرح عنها في الصنف (باستثناء ردود النداء)، بحيث يمكن الوصول إليها كإستدعاء إجراء بعيد عن طريق التابع perform
الذي يخص الاشتراك.
5 - يتلقى الخادم طلب الإجراء appear
في قناة آخر الظهور الخاصة بالاتصال المحدد بواسطة current_user
(في الملف appearance_channel.rb). يسترد الخادم البيانات باستخدام المفتاح :appearing_on
من جدول Hash من البيانات ويعينها كقيمة :on
على المفتاح الذي يمرر إلى current_user.appear
.
مثال 2: تلقي إشعارات ويب جديدة
كان المثال السابق عن عرض كيفية استدعاء وظيفة من طرف الخادم على طرف العميل عبر اتصال مقبس ويب WebSocket. ولكن الشيء المميز في WebSockets هو أنه شارع ذو اتجاهين. لذا، دعنا الآن نعرض مثالًا حيث يستدعي الخادم إجراءً على طرف العميل.
هذا المثال عبارة عن قناة إخبارية على الويب تسمح لك بتشغيل إشعارات الويب من جانب العميل عند البث إلى مجموعات البث الصحيحة:
إنشاء قناة إشعارات الويب من جانب الخادم:
# app/channels/web_notifications_channel.rb
class WebNotificationsChannel < ApplicationCable::Channel
def subscribed
stream_for current_user
end
end
إنشاء اشتراك قناة إشعارات الويب من جانب العميل:
# app/assets/javascripts/cable/subscriptions/web_notifications.coffee
# يفترض جانب العميل أنك طلبت مسبقًا إذنًا لإرسال تنبيهات ويب
App.cable.subscriptions.create "WebNotificationsChannel",
received: (data) ->
new Notification data["title"], body: data["body"]
بث المحتوى إلى نسخة قناة تنبيه عبر الويب (web notification channel) من مكان آخر في التطبيق الخاص بك:
# NewCommentJob يُستدعَى هذا من مكان من من تطبيقك وربما من
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)
يضع الاستدعاء WebNotificationsChannel.broadcast_to
رسالةً في طابور انتظار النشر والاشتراك (pubsub) لمحول الاشتراك الحالي تحت اسم بث منفصل لكل مستخدم. بالنسبة لمستخدم ذي المعرف 1، سيكون اسم البث web_notifications:1
.
توجه القناة لبث كل شيء يصل إلى web_notifications:1
مباشرةً إلى العميل عن طريق استدعاء رد النداء received
. البيانات التي تُمرر كوسيط هي جدول Hash المرسل كمعامل ثاني لاستدعاء البث من جانب الخادم، إذ يشفر بصيغة JSON أثناء رحلته عبر السلك ويفك تشفيره من أجل وسيط البيانات عند الوصول كـ received
.
المزيد من الأمثلة الكاملة
راجع المستودع rails/actioncable-examples لمثال كامل عن كيفية إعداد Action Cable في تطبيق ريلز وإضافة القنوات.
الضبط
يتطلب "Action Cable" إعداد ضبطين هما: محول الاشتراك (subscription adapter) والأصول المسموح طلبها.
محول الاشتراك
بشكل افتراضي، يبحث Action Cable عن ملف ضبط في config/cable.yml. يجب أن يحدد الملف محولًا لكل بيئة ريلز. انظر قسم التبعيات للحصول على معلومات إضافية حول المحولات.
development:
adapter: async
test:
adapter: async
production:
adapter: redis
url: redis://10.10.3.153:6381
channel_prefix: appname_production
ضبط المحول
فيما يلي قائمة بمحولات الاشتراك المتاحة للمستخدمين النهائيين.
- المحول Async: المحول المتزامن (async adapter) هو من أجل التطوير / الاختبار ويجب عدم استخدامه في الإنتاج.
- المحول Redis: يتطلب المحول Redis من المستخدمين توفير عنوان URL يشير إلى خادم Redis. بالإضافة إلى ذلك، قد يُوفَّر
channel_prefix
لتجنب تضارب اسم القناة عند استخدام خادم Redis نفسه لتطبيقات متعددة. راجع توثيق Redis للنشر/الاشتراك لمزيد من التفاصيل. - المحول PostgreSQL: يستخدم المحول PostgreSQL مُجمَّع اتصال Active Record، وبالتالي ضبط قاعدة البيانات config/database.yml للتطبيق، للاتصال به. هذا قد يتغير في المستقبل. #27214.
الأصول المسموح لها بالطلب
يقبل Action Cable طلبات من أصول محددة فقط، والتي مُررت إلى ضبط الخادم كمصفوفة. يمكن أن تكون الأصول عبارة عن نسخ من السلاسل النصية أو التعبيرات النمطية، والتي تجري تطابقًا محددًا.
config.action_cable.allowed_request_origins = ['http://rubyonrails.com', %r{http://ruby.*}]
لتعطيل والسماح بالطلبات من أي أصل:
config.action_cable.disable_request_forgery_protection = true
بشكل افتراضي، يسمح Action Cable بجميع الطلبات من localhost:3000 عند التشغيل في بيئة التطوير.
ضبط المستهلك
لتهيئة عنوان URL، أضف استدعاءً إلى action_cable_meta_tag
في شيفرة HTML الخاصة بك في الوسم <head>
. يستخدم هذا عنوان URL أو مسار يُعين عادةً عبر config.action_cable.url
في ملفات ضبط البيئة.
ضبط أمور أخرى
الخيار المشترك الآخر المراد ضبطه هو وسوم التسجيل (log tags) المطبقة على مسجل الاتصال. في ما يلي مثال يستخدم معرف حساب المستخدم إذا كان متاحًا، أو "بدون حساب" آخر أثناء وضع الوسوم:
config.action_cable.log_tags = [
-> request { request.env['user_account_id'] || "no-account" },
:action_cable,
-> request { request.uuid }
]
للحصول على قائمة كاملة بجميع خيارات الضبط، راجع الصنف ActionCable::Server::Configuration
.
لاحظ أيضًا أن الخادم الخاص بك يجب أن يوفر على الأقل نفس عدد اتصالات قاعدة البيانات كما تعمل لديك. يُعين حجم المجمع الافتراضي للعملية العاملة (default worker pool size) إلى 4، وهذا يعني أن عليك أن تجعل ذلك متوافرًا على الأقل. يمكنك تغيير ذلك في config/database.yml من خلال الخاصية pool
.
تشغيل خوادم ربط مستقلة
في التطبيق
يمكن تشغيل Action Cable بشكل منفصل ومستقل مع تطبيق ريلز الخاص بك. على سبيل المثال، للاستماع لطلبات مقبس ويب WebSocket على /websocket، حدد ذلك المسار في الضبط config.action_cable.mount_path
:
# config/application.rb
class Application < Rails::Application
config.action_cable.mount_path = '/websocket'
end
يمكنك استخدام ()App.cable = ActionCable.createConsumer
للاتصال بخادم الربط (cable server) إذا استُدعِي action_cable_meta_tag
في التخطيط.
يُحدَّد مسار مخصص كوسيط أول إلى createConsumer
مثل:
App.cable =
ActionCable.createConsumer("/websocket")
لكل نسخة تنشئها من خادمك ولكل عملية عاملة (worker) يولدها خادمك، سيكون لديك أيضًا نسخة جديدة من Action Cable، ولكن استخدام Redis يبقي الرسائل متزامنة عبر الاتصالات.
الاستقلالية
يمكن فصل خادم الربط (cable servers) عن خادم التطبيق العادي. لا يزال تطبيق Rack، ولكنه تطبيق Rack الخاص به. الإعداد الأساسي الموصى به هو كما يلي:
# cable/config.ru
require_relative '../config/environment'
Rails.application.eager_load!
run ActionCable.server
ثم يمكن بدء الخادم باستخدام binstub في bin/cable
:
#!/bin/bash
bundle exec puma -p 28080 cable/config.ru
بتنفيذ ذلك، سيبدأ خادم الربط على المنفذ 28080.
ملاحظات
لا يمتلك خادم WebSocket إمكانية الوصول إلى الجلسة، ولكن لديه حق الوصول إلى ملفات تعريف الارتباط. يمكن استخدام هذا عندما تحتاج إلى التعامل مع الاستيثاق. يمكنك رؤية طريقة واحدة للقيام بذلك باستخدام Devise في هذه المقالة.
التبعيات
يوفر "Action Cable" واجهة محول اشتراك لمعالجة عمليات النشر والاشتراك (pubsub) الداخلية الخاصة به. بشكل افتراضي، تُضمَّن المحولات غير متزامنة والسطرية و PostgreSQL و Redis. المحول الافتراضي في تطبيق ريلز جديد هو محول غير متزامن (async).
تم بناء أشياء من طرف روبي فوق websocket-driver، و nio4r، و conjurrent-ruby.
النشر
يعمل Action Cable من خلال مزيج من مقابس الويب WebSockets والخيوط. تعالج كل من أعمال أنابيب الإطار وعمل القناة المحددة من قبل المستخدم داخليًا من خلال الاستفادة من دعم روبي الأصلي. هذا يعني أنه يمكنك استخدام جميع نماذج ريلز العادية الخاصة بك دون أي مشكلة، طالما أنك لم ترتكب أي خطأ في سلامة الصفحات.
ينفذ خادم Action Cable الواجهة البرمجية لاختطاف المقبس Rack (أي Rack socket hijacking API)، مما يسمح باستخدام أنماط ذات خيوط متعددة (multithreaded pattern) لإدارة الاتصالات داخليًا، بغض النظر عن ما إذا كان خادم التطبيق متعدد الخيوط أم لا.
وفقًا لذلك، يعمل Action Cable مع خوادم شائعة مثل Unicorn و Puma و Passenger.