聊一聊ActionCable背后的技术

Rails5中引入的可以实现实时通讯的新功能，ActionCable，可以说是这个版本的Rails的重大特性之一，ActionCable底层究竟是如何进行通讯，本文就来聊一聊这些相关的技术。

WebSocket

简单的说，websocket是一个基于TCP的应用层协议，使用http协议建立连接，并且能够通过一个已经建立的连接，进行双向的通讯，也就是不仅仅能够从客户端发送信息到服务器端，服务端还可以推送信息到客户端, 而且这一切的是建立在一个连接中进行的，有了它我们就不需要再使用，polling或long polling做轮询信息了。

它的通讯过程是，通过向http头添加特定信息，然后发送到服务器，如果服务器能够支持websocket的话，就会识别出http头中关于websocket的信息，并且升级http连接为websocket连接并返回，一个同样包含websocket头信息的http response，这样下来，客户端和服务器的连接就已经建立了，直到一方关闭连接。

请求：

GET /cable HTTP/1.1
Host: example.com:3000
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Version: 13

应答：

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=

上面的请求和应答头中 upgrade: websocket代表着这是一个websocket的连接请求，Sec-WebSocket-Key 和 Sec-WebSocket-Accept，是用于确认服务器是否真的，能够出来websocket请求的验证方式，过程是，服务器端介绍到websocket-key后，通过组合magic string，之后再进行SHA-1和 base64编码，然后以Sec-WebSocket-Accept返回给客户端，客户端接受到后验证正确，这就表明服务器真正的可以处理websocket请求了。

如何使用Websocket

ActionCable本身可以作为一个单独的服务，绑定到单独的端口上运行，也可以与rails一起在同一个端口上一起启动运行，这是因为它实际上是一个处理websocket的rack app。

单独启动的ActionCable Server，先加载Rails环境，然后再运行的rack app。

# cable/config.ru
require ::File.expand_path('../../config/environment', __FILE__)
Rails.application.eager_load!

run ActionCable.server

与Rails一同启动的时候，是通过挂载ActionCable.server到指定的PATH上。

# actioncable/lib/action_cable/engine.rb
    initializer "action_cable.routes" do
      config.after_initialize do |app|
        config = app.config
        unless config.action_cable.mount_path.nil?
          app.routes.prepend do
            mount ActionCable.server => config.action_cable.mount_path, internal: true
          end
        end
      end
    end

不管是，单独端口启动的ActionCable，或是与Rails一同启动的。它们实际都是用rack up作为统一入口的。

# actioncable/lib/action_cable/connection/base.rb
# Called by Rack to setup the server.
def call(env)
  setup_heartbeat_timer
  config.connection_class.call.new(self, env).process
end

call方法中第一是，每个三秒发送一个心跳包到客户端，已确定连接是否还可用，第二行就是初始化action-cable自己的连接类，执行响应。

# actioncable/lib/action_cable/connection/base.rb
def process #:nodoc:
  logger.info started_request_message

  if websocket.possible? && allow_request_origin?
    respond_to_successful_request
  else
    respond_to_invalid_request
  end
end

首先输出日志表示请求已经接受，然后判断请求是否为websocket，并且判断HTTP_ORIGIN是否允许。

# actioncable/lib/action_cable/connection/base.rb
def respond_to_successful_request
  logger.info successful_request_message # 输出日志：成功升级连接为 Websocket
  websocket.rack_response # 调用 websocket对象，返回websocket响应。
end

走到这一步，服务器端的连接已经确认是可以继续websocket通讯了，但是与客户端的握手还没有完成，还需要发送一个，验证服务器端接受并有能力处理websocket的信息给客户端。

可以从下面看出来，action-cable使用了Websocket-driver 这个Gem来完成websocket的通讯工作。

# actioncable/lib/action_cable/connection/web_socket.rb
require 'websocket/driver'

module ActionCable
  module Connection
    # Wrap the real socket to minimize the externally-presented API
    class WebSocket
      def initialize(env, event_target, event_loop, client_socket_class, protocols: ActionCable::INTERNAL[:protocols])
        @websocket = ::WebSocket::Driver.websocket?(env) ? client_socket_class.new(env, event_target, event_loop, protocols) : nil
      end

      def possible?
        websocket
      end

      def alive?
        websocket && websocket.alive?
      end

      def transmit(data)
        websocket.transmit data
      end

      def close
        websocket.close
      end

      def protocol
        websocket.protocol
      end

      def rack_response
        websocket.rack_response
      end

      protected
        attr_reader :websocket
    end
  end
end

# actioncable/lib/action_cable/connection/client_socket.rb

module ActionCable
  module Connection
    class ClientSocket
      def initialize(env, event_target, event_loop, protocols)
        ············
        @driver = ::WebSocket::Driver.rack(self, protocols: protocols)
        @driver.on(:open)    { |e| open }
        @driver.on(:message) { |e| receive_message(e.data) }
        @driver.on(:close)   { |e| begin_close(e.reason, e.code) }
        @driver.on(:error)   { |e| emit_error(e.message) }
        ············
      end
    end
  end
end

那么接下来就不得不讲一讲，websocket-driver 这个Gem了。

