简析 Node.js 的 FastCGI 实现

本文是我最近对Node.js学习过程中产生的一个想法，提出来和大家一起探讨。

##Node.js的HTTP服务器使用Node.js可以非常容易的实现一个http服务，最简的例子如官方网站的示例：

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'); 

这样就快速的搭建了一个监听在1337端口所有http请求的web服务。但是，在真正的生产环境中，我们一般很少直接使用Node.js作为面向用户的最前端web服务器，原因主要有以下几种：

• 基于Node.js单线程特性的原因，其健壮性的保证对开发人员要求比较高。
• 服务器上可能已有其他http服务已占用80端口，而非80端口的web服务对用户显然不够友好。
• Node.js对文件IO处理并没太大优势，如作为常规网站可能需同时响应图片等文件资源。
• 分布式负载场景也是一个挑战。

所以，使用Node.js作为web服务更多可能是作为游戏服务器接口等类似场景，大多是处理不需用户直接访问且仅作数据交换的服务。

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;  } }  

这样就比较好的解决了上面提出的几个问题。

##使用FastCGI协议通讯

###什么是FastCGI

FastCGI产生的背景是用来作为cgi web应用的替代方案，一个最明显的特点是一个FastCGI服务进程可以用来处理一连串的请求，web服务器会把环境变量和这个页面请求通过一个socket比如FastCGI进程与web服务器连接起来，连接可用Unix Domain Socket或是一个TCP/IP连接。关于更多的背景知识可以参考 Wikipedia的词条 。

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

新建一个文件 node_fcgi.js ，内容如下：

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);     }); }); 

然后运行（因为权限的原因，请保证Nginx和node脚本使用同一用户或有相互权限的帐号运行，不然读写sock文件会遇到权限问题）：

node node_fcgi.js 

在浏览器访问，我们看到运行node脚本的终端正常的接收到了数据内容，比如这样：

这就证明我们的理论基础已经实现了第一步，接下来只需要搞清楚这个buffer的内容如何解析就行了。

##FastCGI协议基础FastCGI记录由一个定长前缀后跟可变数量的内容和填充字节组成。记录结构如下：

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协议版本，现在默认就用 1 就好
• type ：记录类型，其实可以当做是不同状态，后面具体说
• requestId ：请求id，返回时需对应，如果不是多路复用并发的情况，这里直接用 1 就好
• contentLength ：内容长度，这里最大长度是65535
• paddingLength ：填充长度，作用就是长数据填充为满8字节的整数倍，主要是用来更有效地处理保持对齐的数据，主要是性能考虑
• reserved ：保留字节，为了后续扩展
• contentData ：真正的内容数据，一会具体说
• paddingData ：填充数据，反正都是0，直接忽略就好。

具体的结构和说明请参考 官网文档 。

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){  })(); }  

#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) 

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;  

对应的实现js方法示例：

function parseParams(body){  var j = 0,   params = {},   length = body.length;  while(j < length){   var name,    value,    nameLength,    valueLength;   if(body[j] >> 7 == 1){    nameLength = ((body[j++] & 0x7f) << 24) + (body[j++] << 16) + (body[j++] << 8) + body[j++];   } else {    nameLength = body[j++];   }   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; }  

这样就实现了一个简单可获取各种参数和环境变量的方法。完善前面的代码，演示我们如何获取客户端ip：

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);     }   }  })(); }  

到现在我们已经了解了FastCGI请求部分的基础，下面接着将响应部分的实现，并最终完成一个简单的echo应答服务。

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()]);  }; })();  

在最简单的情况下，这样就可以发送一个完整的响应了。把我们最终的代码修改一下：

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 || '亲爱的朋友') + '！你是本站第' + visitors + '位用户哦~');    sock.write(ret);    ret = null;    sock.end();   ...  });  

##对比测试最后，我们需要考虑的问题是这个方案具体是否具有可行性？可能已经有同学看出了问题，我先把简单的压测结果放上来：

为什么proxy方式反而会优于FastCGI方式呢？那是因为在proxy方案下后端服务是直接由Node.js原生模块跑的，而FastCGI方案是我们自己使用JavaScrip实现的。不过，也可以看出两者方案效率上并没有很大的差距（当然，这里对比的只是简单的情况，如果在真正的业务场景下，差距应该会更大），并且如果Node.js原生支持FastCGI服务，那么效率上应该会更优。