《菜鳥教程》| Egret搭建WebSocket簡易聊天室

時間 2019-11-17

標籤菜鳥教程 egret 搭建 websocket 簡易聊天室简体版

原文原文鏈接

本文，咱們經過Egret和Node.js實現一個在線聊天室的demo。主要包括，聊天，改用戶名，查看其餘用戶在線狀態的功能。大體流程爲，用戶訪問網頁，即進入聊天狀態，成爲新遊客，經過底部的輸入框，能夠輸入本身想說的話，點擊發布，信息呈現給全部在聊天的人的頁面。用戶能夠實時修改本身的暱稱，用戶離線上線都會實時廣播給其餘用戶。javascript

體驗連接 http://7hds.com:8888/java

下圖爲最終制做完成的聊天面板node

WebSocket服務器能夠用其餘語言編寫，本文采用的方法創建在Node.js上。web

在Node.js中咱們使用ws第三方模塊來實現服務器業務邏輯的快速搭建，還需使用uuid模塊生成隨機id，你須要使用npm包管理器來安裝ws、uuid模塊。使用如下命令：npm

npm install ws -g
npm install uuid -g

安裝完成以後，使用終端工具進入服務器目錄，開始編寫代碼：數組

//引入ws模塊
var WebSocket = require('ws');
//建立websocket服務，端口port爲：****
var WebSocketServer = WebSocket.Server,
    wss = new WebSocketServer({port: 8180});
//引入uuid模塊
var uuid = require('node-uuid');
//定義一個空數組，存放客戶端的信息 
var clients = [];
//定義發送消息方法wsSend
//參數爲 type:類型
//client_uuid:隨機生成的客戶端id
//nickname:暱稱
//message:消息
//clientcount:客戶端個數
function wsSend(type, client_uuid, nickname, message,clientcount) {
    //遍歷客戶端
  for(var i=0; i<clients.length; i++) {
      //聲明客戶端
    var clientSocket = clients[i].ws;
    if(clientSocket.readyState === WebSocket.OPEN) {
        //客戶端發送處理過的信息
      clientSocket.send(JSON.stringify({
        "type": type,
        "id": client_uuid,
        "nickname": nickname,
        "message": message,
        "clientcount":clientcount,
      }));
    }
  }
}
//聲明客戶端index默認爲1 
var clientIndex = 1;
//服務端鏈接
wss.on('connection', function(ws) {
//客戶端client_uuid隨機生成
  var client_uuid = uuid.v4();
  //暱稱爲遊客+客戶端index
  var nickname = "遊客"+clientIndex;
  //client++
  clientIndex+=1;
  //將新鏈接的客戶端push到clients數組中
  clients.push({"id": client_uuid, "ws": ws, "nickname": nickname});
  //控制檯打印鏈接的client_uuid
  console.log('client [%s] connected', client_uuid);
 //聲明鏈接信息爲 暱稱+來了
  // var connect_message = nickname + " 來了";
  var connect_message =  " 來了";

  //服務器廣播信息 ***來了
  wsSend("notification", client_uuid, nickname, connect_message,clients.length);
 //當用戶發送消息時
  ws.on('message', function(message) {
      // 用戶輸入"/nick"的話爲重命名消息
    if(message.indexOf('/nick') === 0) {
      var nickname_array = message.split(' ');
      if(nickname_array.length >= 2) {
        var old_nickname = nickname;
        nickname = nickname_array[1];
        var nickname_message = "用戶 " + old_nickname + " 更名爲： " + nickname;
        wsSend("nick_update", client_uuid, nickname, nickname_message,clients.length);
      }
    }//發送消息 
    else {
      wsSend("message", client_uuid, nickname, message,clients.length);
    }
  });
 //關閉socket鏈接時
  var closeSocket = function(customMessage) {
      //遍歷客戶端
    for(var i=0; i<clients.length; i++) {
        //若是客戶端存在
        if(clients[i].id == client_uuid) {
            // 聲明離開信息
            var disconnect_message;
            if(customMessage) {
                disconnect_message = customMessage;
            } else {
                disconnect_message = nickname + " 走了";
            }
         //客戶端數組中刪掉
          clients.splice(i, 1);
          //服務廣播消息
          wsSend("notification", client_uuid, nickname, disconnect_message,clients.length);
        }
    }
  }
  ws.on('close', function() {
      closeSocket();
  });
 
  process.on('SIGINT', function() {
      console.log("Closing things");
      closeSocket('Server has disconnected');
      process.exit();
  });
});

服務器端主要是接收信息，判斷是聊天信息仍是重命名信息，而後發送廣播。同時，當用戶鏈接上服務器端或者關閉鏈接時，服務器也會發送廣播通知其餘用戶。服務器

咱們封裝了wsSend函數用來處理消息的廣播。對每一個鏈接的用戶，咱們默認給他分配爲遊客。爲了實現廣播，咱們用clients數組來保存鏈接的用戶。websocket

將編寫好的文件保存爲server.js，在終端工具中，使用node server.js來啓動你剛剛編寫的服務器。若是終端沒有報錯，證實你的代碼已經正常運行。app

在實際項目中，服務器邏輯遠遠比此示例複雜得多。服務器端完成後，再來編寫客戶端代碼。socket

界面很是簡單，咱們經過兩張圖片來實現界面效果，首先建立咱們的聊天界面，此項目中爲了方便咱們使用EUI進行快速開發。以下圖：

首先建立一個Image來放置咱們的背景圖。

建立三個Label對象，一個做爲title：「多人在線聊天室」，一個做爲提示：「當前在線人數」，還有一個id爲lb_online的做爲在線人數顯示文本。

建立一個EditableText對象id爲input_msg做爲消息發送輸入框，用戶能夠在此輸入消息進行發送。

