FastCGI 解析器技术文档

本文档将详细介绍如何安装、使用以及FastCGI协议解析器API的调用方式。

1. 安装指南

环境要求

• Node.js 环境已安装

安装步骤

通过 npm 安装 FastCGI 解析器模块：

npm install fastcgi-parser

2. 项目使用说明

本项目是一个基础的 FastCGI 解析器，适用于对 FastCGI 协议进行底层解析。可以用来构建由现有 Web 服务器（如 nginx、lighttpd、apache 等）调用的 FastCGI 应用程序，或与 FastCGI 应用程序进行交互。

服务器配置

Lighttpd 配置示例

fastcgi.server = ( ".js" =>
    ( "localhost" =>
        (
            "socket" => "/tmp/nginx.sock",
            "check-local" => "disable"
        )
    )
)

nginx 配置示例

location ~ \.js$ {
    fastcgi_pass   unix:/tmp/nginx.sock;
    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
}

3. 项目API使用文档

FastCGI 解析器

• parser.encoding: 设置解析器使用的编码方式，可选值有 utf8、ascii、binary。默认为 utf8。
• parser.reset(): 重置解析器，以便在新流上执行。在发生错误或重用现有解析器时使用。
• parser.init(): 完全重新初始化解析器。调用 parser.reset() 并将编码设置回默认值（utf8）并清除所有回调处理程序。
• parser.execute(buffer): 解析缓冲区并调用回调函数。

FastCGI 常量

本项目定义了一系列 FastCGI 常量，包括版本、记录类型、协议状态等。以下是一些示例：

• FCGI_VERSION: 协议版本，值为 1。
• FCGI_BEGIN: 开始记录类型，值为 1。
• FCGI_END: 结束记录类型，值为 3。
• FCGI_MAX_BODY: 最大请求体大小，为 2^16。

更多常量请参考项目文档。

4. 项目安装方式

项目安装方式已在“安装指南”部分详细说明，请参考上述步骤进行安装。

通过以上文档，用户应能够成功安装本项目，并了解如何使用以及如何通过API调用进行 FastCGI 协议的解析。