Node-Static 技术文档

本文档将详细介绍如何安装、使用和操作 node-static 模块，该模块是一个简单的、遵循 RFC 2616 标准的文件流模块，适用于 Node.js 环境。

1. 安装指南

首先，确保您的系统中已安装了 Node.js。接下来，通过以下命令安装 node-static：

npm install node-static

2. 项目的使用说明

node-static 可以通过 CommonJS 或 ESM (ECMAScript Module) 方式导入使用。

CommonJS 方式

const statik = require('node-static');

ESM 方式

import { Server, version, mime } from 'node-static';

创建一个 node-static 服务器实例，以服务指定的文件夹。以下示例将服务 ./public 文件夹：

const file = new statik.Server('./public');

require('http').createServer(function (request, response) {
    request.addListener('end', function () {
        file.serve(request, response);
    }).resume();
}).listen(8080);

服务器将在端口 8080 上运行，并服务于指定目录下的静态文件。

3. 项目API使用文档

创建 node-static 服务器实例

创建文件服务器实例非常简单：

new statik.Server();

如果您想服务于特定的目录，可以传递该目录作为第一个参数：

new statik.Server('./public');

您还可以指定客户端应该缓存文件多长时间：

new statik.Server('./public', { cache: 3600 });

这将设置 Cache-Control 头，告诉客户端缓存文件一小时。这是默认设置。

选项

以下是创建 Server 实例时可以使用的选项：

• cache (默认: 3600)：设置 Cache-Control 头。
• serverInfo (默认: node-static/{version})：设置 Server 头。
• headers (默认: {})：设置响应头。
• gzip (默认: false)：启用压缩响应支持。
• indexFile (默认: index.html)：选择自定义索引文件。
• defaultExtension (默认: null)：选择默认扩展名。

4. 项目安装方式

node-static 支持通过命令行界面 (CLI) 进行快速安装和配置。以下是 CLI 的使用方式：

# 启动 CLI
static

以下是一些常用的 CLI 选项：

• --port, -p：设置服务端口，默认为 8080。
• --host-address, -a：设置监听的本地网络接口，默认为 127.0.0.1。
• --cache, -c：设置缓存头，默认为 3600。
• --version, -v：显示 node-static 版本。
• --headers, -H：设置额外的头信息。
• --gzip, -z：启用压缩。
• --spa：将内容作为单页应用提供服务。
• --indexFile, -i：指定自定义索引文件。
• --help, -h：显示帮助信息。

例如，要在一个特定目录下启动服务器，并设置额外的头信息，可以使用以下命令：

static public -H '{"Cache-Control": "no-cache, must-revalidate"}'