Rails 我写了 WebSocket 和 ActionCable 相关的序列文章

hfpp2012 · 2016年05月05日 · 最后由 hfpp2012 回复于 2018年05月31日 · 10726 次阅读
本帖已被设为精华帖!

从 websocket 介绍开始,到 actioncable 的介绍,应用,最后到部署,一共写了 10 篇关于 websocket 的文章。

2017.09.02 把这些文章汇聚成了 gitbook 小书,地址是:https://websocket.rails365.net/

下面是目录:

1. websocket 之入门 (一)

2. websocket 之客户端与服务器端的交互 (二)

3. websocket 之客户端详解 (三)

4. websocket 之实现简易聊天室 (四)

5. websocket 之用 tubesock 在 rails 实现聊天室 (五)

6. websocket 之 message_bus(六)

7. websocket 之 actioncable 入门 (七)

8. websocket 之 actioncable 进阶 (八)

9. websocket 之 actioncable 实现重新连接功能 (九)

10. websocket 之部署 (十)

把第七篇列在 ruby-china 预览一下,如果有兴趣我也可以把每篇文章都发到 ruby-china 上。

websocket 之 actioncable 入门 (七)

1. 介绍

websocket 的序列文章重点要讲的就是actioncable,之前也讲了好多关于各种方式实现聊天室的文章,相信从中,也能学到好多关于 websocket 实践的知识和经验,这节要来讲讲 actioncable。

actioncable 是集成在 rails 5 中的一个功能,它能够轻易的在 rails 中使用 websocket。现在先把 actioncable 用起来,再慢慢研究其原理和特性。

2. 使用

还是跟先前的例子一样,建立一个聊天室。

2.1 聊天室界面

首先,rails 的版本必须得是 5 以上,写这篇文章的时候,rails 5 正式版还没有出来,目前的版本是 5.0.0.beta4。

$ rails new actioncable_demo
$ cd actioncable_demo

这样就生成了一个新项目。

接着创建 message 这个 model,存储聊天记录。

$ rails g model message content:text
$ rails db:migrate

创建聊天室的界面。

在 config/routes.rb 中添加路由。

Rails.application.routes.draw do
  get 'rooms/show'
end

创建 controller,添加app/controllers/rooms_controller.rb文件,内容如下:

class RoomsController < ApplicationController
  def show
    @messages = Message.all
  end
end

添加 view,添加app/views/rooms/show.html.erb文件,内容如下:

<h1>Chat room</h1>

<div id="messages">
  <%= render @messages %>
</div>

<form>
  <label>Say something:</label><br>
  <input type="text" data-behavior="room_speaker">
</form>

还有app/views/messages/_message.html.erb文件,内容如下:

<div class=“message”>
  <p><%= message.content %></p>
</div>

到目前为止,按照之前的经验,界面都建立好了,如下图所示:

2.2 开启 websocket

接下来,就是要来处理 websocket 部分。

先在客户端浏览器中开启 websocket 请求。

actioncable 默认提供了一个文件app/assets/javascripts/cable.coffee,把几行注释打开,就可以开启 websocket,内容如下:

#
#= require action_cable
#= require_self
#= require_tree ./channels
#
@App ||= {}
App.cable = ActionCable.createConsumer()

其实这些 js 的内容很简单,它做的主要的事情就是前面几篇文章所讲的在客户端浏览器执行new WebSocket,具体的内容可以查看其源码。

还要在路由中添加下面这行,把 websocket 服务以 engine 的方式挂载起来。

mount ActionCable.server => '/cable'

至此,websocket 已经开启了,可以通过 chrome 浏览器的开发者工具查看链接的信息,只要有 101 协议的信息,表示就是成功的。

2.3 channel

现在要让客户端和服务器端连接起来。

actioncable 提供了一个叫做channel的技术,中文名可以称为"通道"。actioncable 是一种pub/sub的架构,服务器通过 channel 发布消息,多个客户端通过对应的 channel 订阅消息,服务器能够广播消息给客户端,从而实现客户端和服务器端的交互。

