Paperboy 项目技术文档

1. 安装指南

安装方式

Paperboy 是一个用于交付静态文件的 Node.js 模块。虽然该项目已经被推荐使用更新的模块 send，但如果你仍然希望使用 Paperboy，可以按照以下步骤进行安装。

1. 安装 Node.js：首先，确保你已经安装了 Node.js。你可以从 Node.js 官方网站 下载并安装。

2. 安装 Paperboy： 打开终端或命令行工具，运行以下命令来安装 Paperboy：

   npm install paperboy
   

3. 验证安装： 安装完成后，你可以通过以下命令验证是否安装成功：

   npm list paperboy
   

2. 项目的使用说明

基本使用

Paperboy 模块允许你通过简单的配置来交付静态文件。以下是一个基本的使用示例：

var path = require('path');
var http = require('http');
var paperboy = require('paperboy');

var PORT = 8003;
var WEBROOT = path.join(path.dirname(__filename), 'webroot');

http.createServer(function(req, res) {
  var ip = req.connection.remoteAddress;
  paperboy
    .deliver(WEBROOT, req, res)
    .addHeader('Expires', 300)
    .addHeader('X-PaperRoute', 'Node')
    .before(function() {
      console.log('Received Request');
    })
    .after(function(statCode) {
      log(statCode, req.url, ip);
    })
    .error(function(statCode, msg) {
      res.writeHead(statCode, {'Content-Type': 'text/plain'});
      res.end("Error " + statCode);
      log(statCode, req.url, ip, msg);
    })
    .otherwise(function(err) {
      res.writeHead(404, {'Content-Type': 'text/plain'});
      res.end("Error 404: File not found");
      log(404, req.url, ip, err);
    });
}).listen(PORT);

function log(statCode, url, ip, err) {
  var logStr = statCode + ' - ' + url + ' - ' + ip;
  if (err)
    logStr += ' - ' + err;
  console.log(logStr);
}

关键步骤解释

• deliver(webroot, req, res)：指定静态文件的根目录，并处理 HTTP 请求和响应。
• addHeader(name, value)：添加自定义的 HTTP 头。
• before(callback())：在文件交付前触发的回调函数。
• after(callback(statCode))：在文件成功交付后触发的回调函数。
• error(callback(statCode, msg))：在文件交付过程中发生错误时触发的回调函数。
• otherwise(callback(err))：当找不到匹配的文件时触发的回调函数。

3. 项目 API 使用文档

paperboy.deliver(webroot, req, res)

• 参数：
  • webroot：静态文件的根目录路径。
  • req：HTTP 请求对象。
  • res：HTTP 响应对象。
• 返回值：返回一个对象，包含多个可链式调用的函数，用于自定义文件交付行为。

before(callback())

• 功能：在文件交付前触发。
• 回调参数：无。
• 返回值：如果回调函数返回 false，则取消文件交付。

after(callback(statCode))

• 功能：在文件成功交付后触发。
• 回调参数：statCode（HTTP 状态码）。

error(callback(statCode, msg))

• 功能：在文件交付过程中发生错误时触发。
• 回调参数：statCode（HTTP 状态码），msg（错误信息）。

otherwise(callback(err))

• 功能：当找不到匹配的文件时触发。
• 回调参数：err（错误信息）。

addHeader(name, value)

• 功能：添加自定义的 HTTP 头。
• 参数：
  • name：头名称。
  • value：头值。

4. 项目安装方式

通过 npm 安装

npm install paperboy

验证安装

npm list paperboy

通过以上步骤，你可以成功安装并使用 Paperboy 模块来交付静态文件。