websocket-driver

简单的说，websocket-driver是一个利用，EventMachine，来读写socket-io对象的驱动器。使用了它的API就可以很轻松的实现websocket-server。

websocket-driver提供了一个基于rack的接口，action-cable就是使用这个接口进行通讯的。下面的代码通过一个socket代理对象，初始化一个driver，然后再向客户端发送一段信息。这里最重要的地方就是，被传入的socket代理对象，它必须能够响应三个方法，env，url，和write，分别是告诉driver 向哪个URL，如何发送信息。这里的 env 返回的就是rack app的env变量，webscoket-driver实际上就是利用Rack hijacking API 来实现获取socket-io对象进行读写的，所以action-cable基于websocket-driver就代表着像webrick这类不支持full hijacking API的应用程序服务器，也不能支持action-cable。

driver = WebSocket::Driver.rack(socket, options)
driver.text "I'm websocket server"

使用rack hijacking API

require 'websocket/driver'
require 'eventmachine'

class WS
  attr_reader :env, :url

  def initialize(env)
    @env = env

    secure = Rack::Request.new(env).ssl?
    scheme = secure ? 'wss:' : 'ws:'
    @url = scheme + '//' + env['HTTP_HOST'] + env['REQUEST_URI']

    @driver = WebSocket::Driver.rack(self)

    env['rack.hijack'].call
    @io = env['rack.hijack_io']

    EM.attach(@io, Reader) { |conn| conn.driver = @driver }

    @driver.start
  end

  def write(string)
    @io.write(string)
  end

  module Reader
    attr_writer :driver

    def receive_data(string)
      @driver.parse(string)
    end
  end
end

Rack hijacking API

Rack hijacking API 是在Rack 1.5 中引入的，hijack即为劫持，听起来好想是挺危险的样子，不过其实只是名字而已，它实际上是通过支持Rack的应用程序服务器上，拦截下client端的请求和server的相应的
Rack的hijacking API 提供了两种模式：

1. 全部劫持(full hijacking)，在这个模式下应用对socket传输的数据有绝对的控制权，也就是应用程序服务器，将对socket的控制权移交给你应用程序本身去处理，通过这个特性我们就可以实现任意应用层协议的传输，比如websocket协议。当然这些也是有一个大前提的，就是如果你的应用程序服务器(puma) 前端有反向代理(nginx) 或者 负载均衡器的话，应用程序只能通过socket传输它们两个支持的协议。
2. 部分劫持(partial hijacking)，而这个模式下应用程序可以在应用程序服务器设置完成header后，进行控制。
   hijacking API 可以通过Rack的env变量访问，要想知道应用程序服务器是否支持hajacking API，要通过 env['hijacking?']来判断，它会返回一个布尔值。

接下来我们就通过full hijacking来写一个能够同时处理HTTP请求和websocket请求的rack app
下面的代码通过env['rack.hijack'].call来运行full hijack，再使用env['rack.hijack_io']返回socket对象，然后我们就可以通过这个socket对象进行通信了。

#encoding: utf-8
require 'thread'

def websocket(env)
  env['rack.hijack'].call
  io = env['rack.hijack_io']
  begin
    start   = 'HTTP/1.1 101 Switching Protocols'
    headers = [start, 'Upgrade: websocket', 'Connection: Upgrade', '']
    io.write  headers.join("\r\n")
    io.write("\r\n")
    10.times do |i|
      io.write("Line #{i + 1}!\n")
      io.flush
      sleep 1
    end
  ensure
    io.close
  end
end

def http(env)
  ['200', {'Content-Type' => 'text/html'}, ['Normal HTTP']]
end

app = lambda do |env|
  if env['REQUEST_URI'] == '/cable' && env['HTTP_UPGRADE'] == 'websocket'
    websocket env
  else
    http env
  end
end

run app

上面的Rack app 使用了两个方法分别处理，HTTP和websocket请求，其中webscoket处理绑定在 '/cable'这个URI上。websocket方法接受一个rack env变量，进行websocket处理，首先是运行full hijack，然后再通过socket对象返回 websocket response header，这样就与客户端建立了websocket连接，并在连接上每个1秒发送一个消息，共10个。

这个例子中的websocket方法是不严谨的仅作为参考。首先是判断请求是否是websocket请求，再一个是reponse header 中缺少对websocket-key进行加密，然后返回的WebSocket-Accept。

使用Puma运行

$ puma app.ru
Puma starting in single mode...
* Version 3.4.0 (ruby 2.3.0-p0), codename: Owl Bowl Brawl
* Min threads: 0, max threads: 16
* Environment: development
* Listening on tcp://0.0.0.0:9292

首先发送一个常规的HTTP请求

$ curl -X GET -i -H "Cache-Control: no-cache" "http://localhost:9292"
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 11

Normal HTTP%

接下来在发送一个websocket请求：

websocket-request.gif

通过socket对象连续发送10行数据后，关闭连接。

总结

ActionCable最底层是一个利用rack hijacking和EventMachine的Rack App，通过不断地使用websocket-driver和自身的抽象封装，在上层提供了一个非常好用的方法，与rails server也可以无缝的结合在一起