الفرق بين المراجعتين ل"Rails/action cable overview"

من موسوعة حسوب
اذهب إلى التنقل اذهب إلى البحث
(إنشاء الصفحة. هذه الصفحة من مساهمات "دعاء فرح")
 
سطر 1: سطر 1:
 
<noinclude>{{DISPLAYTITLE:نظرة عامة على إجراء الربط في ريلز}}</noinclude>
 
<noinclude>{{DISPLAYTITLE:نظرة عامة على إجراء الربط في ريلز}}</noinclude>
ستتعرف في هذا الدليل على كيفية عمل Action Cable وكيفية استخدام WebSockets لدمج ميزات الوقت الفعلي في تطبيق Rails.
+
ستتعرف في هذا الدليل على كيفية عمل إجراء الربط (Action Cable) وكيفية استخدام WebSockets لدمج ميزات الوقت الفعلي في تطبيق ريلز.
  
بعد قراءة هذا الدليل، ستعرف:
+
بعد قراءة هذا الدليل، ستتلعم:
* ما هو Action Cable و تكامل backend والواجهة الأمامية.
+
* ماهية إجراء الربط وكيفية دمج الواجهة الخلفية والأمامية الخاصة به.
* كيفية إعداد Action Cable.
+
* كيفية إعداد إجراء الربط (Action Cable).
 
* كيفية إعداد القنوات.
 
* كيفية إعداد القنوات.
* النشر وإعداد الهندسة المعمارية لتشغيل Action Cable.
+
* النشر وإعداد المعمارية لتشغيل إجراء الربط.
  
 
== المقدمة ==
 
== المقدمة ==
يقوم كابل العمل بدمج تطبيقات WebSockets مع باقي تطبيق Rails بسلاسة. يسمح لكتابة الميزات في الوقت الحقيقي في روبي بنفس الأسلوب والشكل كبقية تطبيق Rails، مع الاستمرار في الأداء وقابلية التطوير. إنه عرض كامل يوفر كلاً من إطار عمل JavaScript من جانب العميل وإطار عمل Ruby من جانب الخادم. لديك حق الوصول إلى نموذج المجال الكامل الخاص بك المكتوب مع Active Record أو ORM الخاص بك في الاختيار.
+
يدمج إجراء الربط مقابس الويب [[wikipedia:WebSocket|WebSockets]] مع باقي تطبيق ريلز بسلاسة. يسمح ذلك بكتابة الميزات في الوقت الحقيقي في روبي بنفس الأسلوب والشكل كبقية تطبيقات ريلز، مع الاستمرار في الأداء وقابلية التطوير. إنه عرض كامل يوفر كلًا من إطار عمل [[JavaScript]] من جانب العميل وإطار عمل روبي من جانب الخادم. لديك حق الوصول إلى نموذج المجال الكامل الخاص بك المكتوب مع [[Rails/active record basics|السجل الفعال]] أو تقنية ORM الخاص بك في الاختيار.
  
 
== ماهو Pub/Sub ==
 
== ماهو Pub/Sub ==
يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى فئة مجردة من المستلمين (المشتركين) دون تحديد المستلمين الفرديين. يستخدم كابل العمل هذا الأسلوب للتواصل بين الخادم والعديد من العملاء.
+
يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى صنف مجرد من المستلمين (المشتركين) دون تحديد مستلمين فرديين. يستخدم إجراء الربط هذا الأسلوب للتواصل بين الخادم والعديد من العملاء.
  
== مكونات جانب - الخادم ==
+
== مكونات من جانب الخادم ==
  
=== الإتصالات ===
+
=== الاتصالات ===
تشكل الاتصالات أساس العلاقة بين العميل والخادم. لكل WebSocket التي قبلت من قبل الخادم، تُنشأ نسخة من كائن الاتصال. يصبح هذا الكائن أصل كل اشتراكات القناة التي أُنشأت من هناك. لا يتعامل الاتصال نفسه مع أي منطق تطبيق معين يتجاوز الاستيثاق والترخيص. يسمى عميل اتصال WebSocket مستهلك الاتصال. سينشئ مستخدم فردي زوجًا واحدًا للمستهلك للاتصال في كل علامة تبويب أو نافذة أو جهاز يفتحه المتصفح.
+
تشكل الاتصالات أساس العلاقة بين العميل والخادم. لكل مقبس ويب WebSocket مقبول من قبل الخادم، تُنشأ نسخة من كائن الاتصال. يصبح هذا الكائن الأب لكل اشتراكات القناة (channel subscriptions) التي أُنشأت من هناك. لا يتعامل الاتصال نفسه مع أي شيفرة تطبيق معين يتجاوز الاستيثاق والترخيص. يسمى عميل اتصال مقبس الويب WebSocket مستهلك الاتصال (connection consumer). سينشئ مستخدم فردي زوجًا واحدًا لمستهلك الاتصال في كل لسان أو نافذة أو جهاز يفتحه المتصفح.
  
الإتصالات هي نُسخ ApplicationCable :: Connection. في هذه الفئة، تسمح بالاتصال الوارد، وتشرع في تأسيسه إذا كان من الممكن التعرف على المستخدم.
+
الاتصالات هي نُسخ من <code>ApplicationCable::Connection</code>. في هذا الصنف، أنت تسمح بالاتصال الوارد، وتشرع في تأسيسه إذا كان من الممكن التعرف على المستخدم.
  
==== إعدادات الإتصال ====
+
==== إعدادات الاتصال ====
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/application_cable/connection.rb
+
# app/channels/application_cable/connection.rb
 
 
 
module ApplicationCable
 
module ApplicationCable
 
