websocket 相關及socket.io建立聊天室

首先,關於websocket教程,參考詳細教程javascript

WebSocket 是一種網絡通訊協議,不少高級功能都須要它。html

WebSocket出現的緣由

由於 HTTP 協議有一個缺陷:通訊只能由客戶端發起,單向請求,若是服務端有狀態變化,卻沒法及時通知客戶端。(「輪詢」效率低,要一直保持鏈接或者重複鏈接)java

WebSocket特色

它的最大特色就是,服務器能夠主動向客戶端推送信息,客戶端也能夠主動向服務器發送信息,是真正的雙向平等對話,屬於服務器推送技術的一種。
其餘特色包括:
(1)創建在 TCP 協議之上,服務器端的實現比較容易。
(2)與 HTTP 協議有着良好的兼容性。默認端口也是80和443,而且握手階段採用 HTTP 協議,所以握手時不容易屏蔽,能經過各類 HTTP 代理服務器。
(3)數據格式比較輕量,性能開銷小,通訊高效。
(4)能夠發送文本,也能夠發送二進制數據。
(5)沒有同源限制,客戶端能夠與任意服務器通訊。
(6)協議標識符是ws(若是加密,則爲wss),服務器網址就是 URL。git

ws://example.com:80/some/path

客戶端簡單示例

//WebSocket 對象做爲一個構造函數,用於新建 WebSocket 實例。
var ws = new WebSocket("wss://echo.websocket.org");

ws.onopen = function(evt) { 
  console.log("Connection open ..."); 
  ws.send("Hello WebSockets!");
};

ws.onmessage = function(evt) {
  console.log( "Received Message: " + evt.data);
  ws.close();
};

ws.onclose = function(evt) {
  console.log("Connection closed.");
};

webSocket.readyState

readyState屬性返回實例對象的當前狀態,共有四種。github

  • CONNECTING:值爲0,表示正在鏈接。
  • OPEN:值爲1,表示鏈接成功,能夠通訊了。
  • CLOSING:值爲2,表示鏈接正在關閉。
  • CLOSED:值爲3,表示鏈接已經關閉,或者打開鏈接失敗。

示例:web

switch (ws.readyState) {
  case WebSocket.CONNECTING:
    // do something
    break;
  case WebSocket.OPEN:
    // do something
    break;
  case WebSocket.CLOSING:
    // do something
    break;
  case WebSocket.CLOSED:
    // do something
    break;
  default:
    // this never happens
    break;
}

webSocket.onopen

實例對象的onopen屬性,用於指定鏈接成功後的回調函數。canvas

ws.onopen = function () {
  ws.send('Hello Server!');
}

若是要指定多個回調函數,可使用addEventListener方法。數組

ws.addEventListener('open', function (event) {
  ws.send('Hello Server!');
});

webSocket.onclose

實例對象的onclose屬性,用於指定鏈接關閉後的回調函數。服務器

ws.onclose = function(event) {
  var code = event.code;
  var reason = event.reason;
  var wasClean = event.wasClean;
  // handle close event
};

ws.addEventListener("close", function(event) {
  var code = event.code;
  var reason = event.reason;
  var wasClean = event.wasClean;
  // handle close event
});

webSocket.onmessage

實例對象的onmessage屬性,用於指定收到服務器數據後的回調函數。websocket

ws.onmessage = function(event) {
  var data = event.data;
  // 處理數據
};

ws.addEventListener("message", function(event) {
  var data = event.data;
  // 處理數據
});

注意,服務器數據多是文本,也多是二進制數據(blob對象或Arraybuffer對象)。

ws.onmessage = function(event){
  if(typeof event.data === String) {
    console.log("Received data string");
  }

  if(event.data instanceof ArrayBuffer){
    var buffer = event.data;
    console.log("Received arraybuffer");
  }
}

除了動態判斷收到的數據類型,也可使用binaryType屬性,顯式指定收到的二進制數據類型。

// 收到的是 blob 數據
ws.binaryType = "blob";
ws.onmessage = function(e) {
  console.log(e.data.size);
};

// 收到的是 ArrayBuffer 數據
ws.binaryType = "arraybuffer";
ws.onmessage = function(e) {
  console.log(e.data.byteLength);
};

webSocket.send()

實例對象的send()方法用於向服務器發送數據。

發送文本的例子。

ws.send('your message');

發送 Blob 對象的例子。

var file = document
  .querySelector('input[type="file"]')
  .files[0];
ws.send(file);

發送 ArrayBuffer 對象的例子。

// Sending canvas ImageData as ArrayBuffer
var img = canvas_context.getImageData(0, 0, 400, 320);
var binary = new Uint8Array(img.data.length);
for (var i = 0; i < img.data.length; i++) {
  binary[i] = img.data[i];
}
ws.send(binary.buffer);

