使用Node.js實(shí)現(xiàn)一個(gè)簡(jiǎn)單的FastCGI服務(wù)器實(shí)例

更新時(shí)間：2014年06月09日 08:50:07 作者：

這篇文章主要介紹了使用Node.js實(shí)現(xiàn)一個(gè)簡(jiǎn)單的FastCGI服務(wù)器實(shí)例,也可以作為一個(gè)比較詳細(xì)的Node.js服務(wù)器創(chuàng)建教程,需要的朋友可以參考下

本文是我最近對(duì)Node.js學(xué)習(xí)過(guò)程中產(chǎn)生的一個(gè)想法，提出來(lái)和大家一起探討。

Node.js的HTTP服務(wù)器

使用Node.js可以非常容易的實(shí)現(xiàn)一個(gè)http服務(wù)，最簡(jiǎn)的例子如官方網(wǎng)站的示例：

復(fù)制代碼代碼如下:

var http = require('http');
http.createServer(function (req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.end('Hello World\n');
}).listen(1337, '127.0.0.1');

這樣就快速的搭建了一個(gè)監(jiān)聽(tīng)在1337端口所有http請(qǐng)求的web服務(wù)。
但是，在真正的生產(chǎn)環(huán)境中，我們一般很少直接使用Node.js作為面向用戶的最前端web服務(wù)器，原因主要有以下幾種：

1.基于Node.js單線程特性的原因，其健壯性的保證對(duì)開(kāi)發(fā)人員要求比較高。
2.服務(wù)器上可能已有其他http服務(wù)已占用80端口，而非80端口的web服務(wù)對(duì)用戶顯然不夠友好。
3.Node.js對(duì)文件IO處理并沒(méi)太大優(yōu)勢(shì)，如作為常規(guī)網(wǎng)站可能需同時(shí)響應(yīng)圖片等文件資源。
4.分布式負(fù)載場(chǎng)景也是一個(gè)挑戰(zhàn)。

所以，使用Node.js作為web服務(wù)更多可能是作為游戲服務(wù)器接口等類似場(chǎng)景，大多是處理不需用戶直接訪問(wèn)且僅作數(shù)據(jù)交換的服務(wù)。

基于Nginx作為前端機(jī)的Node.js web服務(wù)

基于上述原因，如果是使用Node.js搭建的網(wǎng)站形的產(chǎn)品，常規(guī)的使用方式是在Node.js的web服務(wù)前端放置另一個(gè)成熟的http服務(wù)器，如最常使用的是Nginx。
然后使用Nginx作為反向代理訪問(wèn)基于Node.js的web服務(wù)。如：

復(fù)制代碼代碼如下:

server{
    listen 80;
    server_name yekai.me;
    root /home/andy/wwwroot/yekai;

    location / {
        proxy_pass http://127.0.0.1:1337;
    }

    location ~ \.(gif|jpg|png|swf|ico|css|js)$ {
        root /home/andy/wwwroot/yekai/static;
    }
}

這樣就比較好的解決了上面提出的幾個(gè)問(wèn)題。

使用FastCGI協(xié)議通訊

不過(guò)，上述代理的方式也有一些不是很好的地方。
一個(gè)是有可能的場(chǎng)景是需要控制后面的Node.js的web服務(wù)的直接http訪問(wèn)。不過(guò)，要解決的話也可以使用自身的服務(wù)或者依靠防火墻阻擋。
另外一個(gè)是因?yàn)榇淼姆绞疆吘故蔷W(wǎng)絡(luò)應(yīng)用層上的方案，也不是很方便直接獲取和處理與客戶端http交互的數(shù)據(jù)，比如對(duì)keep-alive、trunk甚至cookie等的處理。當(dāng)然這也與代理服務(wù)器自身的能力和功能完善程度相關(guān)。
所以，我在想嘗試另外一種處理方式，首先想到的就是現(xiàn)在在php web應(yīng)用上普遍使用的FastCGI的方式。

什么是FastCGI

快速通用網(wǎng)關(guān)接口（Fast Common Gateway Interface／FastCGI）是一種讓交互程序與Web服務(wù)器通信的協(xié)議。