+
  class Connection < ActionCable::Connection::Base
 class Connection < ActionCable::Connection::Base
+
    identified_by :current_user
 
+
   identified_by :current_user
+
    def connect
 
+
      self.current_user = find_verified_user
   def connect
+
    end
 
+
     self.current_user = find_verified_user
+
    private
 
+
      def find_verified_user
   end
+
        if verified_user = User.find_by(id: cookies.encrypted[:user_id])
 
+
          verified_user
   private
+
        else
 
+
          reject_unauthorized_connection
     def find_verified_user
+
        end
 
+
      end
       if verified_user = User.find_by(id: cookies.encrypted[:user_id])
+
  end
 
+
end
         verified_user
 
 
 
       else
 
 
 
         reject_unauthorized_connection
 
 
 
       end
 
 
 
     end
 
 
 
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
هنا ident_by هو معرف اتصال يمكن استخدامه للعثور على اتصال محدد في وقت لاحق. لاحظ أن أي علامة مُيزت كمعرف تُنشأ تلقائيًا مفوَّض بنفس الاسم على أي نُسخ قناة أُنشأت خارج الاتصال.
+
يكون <code>ident_by</code> هنا هو معرف اتصال يمكن استخدامه للعثور على اتصال محدد في وقت لاحق. لاحظ أن أي شيء مُيز كمعرف سيُنشِئ تلقائيًا مفوَّضًا (delegate) بنفس الاسم على أي نُسخة قناة أُنشأت خارج الاتصال.
  
يعتمد هذا المثال على حقيقة أنك ستتولى بالفعل استيثاق المستخدم في مكان آخر في التطبيق الخاص بك، وأن استيثاق ناجح يُعين ملف تعريف ارتباط موقّع عليه معرف المستخدم.
+
يعتمد هذا المثال على حقيقة أنك ستتولى بالفعل الاستيثاق من المستخدم في مكان آخر في التطبيق الخاص بك، ويُعيِّن ذلك الاستيثاق الناجح ملف تعريف ارتباط موقّع مع معرف المستخدم.
  
ثم يرسل ملف تعريف الارتباط تلقائيًا إلى نسخة الاتصال عند محاولة إجراء اتصال جديد، ويمكنك استخدام ذلك في تعيين current_user. من خلال تحديد الاتصال بواسطة هذا المستخدم الحالي نفسه، فإنك أيضًا تتأكد من أنه يمكنك في وقت لاحق استرداد جميع الاتصالات المفتوحة من قبل مستخدم معين (ومن المحتمل فصلها كلها إذا حذف المستخدم أو كان غير مصرح به).
+
بعد ذلك، يُرسَل ملف تعريف الارتباط تلقائيًا إلى نسخة الاتصال عند محاولة إجراء اتصال جديد، ويمكنك استخدام ذلك من تعيين <code>current_user</code>. من خلال تحديد الاتصال بواسطة هذا المستخدم الحالي نفسه، فإنك أيضًا تتأكد من أنه يمكنك في وقت لاحق استرداد جميع الاتصالات المفتوحة من قبل مستخدم معين (ومن المحتمل فصلها كلها إذا حذف المستخدم أو كان غير مصرح به).
  
 
=== القنوات ===
 
=== القنوات ===
تغلف القناة وحدة منطقية من العمل، مشابهة لما تفعله وحدة التحكم في إعداد MVC عادي. بشكل افتراضي، ينشئ Rails فئة الأصل ApplicationCable :: Channel لتغليف منطق مشترك بين قنواتك.
+
تغلف القناة وحدة منطقية من العمل، مشابهة لما تفعله وحدة التحكم في إعداد MVC عادي. بشكل افتراضي، ينشئ ريلز الصنف الأب <code>ApplicationCable::Channel</code> لتغليف شيفرة مشتركة بين قنواتك.
  
 
==== إعداد القناة الأصل ====
 
==== إعداد القناة الأصل ====
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/application_cable/channel.rb
+
# app/channels/application_cable/channel.rb
 
 
 
module ApplicationCable
 
module ApplicationCable
 
+
  class Channel < ActionCable::Channel::Base
 class Channel < ActionCable::Channel::Base
+
  end
 
+
end
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
ثم يمكنك إنشاء فئات قناتك الخاصة. على سبيل المثال، قد يكون لديك ChatChannel و AppearanceChannel:
+
ثم يمكنك إنشاء أصناف قناتك (channel classes) الخاصة. على سبيل المثال، قد يكون لديك <code>ChatChannel</code> و <code>AppearanceChannel</code>:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/chat_channel.rb
+
# app/channels/chat_channel.rb
 
 
 
class ChatChannel < ApplicationCable::Channel
 
class ChatChannel < ApplicationCable::Channel
 
 
end
 
end
 
+
<nowiki>#</nowiki> app/channels/appearance_channel.rb
+
# app/channels/appearance_channel.rb
 
 
 
class AppearanceChannel < ApplicationCable::Channel
 
class AppearanceChannel < ApplicationCable::Channel
 
+
end
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
سطر 98: سطر 76:
  
 
==== الاشتراكات ====
 
==== الاشتراكات ====
يشترك المستهلكون في القنوات، كمشتركين. اتصالهم يسمى الاشتراك. ثم توجه الرسائل التي أُنتجت إلى اشتراكات القنوات هذه استنادًا إلى معرّف أُرسل بواسطة مستهلك الكبل.
+
يشترك المستهلكون في القنوات، كمشتركين (subscribers). اتصالهم يسمى «الاشتراك» (subscription). ثم توجه الرسائل التي أُنتجت إلى اشتراكات القنوات هذه استنادًا إلى معرّف أُرسل بواسطة مستهلك الوصل (cable consumer).
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/chat_channel.rb
+
# app/channels/chat_channel.rb
 
 
 
