看看node.js chat程序如何實現Ajax long-polling長鏈接刷新模式

前言　　

　　首先，關於node.js，這里就不再細說了。

　　node.js chat是node.js作者用JS寫的一個多人聊天工具， 源代碼公開下載，網址是chat.nodejs.org。作者用這個小例子，來展示如何用nodejs開發高效率的應用程序。對於nodejs的學習者來說，是一個很好的例子。

　　廢話不多說，開始今天的主題。縱觀這個程序，感覺它的最可貴之處，在於展示了，如何用nodejs實現長鏈接模式的刷新技術。

　　（這個程序不詳細介紹，重點講解這個功能）

Client.js　　

首先看一段核心代碼：

function longPoll (data) {
  
  //....此處省略＊＊行

  $.ajax({ cache: false
         , type: "GET"
         , url: "/recv"
         , dataType: "json"
         , data: { since: CONFIG.last_message_time, id: CONFIG.id }
         , error: function () {
             addMessage("", "long poll error. trying again...", new Date(), "error");
             transmission_errors += 1;
             //don't flood the servers on error, wait 10 seconds before retrying
             setTimeout(longPoll, 10*1000);
           }
         , success: function (data) {
             transmission_errors = 0;
             //if everything went well, begin another request immediately
             //the server will take a long time to respond
             //how long? well, it will wait until there is another message
             //and then it will return it to us and close the connection.
             //since the connection is closed when we get data, we longPoll again
             longPoll(data);
           }
         });
}

　　這是client.js中的一段代碼，一看這段代碼，大家應該立馬想到兩個字——“遞歸”。在longPoll方法中，再次調用longPoll方法，典型的遞歸調用。

　　根據這段代碼的語義，可以看出，第一次加載時，會調用longPoll方法，異步向"/resv"獲取值，如果成功了， 執行success的方法，立即再次調用longPoll方法。如果失敗了，執行error函數，隔10秒中再次調用longPoll方法。當然，執行error方法有一定的次數限制，由變量transmission_errorsx控制。

　　大家可能會有一個疑問，這樣一直遞歸循環獲取數據，服務器會不會有很大的負擔？在沒有數據可獲取的時候，也會一直這樣循環嗎？當然，答案時否定的！並且，nodejs利用自身的特點，很好的處理了這個問題。接着往下看：

Server.js

現看server中如何回應上面client的調用，核心代碼：

fu.get("/recv", function (req, res) {

  //對session的驗證和更新......  

  channel.query(since, function (messages) {
    if (session) session.poke();
    res.simpleJSON(200, { messages: messages, rss: mem.rss });
  });
});

　　先不要管這個fu.get()是什么意思，它和本次教程無關。總之知道它能回應client的調用就行了。上面的代碼，除了對session的一些操作之外，只是調用了channel的query方法。注意傳遞的參數：

• since，它紀錄了一個時間；
• 匿名方法，它接受一個messages參數，兩個動作：1 更新session時間，2 返回一個json，即把messages返回給客戶端。

　　有人可能會有疑問：在這里直接返回messages不行嗎，干嘛還得在一個channel中定義一個方法才操作？答案：如果是那樣，就成了一個死循環，server和client每時每刻都進行着數據交互，即使沒有信息可返回。

　　還是接着往下看吧！

　　看channel是怎么定義的：

var MESSAGE_BACKLOG = 200,
    SESSION_TIMEOUT = 60 * 1000;

var channel = new function () {
  var messages = [],
      callbacks = [];

  this.appendMessage = function (nick, type, text) {
    var m = { nick: nick
            , type: type // "msg", "join", "part"
            , text: text
            , timestamp: (new Date()).getTime()
            };

    switch (type) {
      case "msg":
        sys.puts("<" + nick + "> " + text);
        break;
      case "join":
        sys.puts(nick + " join");
        break;
      case "part":
        sys.puts(nick + " part");
        break;
    }

    messages.push( m );

    while (callbacks.length > 0) {
      //shift() 方法用於把數組的第一個元素從其中刪除，並返回第一個元素的值
      callbacks.shift().callback([m]);
    }

    while (messages.length > MESSAGE_BACKLOG)
      messages.shift();
  };

  this.query = function (since, callback) {
    var matching = [];
    for (var i = 0; i < messages.length; i++) {
      var message = messages[i];
      if (message.timestamp > since)
        matching.push(message)
    }

    if (matching.length != 0) {
      callback(matching);
    } else {
      callbacks.push({ timestamp: new Date(), callback: callback });
    }
  };

  // clear old callbacks
  // they can hang around for at most 30 seconds.
  setInterval(function () {
    var now = new Date();
    while (callbacks.length > 0 && now - callbacks[0].timestamp > 30*1000) {
      callbacks.shift().callback([]);
    }
  }, 3000);
};

　　channel中定義了兩個變量，兩個方法，還有一個每隔3秒執行一次的setInterval函數。

　　首先看query方法，

　　query方法接收兩個參數：

• since：紀錄一個時間
• callback：即上面講調用channel.query方法時傳入的那個匿名函數（JS中，函數可以當參數傳遞，接收之后可直接調用。不會趕快補課啊。。。）

　　messages里存的時當前的聊天紀錄隊列，query方法會查找符合條件的聊天紀錄，把他們放在matching隊列中。如果matching.length>0，則調用callback接收的函數，即把matching以json格式返回client。但是。。。接下來是重點！！！

if (matching.length != 0) {
      callback(matching);
    } else {
      callbacks.push({ timestamp: new Date(), callback: callback });
}

　　如果matching.length<=0，程序會把callback和當前時間，以json格式，存入一個callbacks隊列中。對！不執行了，因為沒有符合條件的聊天消息，不需要在client顯示，所以先把這個函數存起來，先不執行。

　　那也不能這樣一直存着啊，萬一下一秒有人發聊天消息怎么辦？

　　接着看appendMessage（添加聊天消息）方法：

　　該方法中，前段部分很好理解，無非是接收傳入的參數，組合成一個m集合，然后用sys.puts在終端顯示一下，再把m插入到messages聊天消息隊列中。接下來又是重點：

while (callbacks.length > 0) {
      //shift() 方法用於把數組的第一個元素從其中刪除，並返回第一個元素的值
      callbacks.shift().callback([m]);
}

　　現在要判斷callbacks有沒有儲存，如果有，就執行一個，刪除一個，知道執行完了為止。因為之前在沒有聊天消息可返回的時候，有人發出了請求，然后系統沒有執行這些請求，都把他們放在callbacks列表中了。

　　現在有人發送了聊天消息，執行添加方法的時候，要再次把那些沒執行的請求都執行一遍。

　　通俗理解可以是：你給我發送請求了，我現在還沒有新消息可以答復你，一旦有人發了新消息，我會立刻答復你。

　　不知道大家理解了沒。。。

　　這一步完了，最后一步，是每隔3秒鍾，清空過期的callbacks，是一個setInterval函數，這個不難理解。

總結

　　nodejs用自身基於事件驅動的語言特點，實現了長鏈接刷新功能，讓我們打開眼界。自我感覺受益匪淺。特此花時間寫個教程跟大家分享，同時也加深我自己的理解。