先新建一个 channel。

$ rails g channel room speak

修改app/channels/room_channel.rb文件,内容如下:

class RoomChannel < ApplicationCable::Channel
  def subscribed
    stream_from "room_channel"
  end

  def unsubscribed
    # Any cleanup needed when channel is unsubscribed
  end

  def speak(data)
    # ActionCable.server.broadcast "room_channel", message: data['message']
    Message.create! content: data['message']
  end
end

其中定义了三个方法,分别是subscribedunsubscribedspeak

subscribedunsubscribed方法是默认就生成的,而speak是我们自己定义的。

subscribed表示的是当客户端连接上来的时候使用的方法。

unsubscribed表示的是当客户端与服务器失去连接的时候使用的方法。

还有,app/assets/javascripts/channels/room.coffee文件,内容如下:

App.room = App.cable.subscriptions.create "RoomChannel",
  connected: ->
    # Called when the subscription is ready for use on the server

  disconnected: ->
    # Called when the subscription has been terminated by the server

  received: (data) ->
    $('#messages').append data['message']
    # Called when there's incoming data on the websocket for this channel

  speak: (message) ->
    @perform 'speak', message: message

$(document).on 'keypress', '[data-behavior~=room_speaker]', (event) ->
  if event.keyCode is 13 # return = send
    App.room.speak event.target.value
    event.target.value = ""
    event.preventDefault()

App.room里定义了四个方法,除了speakconnecteddisconnectedreceived都是 actioncable 定义的。

这几个方法可以和RoomChannel里的方法对应起来,比如:

connectedsubscribed对应,表示客户端和服务器端连接之后的情况。

disconnectedunsubscribed对应,表示客户端和服务器端失去连接之后的情况。

received表示从服务器接收到信息之后的情况。因为服务器总是要向客户端推送信息的,接收完信息之后,就可以在这里进行一些页面上的操作,比如 DOM 更新等。

room.coffee文件中有重要的一行App.room.speak event.target.value,当键入聊天信息,一按回车键后,就会通过这行代码,把聊天信息,发送到后端服务器,并且会被room_channel.rb中的speak接收,执行Message.create! content: data['message']命令。

2.4 activejob

现在还没真正完成,还差一部分。

room.coffee文件中有一个received方法,它有一行指令$('#messages').append data['message']

这个表示当聊天信息发出时,会在聊天信息展示界面上添加聊天的内容。

现在来处理这个,我们通过 activejob 来处理,还记得之前的app/views/messages/_message.html.erb文件吗,现在要发挥它的作用。

先建立一个 job。

$ rails g job message_broadcast

修改app/jobs/message_broadcast_job.rb文件,内容如下:

class MessageBroadcastJob < ApplicationJob
  queue_as :default

  def perform(message)
    ActionCable.server.broadcast 'room_channel', message: render_message(message)
  end

  private
    def render_message(message)
      ApplicationController.renderer.render(partial: 'messages/message', locals: { message: message })
    end
end

还要在一个地方执行这个 job,是当创建完 message 的时候。

修改app/models/message.rb文件,内容如下:

class Message < ApplicationRecord
  after_create_commit { MessageBroadcastJob.perform_later self }
end

做完这一切,重启一下服务器。

现在来看下效果:

本篇完结。

下一篇: websocket 之 actioncable 进阶 (八)

已收藏,谢谢楼主

一上就加精了。赞

特来支持阁下👍

支持楼主,actioncable 很好

websocket 一直看的断断续续,楼主做的 6

rails 4 也可以用 actioncable 的呀。

#7 楼 @xiaohesong 以前可以的,不过那个 actioncable gem 被移除掉了,是空的 https://github.com/rails/actioncable rails 4 用 tubesock 也是一样的

#8 楼 @hfpp2012 前几天试了是可以的。archive 分支。