class ChatChannel < ApplicationCable::Channel
 
class ChatChannel < ApplicationCable::Channel
 
+
  # يُستدعى عندما يصبح المستهلك مشتركًا بهذه القناة
 # Called when the consumer has successfully
+
  def subscribed
 
+
  end
 # become a subscriber to this channel.
+
end
 
 
 def subscribed
 
 
 
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== مكونات جانب - العميل ==
+
== مكونات من جانب العميل ==
  
=== الإتصالات ===
+
=== الاتصالات ===
يحتاج المستهلكون إلى نسخة من الاتصال على جانبهم. ينشأ هذا باستخدام JavaScript التالي، والذي أُنشأ افتراضيًا بواسطة Rails:
+
يحتاج المستهلكون إلى نسخة من الاتصال على جانبهم. ينشأ هذا باستخدام شيفرة [[JavaScript]] التالية، والتي تُولَّد افتراضيًا بواسطة ريلز:
  
 
==== مستهلك الاتصال ====
 
==== مستهلك الاتصال ====
<syntaxhighlight lang="rails">
+
<syntaxhighlight lang="javascript">
 
// app/assets/javascripts/cable.js
 
// app/assets/javascripts/cable.js
 
 
//= require action_cable
 
//= require action_cable
 
 
//= require_self
 
//= require_self
 
 
//= require_tree ./channels
 
//= require_tree ./channels
 
+
 
(function() {
 
(function() {
 
+
  this.App || (this.App = {});
 this.App || (this.App = {});
+
 
+
  App.cable = ActionCable.createConsumer();
 App.cable = ActionCable.createConsumer();
 
 
 
 
}).call(this);
 
}).call(this);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
هذا سوف يعد المستهلك الذي سيتصل /cable على الخادم الخاص بك بشكل افتراضي. لن ينشأ الاتصال حتى تحدد أيضًا اشتراكًا واحدًا على الأقل ترغب في الحصول عليه.
+
هذا سوف يُجهِّز مستهلكًا سيتصل بـ ‎/cable على الخادم الخاص بك بشكل افتراضي. لن يُنشَأ الاتصال حتى تحدد أيضًا اشتراكًا واحدًا على الأقل ترغب في الحصول عليه.
  
 
==== المشترك ====
 
==== المشترك ====
 
يصبح المستهلك مشتركًا عن طريق إنشاء اشتراك لقناة معينة:
 
يصبح المستهلك مشتركًا عن طريق إنشاء اشتراك لقناة معينة:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/chat.coffee
+
# app/assets/javascripts/cable/subscriptions/chat.coffee
 
 
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" }
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" }
 +
 +
# app/assets/javascripts/cable/subscriptions/appearance.coffee
 +
App.cable.subscriptions.create { channel: "AppearanceChannel" }
  
<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/appearance.coffee
 
 
App.cable.subscriptions.create { channel: "AppearanceChannel" }
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
بينما يقوم هذا بإنشاء الاشتراك، ستوصف الوظيفة المطلوبة للرد على البيانات المستلمة في وقت لاحق.
+
بينما يُنشِئ هذا الاشتراك، ستوصف الوظيفة المطلوبة للرد على البيانات المستلمة في وقت لاحق.
  
 
يمكن للمستهلك التصرف كمشترك في قناة معينة في أي عدد من المرات. على سبيل المثال، يمكن للمستهلك الاشتراك في غرف دردشة متعددة في نفس الوقت:
 
يمكن للمستهلك التصرف كمشترك في قناة معينة في أي عدد من المرات. على سبيل المثال، يمكن للمستهلك الاشتراك في غرف دردشة متعددة في نفس الوقت:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "1st Room" }
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "1st Room" }
 
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "2nd Room" }
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "2nd Room" }
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== تفاعلات الخادم - العميل ==
+
== تفاعلات الخادم والعميل ==
  
=== التدفقات ===
+
=== المجاري ===
التدفقات توفر الآلية التي من خلالها مسار القنوات تنشر المحتوى (البث) لمشتركيهم.
+
توفر المجاري آلية توجه القنوات عبرها المحتوى المنشور (البث) لجميع المشتركين في ذلك المجرى.
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/chat_channel.rb
+
# app/channels/chat_channel.rb
 
 
 
class ChatChannel < ApplicationCable::Channel
 
class ChatChannel < ApplicationCable::Channel
 
+
  def subscribed
 def subscribed
+
    stream_from "chat_#{params[:room]}"
 
+
  end
   stream_from "chat_#{params[:room]}"
+
end
 
 
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
إذا كان لديك تدفق مرتبط بنموذج، فيمكن إنشاء البث المستخدم من النموذج والقناة. سوف يشترك المثال التالي في بث مثل التعليقات: Z2lkOi8vVGVzdEFwcC9Qb3N0LzE
+
إذا كان لديك مجرًى مرتبطًا بنموذج، فيمكن توليد البث المستخدم من النموذج والقناة. سوف يشترك المثال التالي في بث مثل comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
 
class CommentsChannel < ApplicationCable::Channel
 
class CommentsChannel < ApplicationCable::Channel
 
+
  def subscribed
 def subscribed
+
    post = Post.find(params[:id])
 
+
    stream_for post
   post = Post.find(params[:id])
+
  end
 
+
end
   stream_for post
 
 
 
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
سطر 200: سطر 154:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=== الإذاعة Broadcasting ===
+
=== البث (Broadcasting) ===
 