建立一個Button對象id爲btn_ok，點擊按鈕能夠執行發送消息動做。

建立界面的操做和WebSocket對象建立動做在同時進行，在init方法中建立WebSocket對象，並執行服務器鏈接操做，代碼以下：

public ws;
    private init() {
        /**WebSocket鏈接 */
        this.ws = new WebSocket('ws://127.0.01:8180');
        this.ws.onopen = function (e) {
            console.log('Connection to server opened');
        }
    }

因爲服務器開放了8180端口，咱們也須要使用8180端口進行鏈接。當鏈接成功，可執行onopen方法。

服務器鏈接成功了，在控制檯打印 'Connection to server opened'。

onmessage方法中讀取服務器傳遞過來的數據，並經過appendLog方法將數據顯示在對應的文本里，

使用newLabel方法並將一條新消息插入到消息框中。

private init() {
        /**WebSocket鏈接 */
        this.ws = new WebSocket('ws://127.0.01:8180');
        this.ws.onopen = function (e) {
            console.log('Connection to server opened');
        }
        /**暱稱 */
        var nickname;
        var self = this;
        this.ws.onmessage = function (e) {
            var data = JSON.parse(e.data);
            nickname = data.nickname;
            appendLog(data.type, data.nickname, data.message, data.clientcount);
            console.log("ID: [%s] = %s", data.id, data.message);
            //插入消息
            self.group_msg.addChild(self.newLabel(data.nickname, data.message))
        }
        function appendLog(type, nickname, message, clientcount) {
            console.log(clientcount)
            /**聊天信息 */
            var messages = this.list_msg;
            /**提示 */
            var preface_label;
            if (type === 'notification') {
                preface_label = "提示：";
            } else if (type === 'nick_update') {
                preface_label = "警告：";
            } else {
                preface_label = nickname;
            }
            self.preface_label = preface_label;
            var message_text = self.message_text = message;
            /**在線人數 */
            self.lb_online.text = clientcount;
        }
        /**點擊OK發送 */
        this.btn_ok.addEventListener(egret.TouchEvent.TOUCH_TAP, this.sendMessage, this);
    }
    private newLabel(name: string, msg: string) {
          var label1: eui.Label = new eui.Label();
          label1.text = name + ":" + msg;
          label1.textColor = 0x000000
          return label1;
    }

最後咱們來編寫發送消息的函數，在btn_ok中egret.TouchEvent.TOUCH_TAP點擊以後的相應函數爲sendMessage方法。

/**發送消息 */
    private sendMessage() {
        var message = this.input_msg.text;
        if (message.length < 1) {
            // console.log("不能發送空內容！");
            return;
        }
        this.ws.send(message);
        /**清空輸入框內容 */
        this.input_msg.text = "";
    }

若是輸入框中內容不爲空的話就將數據經過 this.ws.send(message); 發送給服務器，並清除輸入框的內容。

最終運行後，咱們就能夠實現多人在線聊天功能了。

完整版代碼以下：

class Chat extends eui.Component implements eui.UIComponent {
    /**在線人數文本 */
    public lb_online: eui.Label;
    /**聊天窗口 */
    public scr_msg: eui.Scroller;
    /**聊天信息 */
    public list_msg: eui.List;
    /**輸入框 */
    public input_msg: eui.EditableText;
    /**肯定按鈕 */
    public btn_ok: eui.Button;
    /**聊天窗口消息組 */
    public group_msg: eui.Group;

    public constructor() {
        super();
    }
    protected partAdded(partName: string, instance: any): void {
        super.partAdded(partName, instance);
    }
    protected childrenCreated(): void {
        this.init();
        super.childrenCreated();
    }
    /**WebSocket */
    public ws;
    public preface_label;
    public message_text;
    private init() {
        /**WebSocket鏈接 */
         //線上測試連接，服務端代碼需在服務器啓動
        //this.ws = new WebSocket('ws://7hds.com:8180');
        this.ws = new WebSocket('ws://127.0.01:8180');
        this.ws.onopen = function (e) {
            console.log('Connection to server opened');
        }
        /**暱稱 */
        var nickname;
        var self = this;
        this.ws.onmessage = function (e) {
            var data = JSON.parse(e.data);
            nickname = data.nickname;
            appendLog(data.type, data.nickname, data.message, data.clientcount);
            console.log("ID: [%s] = %s", data.id, data.message);
            //插入消息
            self.group_msg.addChild(self.newLabel(data.nickname, data.message))
        }
        function appendLog(type, nickname, message, clientcount) {
            console.log(clientcount)
            /**聊天信息 */
            var messages = this.list_msg;
            /**提示 */
            var preface_label;
            if (type === 'notification') {
                preface_label = "提示：";
            } else if (type === 'nick_update') {
                preface_label = "警告：";
            } else {
                preface_label = nickname;
            }
            self.preface_label = preface_label;
            var message_text = self.message_text = message;
            /**在線人數 */
            self.lb_online.text = clientcount;
        }
        /**點擊OK發送 */
        this.btn_ok.addEventListener(egret.TouchEvent.TOUCH_TAP, this.sendMessage, this);
    }
    /**發送消息 */
    private sendMessage() {
        var message = this.input_msg.text;
        if (message.length < 1) {
            // console.log("不能發送空內容！");
            return;
        }
        this.ws.send(message);
        /**清空輸入框內容 */
        this.input_msg.text = "";
        // console.log(this.ws.bufferedAmount);
    }
    private newLabel(name: string, msg: string) {
        var label1: eui.Label = new eui.Label();
        label1.text = name + ":" + msg;
        label1.textColor = 0x000000
        return label1;
    }

}

本文的demo增長了客戶端與服務器的互動，同時也實現了客戶端之間的聯繫。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。