FastCGI產(chǎn)生的背景是用來(lái)作為cgi web應(yīng)用的替代方案，一個(gè)最明顯的特點(diǎn)是一個(gè)FastCGI服務(wù)進(jìn)程可以用來(lái)處理一連串的請(qǐng)求，web服務(wù)器會(huì)把環(huán)境變量和這個(gè)頁(yè)面請(qǐng)求通過(guò)一個(gè)socket比如FastCGI進(jìn)程與web服務(wù)器連接起來(lái)，連接可用Unix Domain Socket或是一個(gè)TCP/IP連接。關(guān)于更多的背景知識(shí)可以參考Wikipedia的詞條。

Node.js的FastCGI實(shí)現(xiàn)

那么理論上我們只需要使用Node.js創(chuàng)建一個(gè)FastCGI進(jìn)程，再指定Nginx的監(jiān)聽(tīng)請(qǐng)求發(fā)送到這個(gè)進(jìn)程就行了。由于Nginx和Node.js都是基于事件驅(qū)動(dòng)的服務(wù)模型，“理論”上應(yīng)該是天作地合的解決方案。下面我們就親自實(shí)現(xiàn)一下。
在Node.js中net模塊剛好可用來(lái)建立一個(gè)socket服務(wù)，為了方便我們就選用unix socket的方式。
在Nginx端的配置稍微修改下：

復(fù)制代碼代碼如下:

...
location / {
    fastcgi_pass   unix:/tmp/node_fcgi.sock;
}
...

新建一個(gè)文件node_fcgi.js，內(nèi)容如下：

復(fù)制代碼代碼如下:

var net = require('net');

var server = net.createServer();
server.listen('/tmp/node_fcgi.sock');

server.on('connection', function(sock){
console.log('connection');

    sock.on('data', function(data){
        console.log(data);
    });
});

然后運(yùn)行（因?yàn)闄?quán)限的原因，請(qǐng)保證Nginx和node腳本使用同一用戶或有相互權(quán)限的帳號(hào)運(yùn)行，不然讀寫sock文件會(huì)遇到權(quán)限問(wèn)題）：

node node_fcgi.js

在瀏覽器訪問(wèn)，我們看到運(yùn)行node腳本的終端正常的接收到了數(shù)據(jù)內(nèi)容，比如這樣：

復(fù)制代碼代碼如下:

connection
< Buffer 01 01 00 01 00 08 00 00 00 01 00 00 00 00 00 00 01 04 00 01 01 87 01...>

這就證明我們的理論基礎(chǔ)已經(jīng)實(shí)現(xiàn)了第一步，接下來(lái)只需要搞清楚這個(gè)buffer的內(nèi)容如何解析就行了。

FastCGI協(xié)議基礎(chǔ)

FastCGI記錄由一個(gè)定長(zhǎng)前綴后跟可變數(shù)量的內(nèi)容和填充字節(jié)組成。記錄結(jié)構(gòu)如下：

復(fù)制代碼代碼如下:

typedef struct {
    unsigned char version;
    unsigned char type;
    unsigned char requestIdB1;
    unsigned char requestIdB0;
    unsigned char contentLengthB1;
    unsigned char contentLengthB0;
    unsigned char paddingLength;
    unsigned char reserved;
    unsigned char contentData[contentLength];
    unsigned char paddingData[paddingLength];
} FCGI_Record;

version ：FastCGI協(xié)議版本，現(xiàn)在默認(rèn)就用1就好
type ：記錄類型，其實(shí)可以當(dāng)做是不同狀態(tài)，后面具體說(shuō)
requestId ：請(qǐng)求id，返回時(shí)需對(duì)應(yīng)，如果不是多路復(fù)用并發(fā)的情況，這里直接用1就好
contentLength ：內(nèi)容長(zhǎng)度，這里最大長(zhǎng)度是65535
paddingLength ：填充長(zhǎng)度，作用就是長(zhǎng)數(shù)據(jù)填充為滿8字節(jié)的整數(shù)倍，主要是用來(lái)更有效地處理保持對(duì)齊的數(shù)據(jù)，主要是性能考慮
reserved ：保留字節(jié)，為了后續(xù)擴(kuò)展
contentData ：真正的內(nèi)容數(shù)據(jù)，一會(huì)具體說(shuō)
paddingData ：填充數(shù)據(jù)，反正都是0，直接忽略就好。