البث هو رابط pub / sub حيث يوجه أي شيء أُرسل من قبل ناشر مباشرة إلى المشتركين في القناة الذين يقومون ببث تلك الإذاعة المسماة. يمكن لكل قناة أن تبث بثًا أو أكثر من بث.
 
البث هو رابط pub / sub حيث يوجه أي شيء أُرسل من قبل ناشر مباشرة إلى المشتركين في القناة الذين يقومون ببث تلك الإذاعة المسماة. يمكن لكل قناة أن تبث بثًا أو أكثر من بث.
  
الإذاعة هي طابور على الإنترنت تعتمد على الوقت. إذا كان المستهلك لا يجري بثًا (اشترك في قناة معينة)، فلن يحصل على البث إذا اتصل به لاحقًا.
+
البث هو طابور على الإنترنت يعتمد على الوقت. إذا كان المستهلك لا يجري بثًا (اشترك في قناة معينة)، فلن يحصل على البث إذا اتصل به لاحقًا.
  
تسمى عمليات البث في مكان آخر في تطبيق Rails:
+
تُستدعَى عمليات البث في أي مكان آخر في تطبيق ريلز:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
 
WebNotificationsChannel.broadcast_to(
 
WebNotificationsChannel.broadcast_to(
 
+
  current_user,
 current_user,
+
  title: 'New things!',
 
+
  body: 'All the news fit to print'
 title: 'New things!',
 
 
 
 body: 'All the news fit to print'
 
 
 
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
يجري اتصال WebNotificationsChannel.broadcast_to بوضع رسالة في قائمة انتظار الاشتراك في محول الاشتراك الحالي (بشكل افتراضي redis للإنتاج و التزامن لبيئات التطوير والاختبار) تحت اسم بث منفصل لكل مستخدم. بالنسبة لمستخدم ذي معرف 1، سيكون اسم البث web_notifications: 1.
+
يضع الاستدعاء <code>WebNotificationsChannel.broadcast_to</code> رسالةً في قائمة انتظار الاشتراك في محول الاشتراك الحالي (بشكل افتراضي redis للإنتاج و التزامن لبيئات التطوير والاختبار) تحت اسم بث منفصل لكل مستخدم. بالنسبة لمستخدم ذي المعرف 1، سيكون اسم البث <code>web_notifications:1</code>.
  
توجه القناة لبث كل شيء يصل إلى web_notifications: 1 مباشرة إلى العميل عن طريق استدعاء رد الاتصال المتلقاة.
+
توجه القناة لبث كل شيء يصل إلى <code>web_notifications:1</code> مباشرة إلى العميل عن طريق استدعاء رد النداء <code>received</code>.
  
 
=== الاشتراكات ===
 
=== الاشتراكات ===
عندما يشترك المستهلك في قناة ، يكون بمثابة مشترك. هذا الاتصال يسمى الاشتراك. ثم توجه الرسائل الواردة إلى اشتراكات القنوات هذه استنادًا إلى مُعرّف أُرسل بواسطة مستهلك الكبل.
+
عندما يشترك المستهلك في قناة، يكون بمثابة مشترك (subscriber). هذا الاتصال يسمى الاشتراك (subscription). ثم توجه الرسائل الواردة إلى اشتراكات القنوات هذه استنادًا إلى مُعرّف أُرسل بواسطة مستهلك الربط (cable consumer).
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/chat.coffee
+
# app/assets/javascripts/cable/subscriptions/chat.coffee
 
+
# افترض أن طلبت مسبقًا الإذن لإرسال تنبيهات ويب
<nowiki>#</nowiki> Assumes you've already requested the right to send web notifications
 
 
 
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
+
  received: (data) ->
 received: (data) ->
+
    @appendLine(data)
 
+
   @appendLine(data)
+
  appendLine: (data) ->
 
+
    html = @createLine(data)
 appendLine: (data) ->
+
    $("[data-chat-room='Best Room']").append(html)
 
+
   html = @createLine(data)
+
  createLine: (data) ->
 
+
    """
   $("[data-chat-room='Best Room']").append(html)
+
    <article class="chat-line">
 
+
      <span class="speaker">#{data["sent_by"]}</span>
 createLine: (data) ->
+
      <span class="body">#{data["body"]}</span>
 
+
    </article>
   """
+
    """
 
 
   <article class="chat-line">
 
 
 
     <nowiki><span class="speaker">#{data["sent_by"]}</span></nowiki>
 
 
 
     <nowiki><span class="body">#{data["body"]}</span></nowiki>
 
 
 
   </article>
 
 
 
   """
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
=== تمرير المعاملات إلى القنوات ===
 
=== تمرير المعاملات إلى القنوات ===
يمكنك تمرير المعاملات من جانب العميل إلى جانب الخادم عند إنشاء اشتراك. فمثلا:
+
يمكنك تمرير المعاملات من جانب العميل إلى جانب الخادم عند إنشاء اشتراك. فمثلًا:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/chat_channel.rb
+
# app/channels/chat_channel.rb
 
 
 
class ChatChannel < ApplicationCable::Channel
 
class ChatChannel < ApplicationCable::Channel
 
+
  def subscribed
 def subscribed
+
    stream_from "chat_#{params[:room]}"
 
+
  end
   stream_from "chat_#{params[:room]}"
+
end
 
 
 end
 
 
 
End
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
يصبح الكائن الذي مُرر ليكون الوسيطة الأولى إلى subscriptions.create تجزئة params في قناة الكبل. الكلمة الرئيسية channel مطلوبة:
+
يصبح الكائن الذي مُرر ليكون الوسيط الأول إلى <code>subscriptions.create</code> المعاملات <code>params</code> (التي هي جدول Hash) في قناة الربط (cable channel). الكلمة المفتاحية <code>channel</code> مطلوبة:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/chat.coffee
+
# app/assets/javascripts/cable/subscriptions/chat.coffee
 
 
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
+
  received: (data) ->
 received: (data) ->
+
    @appendLine(data)
 
+
   @appendLine(data)
+
  appendLine: (data) ->
 
+
    html = @createLine(data)
 appendLine: (data) ->
+
    $("[data-chat-room='Best Room']").append(html)
 
+
   html = @createLine(data)
+
  createLine: (data) ->
 
+
    """
   $("[data-chat-room='Best Room']").append(html)
+
    <article class="chat-line">
 
+
      <span class="speaker">#{data["sent_by"]}</span>
 createLine: (data) ->
+
      <span class="body">#{data["body"]}</span>
 
+
    </article>
   """
+
    """
 
+
</syntaxhighlight><syntaxhighlight lang="rails">
   <article class="chat-line">
+
# يُستدعَى هذا في مكان ما في تطبيقك
 
+
# NewCommentJob ربما من
     <nowiki><span class="speaker">#{data["sent_by"]}</span></nowiki>
 
 
 
     <nowiki><span class="body">#{data["body"]}</span></nowiki>
 
 
 
   </article>
 
 
 
   """
 
 
 
<nowiki>#</nowiki> Somewhere in your app this is called, perhaps
 
 
 
<nowiki>#</nowiki> from a NewCommentJob.
 
 
 
 
ActionCable.server.broadcast(
 
ActionCable.server.broadcast(
 
+
  "chat_#{room}",
 "chat_#{room}",
+
  sent_by: 'Paul',
 
+
  body: 'This is a cool chat app.'
 sent_by: 'Paul',
 
 
 
 body: 'This is a cool chat app.'
 
 
 
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=== إعادة إرسال رسالة ===
+
=== إعادة بث رسالة ===
حالة الاستخدام الشائعة هي إعادة إرسال رسالة أُرسلت بواسطة عميل واحد إلى أي عملاء آخرين متصلين.
+
حالة الاستخدام الشائعة هي إعادة رب (rebroadcast) رسالة أُرسلت بواسطة عميل واحد إلى أي عملاء آخرين متصلين.
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
<nowiki>#</nowiki> app/channels/chat_channel.rb
+
# app/channels/chat_channel.rb
 
 
 
class ChatChannel < ApplicationCable::Channel
 
class ChatChannel < ApplicationCable::Channel
 
+
  def subscribed
 def subscribed
+
    stream_from "chat_#{params[:room]}"
 
+
  end
   stream_from "chat_#{params[:room]}"
+
 
+
  def receive(data)
 end
+
    ActionCable.server.broadcast("chat_#{params[:room]}", data)
 
+
  end
 def receive(data)
+
end
 
+
</syntaxhighlight><syntaxhighlight lang="rails">
   ActionCable.server.broadcast("chat_#{params[:room]}", data)
+
# app/assets/javascripts/cable/subscriptions/chat.coffee
 
 
 end
 
 
 
End
 
 
 
<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/chat.coffee
 
 
 
 
App.chatChannel = App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
App.chatChannel = App.cable.subscriptions.create { channel: "ChatChannel", room: "Best Room" },
 
+
  received: (data) ->
 received: (data) ->
+
    # data => { sent_by: "Paul", body: "This is a cool chat app." }
 
+
   # data => { sent_by: "Paul", body: "This is a cool chat app." }
 
 
 
 
App.chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })
 
App.chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })
</syntaxhighlight>
+
</syntaxhighlight>سيُستلَم إعادة البث من قبل جميع العملاء المتصلين، بما في ذلك العميل الذي أرسل الرسالة. لاحظ أن <code>params</code> هي نفسها كما كانت عند الاشتراك في القناة.
 
 
سيتلقى إعادة البث من قبل جميع العملاء المتصلين، بما في ذلك العميل الذي أرسل الرسالة. لاحظ أن params هي نفسها كما كانت عند الاشتراك في القناة.
 
 
 
