HTML5之WebSocket入門3 -通訊模型socket.io_javascript技巧-js教程-PHP中文網

socket.io為什麼會誕生呢？請看下面文字說明。

為什麼需要socket.io？

node.js提供了高效率的服務端運作環境，但由於瀏覽器端對HTML5的支援不一，為了相容於所有瀏覽器，提供卓越的即時的使用者體驗，並且為程式設計師提供用戶端與服務端一致的程式設計體驗，於是socket.io誕生。

socket.io設計的目標是支援任何的瀏覽器，任何Mobile設備。目前支援主流的PC瀏覽器(IE,Safari,Chrome,Firefox,Opera等)，Mobile瀏覽器(iphone Safari/ipad Safari/android WebKit/WebOS WebKit等)。

socket.io基於node.js並簡化了WebSocket API，統一了各種通訊API。它支援：WebSocket, Flash Socket, AJAX long-polling, AJAX multipart streaming, Forever IFrame, JSONP polling。

socket.io解決了即時的通訊問題，並統一了服務端與客戶端的程式設計方式。啟動了socket以後，就像建立了一條客戶端與服務端的管道，兩邊可以互通有無。

安裝

在命令列執行：npm install socket.io 即可安裝。

服務端程式設計模型

服務端程式設計還是與一般伺服器一樣，啟動伺服器，提供服務，處理事件。

例如下面的server.js：

var http = require('http')
  , url = require('url')
  , fs = require('fs')
  , server;