具體的結(jié)構(gòu)和說(shuō)明請(qǐng)參考官網(wǎng)文檔(http://www.fastcgi.com/devkit/doc/fcgi-spec.html#S3.3)。

請(qǐng)求部分

似乎好像很簡(jiǎn)單，就是這樣解析一次拿到數(shù)據(jù)就行了。不過(guò)，這里有一個(gè)坑，那就是這里定義的是數(shù)據(jù)單元（記錄）的結(jié)構(gòu)，并不是整個(gè)buffer的結(jié)構(gòu)，整個(gè)buffer由一個(gè)記錄一個(gè)記錄這樣的組成。一開(kāi)始可能對(duì)于我們習(xí)慣了前端開(kāi)發(fā)的同學(xué)不大好理解，但是這是理解FastCGI協(xié)議的基礎(chǔ)，后面還會(huì)看到更多例子。
所以，我們需要將一個(gè)記錄一個(gè)記錄單獨(dú)解析出來(lái)，根據(jù)前面拿到的type來(lái)區(qū)分記錄。這里是一個(gè)簡(jiǎn)單的獲取所有記錄的函數(shù)：

復(fù)制代碼代碼如下:

function getRcds(data, cb){
    var rcds = [],
        start = 0,
        length = data.length;
    return function (){
        if(start >= length){
            cb && cb(rcds);
            rcds = null;
            return;
        }
        var end = start + 8,
            header = data.slice(start, end),
            version = header[0],
            type    = header[1],
            requestId = (header[2] << 8) + header[3],
            contentLength = (header[4] << 8) + header[5],
            paddingLength = header[6];
        start = end + contentLength + paddingLength;

var body = contentLength ? data.slice(end, contentLength) : null;
rcds.push([type, body, requestId]);

        return arguments.callee();
    }
}
//使用
sock.on('data', function(data){
    getRcds(data, function(rcds){
    })();
}

注意這里只是簡(jiǎn)單處理，如果有上傳文件等復(fù)雜情況這個(gè)函數(shù)不適應(yīng)，為了最簡(jiǎn)演示就先簡(jiǎn)便處理了。同時(shí)，也忽略了requestId參數(shù)，如果是多路復(fù)用的情況下不能忽略，并且處理會(huì)需要復(fù)雜得多。
接下來(lái)就可以根據(jù)type來(lái)對(duì)不同的記錄進(jìn)行處理了。type的定義如下：

復(fù)制代碼代碼如下:

#define FCGI_BEGIN_REQUEST       1
#define FCGI_ABORT_REQUEST       2
#define FCGI_END_REQUEST         3
#define FCGI_PARAMS              4
#define FCGI_STDIN               5
#define FCGI_STDOUT              6
#define FCGI_STDERR              7
#define FCGI_DATA                8
#define FCGI_GET_VALUES          9
#define FCGI_GET_VALUES_RESULT  10
#define FCGI_UNKNOWN_TYPE       11
#define FCGI_MAXTYPE (FCGI_UNKNOWN_TYPE)

接下來(lái)就可以根據(jù)記錄的type來(lái)解析拿到真正的數(shù)據(jù)，下面我只拿最常用的FCGI_PARAMS、FCGI_GET_VALUES、FCGI_GET_VALUES_RESULT來(lái)說(shuō)明，好在他們的解析方式是一致的。其他type記錄的解析有自己不同的規(guī)則，可以參考規(guī)范的定義實(shí)現(xiàn)，我這里就不細(xì)說(shuō)了。
FCGI_PARAMS、FCGI_GET_VALUES、FCGI_GET_VALUES_RESULT都是“編碼名-值”類型數(shù)據(jù)，標(biāo)準(zhǔn)格式為：以名字長(zhǎng)度，后跟值的長(zhǎng)度，后跟名字，后跟值的形式傳送，其中127字節(jié)或更少的長(zhǎng)度能在一字節(jié)中編碼，而更長(zhǎng)的長(zhǎng)度總是在四字節(jié)中編碼。長(zhǎng)度的第一字節(jié)的高位指示長(zhǎng)度的編碼方式。高位為0意味著一個(gè)字節(jié)的編碼方式，1意味著四字節(jié)的編碼方式?？磦€(gè)綜合的例子，比如長(zhǎng)名短值的情況：

復(fù)制代碼代碼如下:

typedef struct {
    unsigned char nameLengthB3;  /* nameLengthB3  >> 7 == 1 */
    unsigned char nameLengthB2;
    unsigned char nameLengthB1;
    unsigned char nameLengthB0;
    unsigned char valueLengthB0; /* valueLengthB0 >> 7 == 0 */
    unsigned char nameData[nameLength
            ((B3 & 0x7f) << 24) + (B2 << 16) + (B1 << 8) + B0];
    unsigned char valueData[valueLength];
} FCGI_NameValuePair41;

對(duì)應(yīng)的實(shí)現(xiàn)js方法示例：

復(fù)制代碼代碼如下:

        if(body[j] >> 7 == 1){
            valueLength = ((body[j++] & 0x7f) << 24) + (body[j++] << 16) + (body[j++] << 8) + body[j++];
        } else {
            valueLength = body[j++];
        }

        var ret = body.asciiSlice(j, j + nameLength + valueLength);
        name = ret.substring(0, nameLength);
        value = ret.substring(nameLength);
        params[name] = value;

        j += (nameLength + valueLength);
    }
    return params;
}