== أمثلة Full-Stack ==
 
خطوات الإعداد التالية شائعة في كلا المثالين:
 
 
 
1 - إعداد الإتصال الخاص بك.
 
 
 
2 - إعداد قناتك الأصل.
 
  
3 - الإتصال بالمستهلك.
+
== أمثلة كاملة ==
 +
خطوات الإعداد التالية متماثلة في كلا المثالين:
 +
# إعداد الإتصال الخاص بك.
 +
# إعداد قناتك الأصل.
 +
# الإتصال بالمستهلك.
  
 
=== مثال 1: ظهور المستخدم ===
 
=== مثال 1: ظهور المستخدم ===
سطر 535: سطر 436:
  
 
=== المزيد من الأمثلة الكاملة ===
 
=== المزيد من الأمثلة الكاملة ===
راجع مستودع rails / actioncable-examples لمثال كامل عن كيفية إعداد كابل الإجراء في تطبيق Rails وإضافة قنوات.
+
راجع مستودع ريلز / actioncable-examples لمثال كامل عن كيفية إعداد كابل الإجراء في تطبيق ريلز وإضافة قنوات.
  
 
== إعدادات التكوين ==
 
== إعدادات التكوين ==
سطر 541: سطر 442:
  
 
=== محول الاشتراك ===
 
=== محول الاشتراك ===
بشكل افتراضي، يبحث Action Cable عن ملف تكوين في config / cable.yml. يجب أن يحدد الملف محولًا لكل بيئة Rails. انظر قسم التبعيات للحصول على معلومات إضافية حول المحولات.
+
بشكل افتراضي، يبحث Action Cable عن ملف تكوين في config / cable.yml. يجب أن يحدد الملف محولًا لكل بيئة ريلز. انظر قسم التبعيات للحصول على معلومات إضافية حول المحولات.
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
 
