Chat源码下载与安装

源码结构

$ git clone https://github.com/NetEase/chatofpomelo-websocket.git
$ git checkout tutorial-starter

game-server

• 对于 gate 服务器，其逻辑实现代码在其 gateHandler.js 中，它接受客户端查询 connector 的请求，返回给客户端一个可以连接的 connector 的 ip、port；
• connector 服务器，其逻辑代码在 entryHandler.js 中，它主要完成接受客户端的请求，维护与客户端的连接，路由客户端的请求到 chat 服务器；
• chat 服务器，其既有 handler 代码，也有 remote 代码， handler 中处理用户的 send 请求，而 remote 是当有用户加入或者退出的时候，由 connector 来发起远程调用时调用的。在 remote 里由于涉及到用户的加入和退出，所以会有对 channel 的操作。

web-server

安装及运行

$ sh npm-install.sh

$ cd game-server
$ pomelo start

$ cd web-server
$ node app.js

chat 分析

• 负载分离：这种架构将承载连接的逻辑与后端的业务处理逻辑完全分离，这样做是非常必要的， 尤其是广播密集型应用（例如游戏和聊天）。密集的广播与网络通讯会占掉大量的资源，经过分离后业务逻辑的处理能力就不再受广播的影响；
• 切换简便：因为有了前、后端两层的架构，用户可以任意切换频道或房间都不需要重连前端的 websocket；
• 扩展性好：用户数的扩展可以通过增加 connector 进程的数量来支撑。频道的扩展可以通过哈希分区等算法负载均衡到多台聊天服务器上。理论上这个架构可以实现频道和用户的无限扩展。

客户端

• 用户进入聊天室：这部分逻辑负责把用户信息注册到 session，并让用户加入聊天室的 channel；
• 用户发起聊天： 这部分包括了用户从客户端发起请求，服务端接收请求等功能；
• 广播用户的聊天： 所有在同一个聊天室的客户端收到请求并显示聊天内容；
• 用户退出： 这部分需要做一些清理工作，包括 session 和 channel 的清理。

function queryEntry(uid, callback) {
  var route = 'gate.gateHandler.queryEntry';
  // ...
}

$("#login").click(function() {
  username = $("#loginUser").attr("value");
  rid = $('#channelList').val();

  // ...

 //query entry of connection
  queryEntry(username, function(host, port) {
    pomelo.init({
      host: host,
      port: port,
      log: true
    }, function() {
              // ...
    });
  });
});

pomelo.request('connector.entryHandler.enter', {username: username, rid: rid}, function(){
  // ...
}); 

pomelo.request('chat.chatHandler.send', {content:msg, from: username, target: msg.target}, function(data) {
  // ...
});

pomelo.on('onAdd', function(data) {
  // ...
});

pomelo.on('onLeave', function(data) {
  // ...
});

pomelo.on('onChat', function(data) {
  // ...
});

服务端

• gate 完成客户端对 connector 的查询，在其 handler 里有其实现的代码，由于在这里，本例中仅仅配置了一台 connector 服务器，因此直接返回其信息给客户端即可，然后客户端就可以连接到 connector 了。

  handler.queryEntry = function(msg, session, next) {
  	var uid = msg.uid;
  	// ...
  };

• connector 接受用户的连接，完成用户的注册及绑定，维护客户端 session 信息，处理客户端的断开连接，其逻辑代码在 connector/handler/entryHandler.js 中。大致如下：

  handler.enter = function(msg, session, next) {
  	var self = this;
  	var rid = msg.rid;
  	var uid = msg.username + '*' + rid
  	var sessionService = self.app.get('sessionService');
    // .....
  };

• chat 服务器是执行聊天逻辑的地方，它维护 channel 信息，一个房间就是一个 channel，一个 channel 里有多个用户，当有用户发起聊天的时候，就会将其内容广播到整个 channel。chat 服务器还会接受 connector 的远程调用，完成 channel 维护中的用户的加入以及离开，因此 chat 服务器不仅定义了 handler，还定义了 remote。当有客户端连接到 connector 上后，connector 会向 chat 发起远程过程调用，chat 会将登录的用户，加到对应的 channel 中，其大致代码为：

  // chatHandler.js
  handler.send = function(msg, session, next) {
  	var rid = session.get('rid');
  	var username = session.uid.split('*')[0];
  	// .....
  };
  
  // chatRemote.js
  ChatRemote.prototype.add = function(uid, sid, name, flag, cb) {
  	var channel = this.channelService.getChannel(name, flag);
  };
  
  ChatRemote.prototype.kick = function(uid, sid, name) {
  	var channel = this.channelService.getChannel(name, false);
    // ...
  };

小结