這樣就實(shí)現(xiàn)了一個(gè)簡(jiǎn)單可獲取各種參數(shù)和環(huán)境變量的方法。完善前面的代碼，演示我們?nèi)绾潍@取客戶端ip：

復(fù)制代碼代碼如下:

sock.on('data', function(data){
    getRcds(data, function(rcds){
        for(var i = 0, l = rcds.length; i < l; i++){
            var bodyData = rcds[i],
                type = bodyData[0],
                body = bodyData[1];
            if(body && (type === TYPES.FCGI_PARAMS || type === TYPES.FCGI_GET_VALUES || type === TYPES.FCGI_GET_VALUES_RESULT)){
                    var params = parseParams(body);
                    console.log(params.REMOTE_ADDR);
                }
        }
    })();
}

到現(xiàn)在我們已經(jīng)了解了FastCGI請(qǐng)求部分的基礎(chǔ)，下面接著將響應(yīng)部分的實(shí)現(xiàn)，并最終完成一個(gè)簡(jiǎn)單的echo應(yīng)答服務(wù)。

響應(yīng)部分

響應(yīng)部分相對(duì)比較簡(jiǎn)單，最簡(jiǎn)單的情況只需要發(fā)送兩個(gè)記錄就行了，那就是FCGI_STDOUT和FCGI_END_REQUEST。
具體記錄實(shí)體的內(nèi)容就不冗述了，直接看代碼吧：

復(fù)制代碼代碼如下:

var res = (function(){
var MaxLength = Math.pow(2, 16);

    function buffer0(len){
        return new Buffer((new Array(len + 1)).join('\u0000'));
    };

    function writeStdout(data){
        var rcdStdoutHd = new Buffer(8),
            contendLength = data.length,
            paddingLength = 8 - contendLength % 8;

        rcdStdoutHd[0] = 1;
        rcdStdoutHd[1] = TYPES.FCGI_STDOUT;
        rcdStdoutHd[2] = 0;
        rcdStdoutHd[3] = 1;
        rcdStdoutHd[4] = contendLength >> 8;
        rcdStdoutHd[5] = contendLength;
        rcdStdoutHd[6] = paddingLength;
        rcdStdoutHd[7] = 0;

return Buffer.concat([rcdStdoutHd, data, buffer0(paddingLength)]);
};

    function writeHttpHead(){
        return writeStdout(new Buffer("HTTP/1.1 200 OK\r\nContent-Type:text/html; charset=utf-8\r\nConnection: close\r\n\r\n"));
    }

    function writeHttpBody(bodyStr){
        var bodyBuffer = [],
            body = new Buffer(bodyStr);
        for(var i = 0, l = body.length; i < l; i += MaxLength + 1){
            bodyBuffer.push(writeStdout(body.slice(i, i + MaxLength)));
        }
        return Buffer.concat(bodyBuffer);
    }

    function writeEnd(){
        var rcdEndHd = new Buffer(8);
        rcdEndHd[0] = 1;
        rcdEndHd[1] = TYPES.FCGI_END_REQUEST;
        rcdEndHd[2] = 0;
        rcdEndHd[3] = 1;
        rcdEndHd[4] = 0;
        rcdEndHd[5] = 8;
        rcdEndHd[6] = 0;
        rcdEndHd[7] = 0;
        return Buffer.concat([rcdEndHd, buffer0(8)]);
    }

    return function(data){
        return Buffer.concat([writeHttpHead(), writeHttpBody(data), writeEnd()]);
    };
})();

在最簡(jiǎn)單的情況下，這樣就可以發(fā)送一個(gè)完整的響應(yīng)了。把我們最終的代碼修改一下：

復(fù)制代碼代碼如下:

var visitors = 0;
server.on('connection', function(sock){
    visitors++;
    sock.on('data', function(data){
        ...
        var querys = querystring.parse(params.QUERY_STRING);
            var ret = res('歡迎你，' + (querys.name || '親愛(ài)的朋友') + '！你是本站第' + visitors + '位用戶哦~');
            sock.write(ret);
            ret = null;
            sock.end();
        ...
    });

打開(kāi)瀏覽器訪問(wèn)：http://domain/?name=yekai，可看到類似“歡迎你，yekai！你是本站第7位用戶哦~”。
至此，我們就成功的使用Node.js實(shí)現(xiàn)了一個(gè)最簡(jiǎn)單的FastCGI服務(wù)。如果需要作為真正的服務(wù)使用，接下來(lái)只需要對(duì)照協(xié)議規(guī)范完善我們的邏輯就行了。

對(duì)比測(cè)試

最后，我們需要考慮的問(wèn)題是這個(gè)方案具體是否具有可行性？可能已經(jīng)有同學(xué)看出了問(wèn)題，我先把簡(jiǎn)單的壓測(cè)結(jié)果放上來(lái)：

復(fù)制代碼代碼如下:

//FastCGI方式：
500 clients, running 10 sec.
Speed=27678 pages/min, 63277 bytes/sec.
Requests: 3295 susceed, 1318 failed.

500 clients, running 20 sec.
Speed=22131 pages/min, 63359 bytes/sec.
Requests: 6523 susceed, 854 failed.

//proxy方式：
500 clients, running 10 sec.
Speed=28752 pages/min, 73191 bytes/sec.
Requests: 3724 susceed, 1068 failed.

500 clients, running 20 sec.
Speed=26508 pages/min, 66267 bytes/sec.
Requests: 6716 susceed, 2120 failed.

//直接訪問(wèn)Node.js服務(wù)方式：
500 clients, running 10 sec.
Speed=101154 pages/min, 264247 bytes/sec.
Requests: 15729 susceed, 1130 failed.

500 clients, running 20 sec.
Speed=43791 pages/min, 115962 bytes/sec.
Requests: 13898 susceed, 699 failed.

為什么proxy方式反而會(huì)優(yōu)于FastCGI方式呢？那是因?yàn)樵趐roxy方案下后端服務(wù)是直接由Node.js原生模塊跑的，而FastCGI方案是我們自己使用JavaScrip實(shí)現(xiàn)的。不過(guò)，也可以看出兩者方案效率上并沒(méi)有很大的差距（當(dāng)然，這里對(duì)比的只是簡(jiǎn)單的情況，如果在真正的業(yè)務(wù)場(chǎng)景下，差距應(yīng)該會(huì)更大），并且如果Node.js原生支持FastCGI服務(wù)，那么效率上應(yīng)該會(huì)更優(yōu)。

后記

如果有興趣繼續(xù)玩的同學(xué)可以查看我本文實(shí)現(xiàn)的例子源碼，這兩天研究下了協(xié)議規(guī)范，其實(shí)不難。
同時(shí)，回頭準(zhǔn)備再玩玩uWSGI，不過(guò)官方說(shuō)v8已經(jīng)在準(zhǔn)備直接支持了。
玩得很淺，如有錯(cuò)誤歡迎指正交流。

您可能感興趣的文章: