實現一個簡單的WebSocket聊天室

WebSocket 簡介

WebSocket 是 HTML5 開始提供的一種在單個 TCP 連接上進行全雙工通訊的協議。
WebSocket 使得客戶端和服務器之間的數據交換變得更加簡單,允許服務端主動向客戶端推送數據。在 WebSocket API 中,瀏覽器和服務器只需要完成一次握手,兩者之間就直接可以創建持久性的連接,並進行雙向數據傳輸。
在 WebSocket API 中,瀏覽器和服務器只需要做一個握手的動作,然後,瀏覽器和服務器之間就形成了一條快速通道。兩者之間就直接可以數據互相傳送。

爲什麼傳統的HTTP協議不能做到WebSocket實現的功能?這是因爲HTTP協議是一個請求-響應協議,請求必須先由瀏覽器發給服務器,服務器才能響應這個請求,再把數據發送給瀏覽器。換句話說,瀏覽器不主動請求,服務器是沒法主動發數據給瀏覽器的。

Web

我們先用 express 搭一個基礎的服務端。

創建 index.js 文件

var app = require('express')();
var http = require('http').createServer(app);

app.get('/', function(req, res){
  res.send('<h1>Hello world</h1>');
});

http.listen(3000, function(){
  console.log('listening on *:3000');
});

run node index.js,並在瀏覽器打開 http://localhost:3000,訪問成功即可看到

HTML

設計我們的主頁,實現一個簡單的聊天窗口。

修改 index.js

app.get('/', function(req, res){
  res.sendFile(__dirname + '/index.html');
});

創建 index.html

<!doctype html>
<html>
  <head>
    <title>Socket.IO chat</title>
    <style>
      * { margin: 0; padding: 0; box-sizing: border-box; }
      body { font: 13px Helvetica, Arial; }
      form { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; }
      form input { border: 0; padding: 10px; width: 90%; margin-right: .5%; }
      form button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; }
      #messages { list-style-type: none; margin: 0; padding: 0; }
      #messages li { padding: 5px 10px; }
      #messages li:nth-child(odd) { background: #eee; }
    </style>
  </head>
  <body>
    <ul id="messages"></ul>
    <form action="">
      <input id="m" autocomplete="off" /><button>Send</button>
    </form>
  </body>
</html>

重啓應用並刷新頁面你就可以看到一個如下圖所示

Socket.io

引入socket.io

npm install --save socket.io

修改 index.js

var app = require('express')();
var http = require('http').Server(app);
var io = require('socket.io')(http);

app.get('/', function(req, res){
  res.sendFile(__dirname + '/index.html');
});

io.on('connection', function(socket){
  console.log('an user connected');
});

http.listen(3000, function(){
  console.log('listening on *:3000');
});

修改 index.html,在</body>下添加如下代碼

<script src="/socket.io/socket.io.js"></script>
<script>
  var socket = io();
</script>

重啓應用並刷新頁面,就可以看到命令行打印如下

Emitting event

當用戶在聊天窗的輸入框內輸入,並提交時,觸發 emit 事件,服務端監聽到該事件並做出相應的反應。

修改 index.html

<script src="/socket.io/socket.io.js"></script>
<script src="https://code.jquery.com/jquery-1.11.1.js"></script>
<script>
  $(function () {
    var socket = io();
    $('form').submit(function(e){
      e.preventDefault(); // 防止頁面重新加載
      socket.emit('chat message', $('#m').val());
      $('#m').val('');
      return false;
    });
  });
</script>

服務端監聽該事件,在 index.js 文件添加該代碼

io.on('connection', function(socket){
  socket.on('chat message', function(msg){
    console.log('message: ' + msg);
  });
});

展示消息

當服務端收到用戶A發出的消息,服務端重新發出該消息,讓客戶端接收,客戶端監聽到該事件後展示該條消息,就可以實現用戶 A, B, C 都接收到該消息。

修改 index.js

io.on('connection', function(socket){
  socket.on('chat message', function(msg){
    io.emit('chat message', msg);
  });
});

修改 index.html,實現消息的展示

<script>
  $(function () {
    var socket = io();
    $('form').submit(function(e){
      e.preventDefault(); // prevents page reloading
      socket.emit('chat message', $('#m').val());
      $('#m').val('');
      return false;
    });
    socket.on('chat message', function(msg){
      $('#messages').append($('<li>').text(msg));
    });
  });
</script>

重啓應用並刷新頁面,可以打開多個瀏覽器頁面同時訪問 localhost:3000,就可以體驗簡單聊天室的效果。

設置暱稱

在每個用戶進入的時候,隨機生成一個數字作爲用戶的暱稱,並且向所有用戶廣播該用戶進入聊天室。當用戶發送消息時,拼接上用戶的暱稱。

修改 index.js

io.on('connection', (socket) => {
  const nickname = 'user' + Math.ceil((Math.random() * 1000))
  socket.broadcast.emit('connection', nickname + ' connected')

  socket.on('chat message', (msg) => {
    io.emit('chat message', nickname + ': ' + msg)
  })
})

修改 index.html,監聽 connection 事件

<script>
    $(() => {
      const socket = io()
      $('form').submit((e) => {
        e.preventDefault()
        socket.emit('chat message', $('#m').val())
        $('#m').val('')
        return false
      });
      socket.on('chat message', (msg) => {
        $('#messages').append($('<li>').text(msg))
      })
      socket.on('connection', (msg) => {
        $('#messages').append($('<li>').text(msg))
      })
    });
  </script>

重啓應用並打開多個客戶端,可以看到如下效果

參考資料

本文大部分案例出自 socket.io 的入門文檔 https://socket.io/get-started/chat/

https://en.wikipedia.org/wiki/WebSocket

廖雪峯官網 WebSocket

菜鳥教程 WebSocket

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章