development:
 
development:
سطر 603: سطر 504:
  
 
=== في التطبيق ===
 
=== في التطبيق ===
يمكن تشغيل كبل الإجراء مع تطبيق Rails الخاص بك. على سبيل المثال، للاستماع لطلبات WebSocket على / websocket، حدد ذلك المسار إلى config.action_cable.mount_path:
+
يمكن تشغيل كبل الإجراء مع تطبيق ريلز الخاص بك. على سبيل المثال، للاستماع لطلبات WebSocket على / websocket، حدد ذلك المسار إلى config.action_cable.mount_path:
 
<syntaxhighlight lang="rails">
 
<syntaxhighlight lang="rails">
 
<nowiki>#</nowiki> config/application.rb
 
<nowiki>#</nowiki> config/application.rb
سطر 648: سطر 549:
  
 
== التبعيات ==
 
== التبعيات ==
يوفر "كبل الإجراء" واجهة محول اشتراك لمعالجة عمليات pubsub الداخلية الخاصة به. بشكل افتراضي، تتضمن محولات غير متزامنة و مضمنة و PostgreSQL و Redis. المحول الافتراضي في تطبيقات Rails جديد هو محول غير متزامن (async).
+
يوفر "كبل الإجراء" واجهة محول اشتراك لمعالجة عمليات pubsub الداخلية الخاصة به. بشكل افتراضي، تتضمن محولات غير متزامنة و مضمنة و PostgreSQL و Redis. المحول الافتراضي في تطبيقات ريلز جديد هو محول غير متزامن (async).
  
 
تم بناء جانب روبي من الأشياء على قمة websocket-driver، nio4r، and conjurrent-ruby.
 
تم بناء جانب روبي من الأشياء على قمة websocket-driver، nio4r، and conjurrent-ruby.
  
 
== النشر ==
 
== النشر ==
يعمل كبل الاجراء من خلال مزيج من WebSockets و threads. يتعامل مع كل من أعمال أنابيب الإطار وعمل القناة المحددة من قبل المستخدم داخليًا من خلال الاستفادة من دعم روبي الأصلي. هذا يعني أنه يمكنك استخدام جميع نماذج Rails المنتظمة الخاصة بك دون أي مشكلة، طالما أنك لم ترتكب أي خطأ في سلامة الصفحات.
+
يعمل كبل الاجراء من خلال مزيج من WebSockets و threads. يتعامل مع كل من أعمال أنابيب الإطار وعمل القناة المحددة من قبل المستخدم داخليًا من خلال الاستفادة من دعم روبي الأصلي. هذا يعني أنه يمكنك استخدام جميع نماذج ريلز المنتظمة الخاصة بك دون أي مشكلة، طالما أنك لم ترتكب أي خطأ في سلامة الصفحات.
  
 
يقوم خادم كبل الاجراء بتنفيذ اختطاف حامل المقبس لواجهة برمجة تطبيقات، مما يسمح باستخدام نمط مؤشرات ترابط متعددة لإدارة الاتصالات داخليًا، بغض النظر عن ما إذا كان خادم التطبيق متعدد الخيوط أم لا.
 
يقوم خادم كبل الاجراء بتنفيذ اختطاف حامل المقبس لواجهة برمجة تطبيقات، مما يسمح باستخدام نمط مؤشرات ترابط متعددة لإدارة الاتصالات داخليًا، بغض النظر عن ما إذا كان خادم التطبيق متعدد الخيوط أم لا.
سطر 660: سطر 561:
  
 
== مصادر ==
 
== مصادر ==
* [https://guides.rubyonrails.org/action_cable_overview.html صفحة Action Cable Overview في توثيق Ruby On Rails الرسمي.]
+
* [https://guides.rubyonrails.org/action_cable_overview.html صفحة Action Cable Overview في توثيق Ruby On ريلز الرسمي.]
 
[[تصنيف:Rails]]
 
[[تصنيف:Rails]]
 
[[تصنيف:Rails Digging Deeper]]
 
[[تصنيف:Rails Digging Deeper]]

مراجعة 19:09، 16 مارس 2019

ستتعرف في هذا الدليل على كيفية عمل إجراء الربط (Action Cable) وكيفية استخدام WebSockets لدمج ميزات الوقت الفعلي في تطبيق ريلز.

بعد قراءة هذا الدليل، ستتلعم:

  • ماهية إجراء الربط وكيفية دمج الواجهة الخلفية والأمامية الخاصة به.
  • كيفية إعداد إجراء الربط (Action Cable).
  • كيفية إعداد القنوات.
  • النشر وإعداد المعمارية لتشغيل إجراء الربط.

المقدمة

يدمج إجراء الربط مقابس الويب WebSockets مع باقي تطبيق ريلز بسلاسة. يسمح ذلك بكتابة الميزات في الوقت الحقيقي في روبي بنفس الأسلوب والشكل كبقية تطبيقات ريلز، مع الاستمرار في الأداء وقابلية التطوير. إنه عرض كامل يوفر كلًا من إطار عمل JavaScript من جانب العميل وإطار عمل روبي من جانب الخادم. لديك حق الوصول إلى نموذج المجال الكامل الخاص بك المكتوب مع السجل الفعال أو تقنية ORM الخاص بك في الاختيار.

ماهو Pub/Sub

يشير Pub / Sub أو Publish-Subscribe إلى نموذج قائمة انتظار الرسائل حيث يرسل مرسلو المعلومات (الناشرون) البيانات إلى صنف مجرد من المستلمين (المشتركين) دون تحديد مستلمين فرديين. يستخدم إجراء الربط هذا الأسلوب للتواصل بين الخادم والعديد من العملاء.

مكونات من جانب الخادم

الاتصالات

تشكل الاتصالات أساس العلاقة بين العميل والخادم. لكل مقبس ويب 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. إعداد الإتصال الخاص بك.
  2. إعداد قناتك الأصل.
  3. الإتصال بالمستهلك.

مثال 1: ظهور المستخدم

في ما يلي مثال بسيط لقناة تتعقب ما إذا كان المستخدم متصلاً أم لا وما هي الصفحة التي يستخدمونها. (يفيد ذلك في إنشاء ميزات التواجد مثل إظهار نقطة خضراء بجانب اسم المستخدم إذا كان متصلاً بالإنترنت).

إنشاء قناة تظهر جانب الخادم:

<nowiki>#</nowiki> 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

عند بدء الاشتراك، يلغى الاتصال المشترك، وننتهز هذه الفرصة لنقول "لقد ظهر المستخدم الحالي بالفعل". يمكن دعم واجهة برمجة التطبيقات التي تظهر / تختفي بواسطة Redis أو قاعدة بيانات أو أي شيء آخر.

إنشاء اشتراك قناة تظهر العميل:

<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/appearance.coffee

App.cable.subscriptions.create "AppearanceChannel",

 # Called when the subscription is ready for use on the server.

 connected: ->

   @install()

   @appear()

 # Called when the WebSocket connection is closed.

 disconnected: ->

   @uninstall()

 # Called when the subscription is rejected by the server.

 rejected: ->

   @uninstall()

 appear: ->

   # Calls `AppearanceChannel#appear(data)` on the server.

   @perform("appear", appearing_on: $("main").data("appearing-on"))

 away: ->

   # Calls `AppearanceChannel#away` on the server.

   @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 - يتعرف الخادم على بدء اشتراك جديد لظهور القناة ويشغل الاستدعاء المشترك الخاص به، مع استدعاء طريقة الظهور على current_user.

(appearance_channel.rb)

4 - يدرك العميل أنه أُنشأ الإشتراك واستدعى appearance.coffe)  connected ) والتي بدورها تستدعي @install و appear@. و appear@ تستدعي  (AppearanceChannel#appear(data على الخادم. وتزود تجزئة البيانات من { appearing_on: $("main").data("appearing-on") }. هذا ممكن لأن طبقة القناة من جانب الخادم تكشف تلقائيًا كل التوابع العامة المعلنة في الفئة (ناقص عمليات الاسترجاعات)، بحيث يمكن الوصول إليها كإستدعاء إجراء بعيد عن طريق تابع perform الاشتراك.

5 - يتلقى الخادم طلب الإجراء appear في قناة الظهور الخاصة بالاتصال المحدد بواسطة (current_user (appearance_channel.rb. يسترد الخادم البيانات باستخدام المفتاح :appearing_on من تجزئة البيانات ويعينها كقيمة :on على المفتاح الذي يمرر إلى current_user.appear.

مثال 2: تلقي إشعارات ويب جديدة

كان المثال مظهر كل شيء عن تعريض وظائف الخادم إلى استدعاء العميل عبر اتصال WebSocket. ولكن الشيء العظيم في WebSockets هو أنه شارع ذو اتجاهين. لذا دعونا الآن نعرض مثالاً حيث يستدعي الخادم إجراءً على العميل.

هذه قناة إخبارية على الويب تسمح لك بتشغيل إشعارات الويب من جانب العميل عند البث إلى مجموعات البث الصحيحة:

إنشاء قناة إشعارات الويب من جانب الخادم:

<nowiki>#</nowiki> app/channels/web_notifications_channel.rb

class WebNotificationsChannel < ApplicationCable::Channel

 def subscribed

   stream_for current_user

 end

End

إنشاء اشتراك قناة إشعارات الويب من جانب العميل:

<nowiki>#</nowiki> app/assets/javascripts/cable/subscriptions/web_notifications.coffee

<nowiki>#</nowiki> Client-side which assumes you've already requested

<nowiki>#</nowiki> the right to send web notifications.

App.cable.subscriptions.create "WebNotificationsChannel",

 received: (data) ->

   new Notification data["title"], body: data["body"]

بث المحتوى إلى نسخة قناة إعلام عبر الإنترنت من مكان آخر في التطبيق الخاص بك:

<nowiki>#</nowiki> Somewhere in your app this is called, perhaps from a 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 الاتصال المتلقاة. البيانات التي تُمرر كوسيطة هي البعثرة المرسلة كمعامل ثاني لمكالمة البث من جانب الخادم، JSON تشفرها للرحلة عبر السلك وتفككها لوسيطة البيانات عند الوصول كـ received.

المزيد من الأمثلة الكاملة

راجع مستودع ريلز / actioncable-examples لمثال كامل عن كيفية إعداد كابل الإجراء في تطبيق ريلز وإضافة قنوات.

إعدادات التكوين

يحتوي "كبل الإجراء" على تهيئتين مطلوبتين: مهايئ اشتراك وأصول طلب مسموح بها.

محول الاشتراك

بشكل افتراضي، يبحث Action Cable عن ملف تكوين في config / cable.yml. يجب أن يحدد الملف محولًا لكل بيئة ريلز. انظر قسم التبعيات للحصول على معلومات إضافية حول المحولات.

development:

 adapter: async

test:

 adapter: async

production:

 adapter: redis

 url: <nowiki>redis://10.10.3.153:6381</nowiki>

 channel_prefix: appname_production

إعدادات تكوين محول

فيما يلي قائمة بمحولات الاشتراك المتاحة للمستخدمين النهائيين.

  • محول متزامن : المحول المتزامن هو من أجل التطوير / الاختبار ويجب عدم استخدامه في الإنتاج.
  • محول Redis : يتطلب محول Redis من المستخدمين توفير عنوان URL يشير إلى خادم Redis. بالإضافة إلى ذلك، قد يوفر channel_prefix لتجنب تضارب اسم القناة عند استخدام خادم Redis نفسه لتطبيقات متعددة. راجع وثائق Redis PubSub لمزيد من التفاصيل.
  • محول PostgreSQL : يستخدم محول PostgreSQL تجمع اتصال Active Record، وبالتالي تكوين قاعدة بيانات التكوين / database.yml للتطبيق، للاتصال به. هذا قد يتغير في المستقبل. # 27214

طلب اصول مسموح بها

يقبل كابل الإجراء فقط الطلبات من الأصول المحددة، والتي مُررت إلى تهيئة الخادم كمصفوفة. يمكن أن تكون الأصول عبارة عن نسخ من السلاسل أو التعبيرات العادية، والتي يقابلها إجراء فحص متطابق.

config.action_cable.allowed_request_origins = ['<nowiki>http://rubyonrails.com'</nowiki>, %r{[[about:blank|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 في ملفات تهيئة البيئة.

إعدادات تكوينات اخرى

الخيار المشترك الآخر للتكوين هو علامات التسجيل المطبقة على مسجل الاتصال. في ما يلي مثال يستخدم معرف حساب المستخدم إذا كان متاحًا، أو "بدون حساب" آخر أثناء وضع العلامات:

config.action_cable.log_tags = [

 -> request { request.env['user_account_id'] || "no-account" },

 :action_cable,

 -> request { request.uuid }

]

للحصول على قائمة كاملة بجميع خيارات التكوين، راجع فئة ActionCable :: Server :: Configuration.

لاحظ أيضًا أن الخادم الخاص بك يجب أن يوفر على الأقل نفس عدد اتصالات قاعدة البيانات كما تعمل لديك. يُعين حجم تجمع العامل الافتراضي إلى 4، وهذا يعني أن عليك إجراء ذلك على الأقل المتوفرة. يمكنك تغيير ذلك في config / database.yml من خلال سمة pool.

تشغيل خوادم الكابلات المستقلة

في التطبيق

يمكن تشغيل كبل الإجراء مع تطبيق ريلز الخاص بك. على سبيل المثال، للاستماع لطلبات WebSocket على / websocket، حدد ذلك المسار إلى config.action_cable.mount_path:

<nowiki>#</nowiki> config/application.rb

class Application < Rails::Application

 config.action_cable.mount_path = '/websocket'

End

يمكنك استخدام () App.cable = ActionCable.createConsumer للاتصال بملقم الكبل إذا استدعى action_cable_meta_tag في التخطيط.

يحدد مسار مخصص كوسيطة أولى createConsumer مثل

(("App.cable =ActionCable.createConsumer ( "/ websocket.

لكل نسخة من خادمك تنشأه ولأي عامل ينتج عن خادمك، سيكون لديك أيضًا نسخة جديدة من كبل اإجراء، ولكن استخدام Redis يبقي الرسائل متزامنة عبر الاتصالات.

مستقل

يمكن فصل خادم الكبل عن خادم التطبيق العادي. لا يزال تطبيق Rack، ولكنه تطبيق Rack الخاص به. الإعداد الأساسي الموصى به هو كما يلي:

<nowiki>#</nowiki> cable/config.ru

require_relative '../config/environment'

Rails.application.eager_load!

run ActionCable.server

ثم يبدأ الخادم باستخدام binstub في bin / cable ala:

<nowiki>#</nowiki>!/bin/bash

bundle exec puma -p 28080 cable/config.ru

ما ورد أعلاه سيبدأ خادم كابل على المنفذ 28080.

ملاحظات

لا يمتلك خادم WebSocket إمكانية الوصول إلى الجلسة، ولكن لديه حق الوصول إلى ملفات تعريف الارتباط. يمكن استخدام هذا عندما تحتاج إلى التعامل مع الاستيثاق. يمكنك رؤية طريقة واحدة للقيام بذلك باستخدام Devise في هذه المقالة.

التبعيات

يوفر "كبل الإجراء" واجهة محول اشتراك لمعالجة عمليات pubsub الداخلية الخاصة به. بشكل افتراضي، تتضمن محولات غير متزامنة و مضمنة و PostgreSQL و Redis. المحول الافتراضي في تطبيقات ريلز جديد هو محول غير متزامن (async).

تم بناء جانب روبي من الأشياء على قمة websocket-driver، nio4r، and conjurrent-ruby.

النشر

يعمل كبل الاجراء من خلال مزيج من WebSockets و threads. يتعامل مع كل من أعمال أنابيب الإطار وعمل القناة المحددة من قبل المستخدم داخليًا من خلال الاستفادة من دعم روبي الأصلي. هذا يعني أنه يمكنك استخدام جميع نماذج ريلز المنتظمة الخاصة بك دون أي مشكلة، طالما أنك لم ترتكب أي خطأ في سلامة الصفحات.

يقوم خادم كبل الاجراء بتنفيذ اختطاف حامل المقبس لواجهة برمجة تطبيقات، مما يسمح باستخدام نمط مؤشرات ترابط متعددة لإدارة الاتصالات داخليًا، بغض النظر عن ما إذا كان خادم التطبيق متعدد الخيوط أم لا.

وفقًا لذلك، تعمل شركة Action Cable مع خوادم شائعة مثل Unicorn و Puma و Passenger.

مصادر