webSocket.bufferedAmount

實例對象的bufferedAmount屬性,表示還有多少字節的二進制數據沒有發送出去。它能夠用來判斷髮送是否結束。

var data = new ArrayBuffer(10000000);
socket.send(data);

if (socket.bufferedAmount === 0) {
  // 發送完畢
} else {
  // 發送還沒結束
}

webSocket.onerror

實例對象的onerror屬性,用於指定報錯時的回調函數。

socket.onerror = function(event) {
  // handle error event
};

socket.addEventListener("error", function(event) {
  // handle error event
});

服務端的實現

WebSocket 服務器的實現,能夠查看維基百科的列表

經常使用的 Node 實現有如下三種。

建立聊天室

/*app.js*/
//構建http服務
var app = require('http').createServer()
//引入socket.io
var io = require('socket.io')(app);
//定義監聽端口,能夠自定義,端口不要被佔用
var PORT = 8081;
/*定義用戶數組*/
var users = [];
//監聽端口
app.listen(PORT);
io.on('connection', function (socket) {
    /*是不是新用戶標識*/
    var isNewPerson = true;
    /*當前登陸用戶*/
    var username = null;
    /*監聽登陸*/
    socket.on('login',function(data){
        for(var i=0;i<users.length;i++){
            if(users[i].username === data.username){
                isNewPerson = false
                break;
            }else{
                isNewPerson = true
            }
        }
        if(isNewPerson){
            username = data.username
            users.push({
                username:data.username
            })
            /*登陸成功*/
            socket.emit('loginSuccess',data)
            /*向全部鏈接的客戶端廣播add事件*/
            io.sockets.emit('add',data)
        }else{
            /*登陸失敗*/
            socket.emit('loginFail','')
        }
    })


    /*退出登陸*/
    socket.on('disconnect',function(){
        /*向全部鏈接的客戶端廣播leave事件*/
        io.sockets.emit('leave',username)
        users.map(function(val,index){
            if(val.username === username){
                users.splice(index,1);
            }
        })
    })

    socket.on('sendMessage',function(data){
        io.sockets.emit('receiveMessage',data)
    })
})

console.log('app listen at'+PORT);
/*chat.js*/
$(function(){
    /*創建socket鏈接,使用websocket協議,端口號是服務器端監聽端口號*/
    var socket=io('ws://localhost:8081');
    /*定義用戶名*/
    var uname = null;

    /*登陸*/
    $('.login-btn').click(function(){
        uname = $.trim($('#loginName').val());
        if(uname){
            /*向服務端發送登陸事件*/
            socket.emit('login',{username:uname})
        }else{
            alert('請輸入暱稱')
        }
    })

    /*登陸成功*/
    socket.on('loginSuccess',function(data){
        if(data.username === uname){
            checkin(data)
        }else{
            alert('用戶名不匹配,請重試')
        }
    })

    /*登陸失敗*/
    socket.on('loginFail',function(){
        alert('暱稱重複')
    })

    /*新人加入提示*/
    socket.on('add',function(data){
        var html = '<p>系統消息:'+data.username+'已加入羣聊</p>';
        $('.chat-con').append(html);
    })

    /*隱藏登陸界面 顯示聊天界面*/
    function checkin(data){
        $('.login-wrap').hide('slow');
        $('.chat-wrap').show('slow');
    }

    /*退出羣聊提示*/
    socket.on('leave',function(name){
        if(name != null){
            var html = '<p>FBI warning:'+name+'已退出羣聊</p>';
            $('.chat-con').append(html);
        }
    })

    /*chat.js*/
    /*發送消息*/
    $('.sendBtn').click(function(){
        sendMessage()
    });
    $(document).keydown(function(event){
        if(event.keyCode === 13){
            sendMessage()
        }
    })
    function sendMessage(){
        var txt = $('#sendtxt').val();
        $('#sendtxt').val('');
        if(txt){
            socket.emit('sendMessage',{username:uname,message:txt});
        }
    }
    /*接收消息*/
    socket.on('receiveMessage',function(data){
        showMessage(data)
    })

    /*顯示消息*/
    function showMessage(data){
        var html
        //預防XSS攻擊
        var msg=data.message
        msg= msg.replace(/\\/g,'\\\\');
        msg= msg.replace(/"/g,'\\"');
        if(data.username === uname){
            html = '<div class="chat-item item-right clearfix"><span class="img fr"></span><span class="message fr">'+msg+'</span></div>'
        }else{
            html='<div class="chat-item item-left clearfix rela"><span class="abs uname">'+data.username+'</span><span class="img fl"></span><span class="fl message">'+msg+'</span></div>'
        }
        $('.chat-con').append(html);
    }

})
相關文章
相關標籤/搜索