#9 楼 @xiaohesong 原来是在另外的分支,多谢告知

风神发的么

在下佩服。在下要好好跟随阁下的步伐

鸟兄 没事到处浪

我也要跟上了。进入 rails 5 fighting!

风神 到处浪

#13 楼 @matrixbirds 在下也佩服的五体投地 @hfpp2012 阁下人中龙风 在下一直很惦记

@hfpp2012 链接到 “websocket 之 actioncable 进阶 (八)“的地址有误,仍然是第七篇的地址。

20楼 已删除

不考虑性能,不用 activejob 也可以吧?

#21 楼 @thumbor 可以的呀,没有关系的

好文章,mark

雕堡了

Mark 了,有空拜读

最近也在使用 actioncable ,但是发现 actioncable 似乎没办法实现 socket.io 里比较简单的几个方法:

// sending to sender-client only
socket.emit('message', "this is a test");

// sending to all clients except sender
 socket.broadcast.emit('message', "this is a test");

// sending to individual socketid
 socket.broadcast.to(socketid).emit('message', 'for your eyes only');

不知道有无办法解决?

也就是说有什么办法能 perform 之后收到一个后端的返回?

好像只能在每个 perform 后带一个 uuid,后端接到后都 stream_from uuid,处理好结果后返回给 uuid,前端收到一次数据后断开

#26 楼 @xlaok 这个是可以实现的,我不懂 socket.io,如果我没理解错的话,这几条命令就是给规定的客户端广播消息

ActionCable.server.broadcast \
  "web_notifications_#{current_user.id}", { title: 'New things!', body: 'All the news that is fit to print' }

地址在这里:https://github.com/rails/rails/tree/master/actioncable#channel-example-2-receiving-new-web-notifications

其实也可以想一下 ruby-china 就知道了,你登录之后,在消息那里情况每个人肯定是不一样的,这个时候就是通过 current_user.id 来区别,也可以这样说,channel 就是可以接参数的,channel 就相当于一个个的房间,隔开消息的。

#27 楼 @xlaok 你下面这个问题我没有弄清楚你想表达的

#28 楼 @hfpp2012 对,但是这个实际上只是开了一个不同名字的 room 而已,如果要保证 每个 session,或者每个 request 独立,写起来是很别扭的(实际上真的遇到了这样的需求),而 socket.io 比较方便

#29 楼 @hfpp2012 下面问题的意思是:

前端调用

away: ->
    # Calls `AppearanceChannel#away` on the server
    @perform("away")

可以调用 AppearanceChannel#away ,但是调用之后,如果 AppearanceChannel#away 想再给这个 sender 回一个消息,就做不到了。

而 socket.io 可以这样

socket.on('records', function(sheet_id){
  records = Record.all
  //直接返回records给sender
  socket.emit('records', records);
});

actioncable 有办法这样做吗?

#31 楼 @xlaok 我明白你的意思了,这个是可以做到的,你先可以看这篇文章 http://www.rails365.net/articles/websocket-zhi-yong-tubesock-zai-rails-shi-xian-liao-tian-shi-wu

tubesock 这个 gem 可以很好的做到你说的需求,不过,actioncable 只是另一种实现,离不开本质问题

websocket 本质这是 tcp 协议,你只要能够将这个 socket 请求取出来,就用 write 方法写一些数据就可以了。

我在本地试了一下,我截图

之所以我会知道这个,是因为我查看了 actioncable 的源码,使用的主要命令就是

connection.env['rack.hijack_io']

返回的是 socket 文件描述符。

针对这个描述符进行 writer 操作就可以了,数据自然会返回给客户端。而不广播,是单一的。

Rails 5 还不敢用。。现在用 nodejs 的 ws 模块 + rabbitmq/redis pubsub 来做

@hfpp2012 楼主大大,你对 actioncable 的单元测试有没有经验?

点击链接发现 404

38 楼 thx

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册