初试WebSocket构建聊天程序

上一篇文章中使用了Ajax long polling实现了一个简单的聊天程序，对于web实时通信，今天就来试用一下基于WebSocket的长连接方式。

WebSocket简介

为了增强web通信的功能，在HTML5中，提供了WebSocket，它不仅仅是一种web通信方式，也是一种应用层协议。

WebSocket提供了客户端和服务端之间的双全工跨域通信，通过客户端和服务端之间建立WebSocket连接（实际上是TCP连接，后面会看到），在同一时刻能够实现客户端到服务器和服务器到客户端的数据发送。

Ajax long polling是一种客户端去服务端拉取数据的方式，而WebSocket则能真正实现服务端主动向客户端推送数据。下图形象的展示了WebSocket的工作方式。

对于WebSocket这种新的应用层协议，在实现应用的时候，客户端和服务端都需要遵循WebSocket协议，关于更多的WebSocket内容，请参考websocket.org。

实现

首先，还是先看看通过WebSocket实现的聊天程序的代码以及效果，然后再看WebSocket工作方式相关的内容。

客户端

因为并不是所有版本的浏览器都能够支持WebSocket，所以例子中通过下面代码来检测当前浏览器是否支持WebSocket。

if(window.WebSocket){
    //support WebSocket, more code here
}
else{
    alert("WebSocket was not supported");
}

对于客户端，主要就是updater这个对象，该对象会创建并维护了一个WebSocket对象，通过这个WebSocket对象就可以跟服务端进行交互（收取或发送消息）。

var updater = {
     socket: null,

     start: function() {
         var url = "ws://" + location.host + "/chatsocket";
         updater.socket = new WebSocket(url);
         
         updater.socket.onopen = function(event) {
         }
         
         updater.socket.onclose = function(event) {
             alert("server socket closed");
         }
         
         updater.socket.onmessage = function(event) {
             updater.showMessage(event.data);
         }
     },

     showMessage: function(message) {
         console.log(message);
         $("#inbox").append(message);
         $("#message").val("");
     }
 };

服务端

对于服务端，这次使用了gevent-websocket这个库，可以很方便的通过pip进行安装。

服务端通过MessageBuffer这个类来管理所有的消息，以及所有的WebSocket client。由于WebSocket是一种长连接的方式，所以可以很容易的统计出当前在线的client的数量。

class MessageBuffer(object):
    def __init__(self, cache_size = 200):
        self.cache = []
        self.cache_size = cache_size
        self.clients = []        

    def new_message(self, msg):
        self.cache.append(msg)
        if len(self.cache) > self.cache_size:
            self.cache = self.cache[-self.cache_size:]
            
    def update_clients(self, msg):
        for client in self.clients:
            client.send(msg)

跟上次相比，使用WebSocket之后，服务器代码更加简洁了。当客户端发起"/chatsocket"请求后，服务器就会跟客户端建立连接，并将客户端加入"messageBuffer.clients"列表中；当客户端断开连接，就会将客户端从"messageBuffer.clients"列表中移除。

当服务器收到新消息后，就会通过"messageBuffer.update_clients"方法，将新消息推送到所有的客户端。

def application(env, start_response):
    # visit the main page
    if env['PATH_INFO'] == '/':
        # some code to load main page here
    
    elif env['PATH_INFO'] == '/chatsocket':
        ws = env["wsgi.websocket"]
        messageBuffer.clients.append(ws)
        print "new client join, total client count %d" %len(messageBuffer.clients)
        while True:
            message = ws.receive()
            if message is None:
                messageBuffer.clients.remove(ws)
                print "client leave, total client count %d" %len(messageBuffer.clients)
                break
            print "Got message: %s" %message
            message = "<div>{0}</div>".format(message)
            messageBuffer.new_message(message)
            messageBuffer.update_clients(message)