server = http.createServer(function(req, res){
  // your normal server code
  var path = url.parse(req.url).pathname;
  switch (path){
  case '/':
   res.writeHead(200, {'Content-Type': 'text/html'});
   res.write('<h1>Hello! Try the <a href="/index.html">Socket.io Test</a></h1>');
   res.end();
   break;
  case '/index.html':
   fs.readFile(__dirname + path, function(err, data){
    if (err) return send404(res);
    res.writeHead(200, {'Content-Type': path == 'json.js' &#63; 'text/javascript' : 'text/html'})
    res.write(data, 'utf8');
    res.end();
   });
   break;
  default: send404(res);
  }
}),
send404 = function(res){
  res.writeHead(404);
  res.write('404');
  res.end();
};
server.listen(8080);
var io = require('socket.io').listen(server);
io.sockets.on('connection', function(socket){
 console.log("Connection " + socket.id + " accepted.");
 socket.on('message', function(message){
    console.log("Received message: " + message + " - from client " + socket.id);
 });
 socket.on('disconnect', function(){
  console.log("Connection " + socket.id + " terminated.");
 });
});

登入後複製

客戶端程式設計模型

客戶端程式設計也是相似的處理方式，連接伺服器，互動資訊。

例如下面的index.html頁面：

<!doctype html>
<html>
 <head>
  <title>Socket.io Test</title>
  <script src="/json.js"></script> <!-- for ie -->
  <script src="/socket.io/socket.io.js"></script>
 </head>
 <body>  
  <script>    
  var socket;
  var firstconnect = true;
  function connect() {
   if(firstconnect) {
    socket = io.connect(null);
    socket.on('message', function(data){ message(data); });
    socket.on('connect', function(){ status_update("Connected to Server"); });
    socket.on('disconnect', function(){ status_update("Disconnected from Server"); });
    socket.on('reconnect', function(){ status_update("Reconnected to Server"); });
    socket.on('reconnecting', function( nextRetry ){ status_update("Reconnecting in " 
     + nextRetry + " seconds"); });
    socket.on('reconnect_failed', function(){ message("Reconnect Failed"); });
    firstconnect = false;
   }
   else {
    socket.socket.reconnect();
   }
  }
  function disconnect() {
   socket.disconnect();
  }
  function message(data) {
   document.getElementById('message').innerHTML = "Server says: " + data;
  }
  function status_update(txt){
   document.getElementById('status').innerHTML = txt;
  }
  function esc(msg){
   return msg.replace(/</g, '<').replace(/>/g, '>');
  }
  function send() {
   socket.send("Hello Server!");  
  };    
  </script>
  <h1>Socket.io Test</h1>
  <div><p id="status">Waiting for input</p></div>
  <div><p id="message"></p></div> 
  <button id="connect" onClick='connect()'/>Connect</button>
  <button id="disconnect" onClick='disconnect()'>Disconnect</button>
  <button id="send" onClick='send()'/>Send Message</button>
 </body>
</html>

登入後複製

注意事項

1. 啟動伺服器還是交給node，打開命令列窗口，定位到server.js所在資料夾，輸入node server.js啟動伺服器。

在上面的index.html中，注意這行：。如果不想使用本地的socket.io腳本，可

以直接使用下面這個公開的腳本：

<script src="http://cdn.socket.io/stable/socket.io.js"></script>

登入後複製

另外需要注意這一行：socket = io.connect(null)。

這裡的null代表連接本地服務，可以換成"localhost"，效果也是一樣的。

2. 可以使用socket.io直接啟動http服務。

例如：

var io = require('socket.io').listen(80);
io.sockets.on('connection', function (socket) {
 io.sockets.emit('this', { will: 'be received by everyone'});
});

登入後複製

3. socket.io可以直接透過send方法傳送訊息，使用message事件接收訊息，例如：

//server.js
var io = require('socket.io').listen(80);
io.sockets.on('connection', function (socket) {
 socket.on('message', function () { });
});
//index.html
<script>
 var socket = io.connect('http://localhost/');
 socket.on('connect', function () {
  socket.send('hi');
  socket.on('message', function (msg) {
   // my msg
  });
 });
</script>

登入後複製

4. 發送和處理資料

兩端可互發事件，互發數據，相互通訊。發送事件的程式碼為：socket.emit(action, data, function)，其中action為事件的名稱，data為數據，function為回呼函數;處理事件程式碼為：socket.on(action,function)，如果emit傳送的時候有資料data，則function中參數包含了這個資料。 socket.io除了發送和處理內建事件，如connect, disconnect, message。也允許發送和處理自訂事件，例如:

//服務端：

io.sockets.on('connection', function (socket) {
 socket.emit('news', { hello: 'world' });
 socket.on('my other event', function (data) {
  console.log(data);
 });
});

登入後複製

//客戶端：

<script src="/socket.io/socket.io.js"></script>
<script>
 var socket = io.connect('http://localhost');
 socket.on('news', function (data) {
  console.log(data);
  socket.emit('my other event', { my: 'data' });
 });
</script>

登入後複製

5. 從上面可以看出來，發送資料的時候，send和emit是都可以使用的。只不過emit更是強化了自訂事件的處理。

6. 可以在服務端使用socket的get/set方法儲存客服端的相關數據，例如：

//服務端

var io = require('socket.io').listen(80);
io.sockets.on('connection', function (socket) {
 socket.on('set nickname', function (name) {
  socket.set('nickname', name, function () { socket.emit('ready'); });
 });
 socket.on('msg', function () {
  socket.get('nickname', function (err, name) {
   console.log('Chat message by ', name);
  });
 });
});

登入後複製

//客戶端

<script>
 var socket = io.connect('http://localhost');
 socket.on('connect', function () {
  socket.emit('set nickname', confirm('What is your nickname&#63;'));
  socket.on('ready', function () {
   console.log('Connected !');
   socket.emit('msg', confirm('What is your message&#63;'));
  });
 });
</script>

登入後複製

7. 可以廣播訊息，例如聊天室中給除了目前socket連線外的所有人發訊息。

var io = require('socket.io').listen(80);
io.sockets.on('connection', function (socket) {
 socket.broadcast.emit('user connected');
});

登入後複製

8. 可以在同一次連結中，建立多個互相獨立的通道，而不是建立多次連結。這個官方叫法是“多個namespace”，例如官方的例子：

var io = require('socket.io').listen(80);
//Server
var chat = io
 .of('/chat')
 .on('connection', function (socket) {
  socket.emit('a message', {
    that: 'only'
   , '/chat': 'will get'
  });
  chat.emit('a message', {
    everyone: 'in'
   , '/chat': 'will get'
  });
 });
var news = io
 .of('/news')
 .on('connection', function (socket) {
  socket.emit('item', { news: 'item' });
 });
//Client
<script>
 var chat = io.connect('http://localhost/chat')
  , news = io.connect('http://localhost/news');
 chat.on('connect', function () {
  chat.emit('hi!');
 });
 news.on('news', function () {
  news.emit('woot');
 });
</script>

登入後複製

socket.io的設定

socket.io的設定很簡單，如果配置過express的話，你會發現它們幾乎是使用差不多的方式。先看個小例子：

var io = require('socket.io').listen(80);
io.configure('production', function(){
 io.enable('browser client etag');
 io.set('log level', 1);
 io.set('transports', [
  'websocket'
 , 'flashsocket'
 , 'htmlfile'
 , 'xhr-polling'
 , 'jsonp-polling'
 ]);
});
io.configure('development', function(){
 io.set('transports', ['websocket']);
});

登入後複製

可以看到，socket.io使用configure, set, enable, disable進行設定。

1. 使用configure方法來設定不同的運作環境下的行為；就是說在不同的環境下，啟用不同的設定選項。 configure的第一個參數是運作環境，第二個參數是進行設定的function。運行環境典型的如production或是development，當然這裡可以使任意的字串。如果configure的第一個參數省略的話，表示後面的配置是公用的，不管是什麼環境下，都有效。

2. 配置好各種運作環境了，那麼如何設定目前運作在那個環境下呢？這個是透過在命令列中修改環境變數NODE_ENV的值來實現的。

3. 在configure的設定函數中，我們可以使用set, enable, disable來設定相關選項。

4. 具體可以設定的項目參考：https://github.com/LearnBoost/Socket.IO/wiki/Configuring-Socket.IO
實用參考

socket.io介紹：http://davidchambersdesign.com/getting-started-with-socket.io/

socket.io安裝與使用說明：http://socket.io/

socket.io Wiki：https://github.com/LearnBoost/Socket.IO/wiki