node.js中RPC(遠端過程呼叫)的實作原理介紹_node.js

剛接觸到RPC（遠端過程呼叫），就是可以在本地呼叫遠端機子上的程式的方法，看到一個簡單的nodejs實現，用來學習RPC的原理很不錯：nodejs light_rpc

使用範例：

複製程式碼 程式碼如下:

//服務端
var light_rpc = require('./index.js');
var port = 5556;
var rpc = new light_rpc({
    combine: function(a, b, callback){
        callback(a b);
    },
    multiply: function(t, cb){
        cb(t*2);
    }
}).listen(port);

Sample client:

複製程式碼 程式碼如下:

//客戶端
rpc.connect(5556, 'localhost', function(remote, conn){
    remote.combine(1, 2, function(res){
        if(res != 3){
            console.log('ERROR', res);
        }
    });
});

簡單說說整個過程：

1.server端啟動程序，偵聽端口，實作提供給client呼叫的函數（如上述例子的combine和multiply），保存在一個物件裡。
2.client端啟動程序，連接服務端，連接完成後發送describe指令，要求server回傳它能提供呼叫的函數名稱。

複製程式碼 程式碼如下:

connection.on('connect', function(){
  connection.write(command(descrCmd));
});

3.server端接收到describe指令，把自己可供呼叫的函式名稱包裝好寄出去(“combine”, “multiply”)
4.client端接收到server傳送的函式名，註冊到自己的物件裡，給每個函式名稱包裝一個方法，讓本機呼叫這些函式時實際上是向server端傳送請求:

複製程式碼 程式碼如下:

for(var p in cmd.data){
  remoteObj[p] = getRemoteCallFunction(p, self.callbacks, connection);
  //getRemoteCallFunction的實作請看下面
}

5.client端呼叫server端的函式：

1) 給傳入的callback函數產生一個唯一ID，稱為callbackId，記錄到client的一個物件裡。
2) 包裝好以下資料傳送給server端：呼叫函數名，JSON序列化後的參數列表，callbackId

複製程式碼 程式碼如下:

function getRemoteCallFunction(cmdName, callbacks, connection){
  return function(){
    var id = uuid.generate();
    if(typeof arguments[arguments.length-1] == 'function'){
      callbacks[id] = arguments[arguments.length-1];
    }
    var args = parseArgumentsToArray.call(this, arguments);
    var newCmd = command(cmdName, {id: id, args: args});
    connection.write(newCmd);
  }
}

6.server端接收到上述訊息，解析數據，對參數清單反序列化，根據函數名稱和參數呼叫函數。

複製程式碼 程式碼如下:

var args = cmd.data.args;
args.push(getSendCommandBackFunction(c, cmd.data.id));
self.wrapper[cmd.command].apply({}, args);

7.函數執行完成後，把結果序列化，連同之前收到的callbackId傳回client端

複製程式碼 程式碼如下:

function getSendCommandBackFunction(connection, cmdId){
  return function(){
    var innerArgs = parseArgumentsToArray.call({}, arguments);
    var resultCommand = command(resultCmd, {id: cmdId, args: innerArgs});
    connection.write(resultCommand);
  };
}

8.client端接收到函數運行結果和callbackId，根據callbackId取出回呼函數，把運行結果傳入回調函數中執行。

9.整個過程完成，詳見原始碼：https://github.com/romulka/nodejs-light_rpc

幾個注意的點：

1.整個過程中client和server一直保持連接，不像http協議發送和接收完就斷開鏈接，所以不能以斷開鏈接判斷一次數據的傳送完成。為了判斷資料接收完成，client和server傳送的資料遵循一個簡單的協定：在資料前加上資料包的長度和分隔符，如定分隔符為n：[資料包長度 資料]，這樣在收到資料後先取出資料包的長度，再不斷判斷累計已接收到的資料包是否等於或超過這個長度，若是則一次資料傳送完成，可以開始解析擷取資料。

2.這個RPC簡單在於沒有考慮參數裡有函數類型的情況，例如有參數是一個object，這個object下有函數成員，JSON序列化時會把函數忽略，在server端是執行不了這個函數的。

為了解決這個問題，需要進行複雜的處理：

1.深度遍歷每個要發送給遠端的參數，把函數成員抽出來，給這個函數生成唯一id，放到本地一個物件裡，把這個函數成員替換成這個id字串，並標識這個成員其實是一個函數。這樣這個物件就可以序列化送出去了。
2.server接收到調用，當要使用參數object裡的函數時，判斷到這是一個經過client處理過的函數，有一個id，把這個id發送回client端，並用同樣的方法把自身的回調函數id傳給client，等待client端的回呼。
3.client端接收到這個函式id，找到這個函式實體，調用，完成後根據server端給的回呼id傳回給server端
4.server端收到結果，找到回呼函數，繼續執行，完成。

函數的記錄方法可以用其他方式完成，大體思路就是把函數替換成可序列化的東西，記錄函數以便remote端調用時能在本地找到這個函數。可以參考dnode的實作。