Journey 项目技术文档

本文档旨在帮助用户安装、使用并深入了解 Journey 项目，一个为 Node.js 设计的快速且灵活的 JSON-only HTTP 请求路由器。

1. 安装指南

要安装 Journey，请使用以下命令：

$ npm install journey

确保您的系统中已经安装了 Node.js 和 npm。

2. 项目的使用说明

Journey 项目用于处理 HTTP 请求，并将它们路由到相应的处理函数。以下是一个基本的示例，展示了如何创建一个路由器并定义一些路由：

var journey = require('journey');

// 创建一个路由器
var router = new journey.Router;

// 定义路由表
router.map(function () {
    this.root.bind(function (req, res) { res.send("Welcome") });
    this.get(/^trolls\/([0-9]+)$/).bind(function (req, res, id) {
        // 这里可以添加数据库查询逻辑
        res.send(200, {}, {id: id});
    });
    this.post('/trolls').bind(function (req, res, data) {
        // 这里可以添加数据库写入逻辑
        res.send(200);
    });
});

// 创建 HTTP 服务器并监听 8080 端口
require('http').createServer(function (request, response) {
    var body = "";
    request.addListener('data', function (chunk) { body += chunk });
    request.addListener('end', function () {
        router.handle(request, body, function (result) {
            response.writeHead(result.status, result.headers);
            response.end(result.body);
        });
    });
}).listen(8080);

在这个例子中，router.map 方法用于定义路由，bind 方法用于将路由绑定到处理函数。处理函数接收请求对象、响应对象和任何捕获的路由参数。

3. 项目API使用文档

以下是一些基本 API 的使用说明：

创建路由器

var router = new journey.Router;

定义路由

router.get('/hello').bind(function (req, res) { res.send('Hi there!') });
router.put('/candles').bind(function (req, res) { ... });

处理请求

router.handle(request, body, function (result) {
    response.writeHead(result.status, result.headers);
    response.end(result.body);
});

发送响应

res.send(404);              // 发送 404 状态码
res.send("Welcome");        // 发送 200 状态码和文本消息
res.send({hello:"world"});  // 发送 200 状态码和 JSON 对象

获取 URL 参数

router.get('/users').bind(function (req, res, params) {
    params.limit; // 获取 URL 参数
});

获取捕获的路由参数

router.get(/^([a-z]+)\/([0-9]+)$/).bind(function (req, res, resource, id, params) {
    res;      // 响应对象
    resource; // 资源名称
    id;       // 资源 ID
    params;   // URL 参数
});

定义路径

router.path('/domain', function () {
    this.get();        // 匹配 'GET /domain'
    this.root;         // 匹配 'GET /domain/'
    this.get('/info'); // 匹配 'GET /domain/info'
});

使用过滤器

function authorize (request, body, cb) {
    return request.headers.authorized === true
        ? cb(null)
        : cb(new journey.NotAuthorized('Not Authorized'));
}

router.map(function () {
    this.get('/authorized').filter(authorize).bind(function (req, res, params) {
        // 经过授权的请求处理
    });
});

4. 项目安装方式

Journey 可以通过 npm 包管理器安装：

$ npm install journey

确保您的 Node.js 环境已经安装了 npm。在安装 Journey 之后，您可以在项目中 require 它并开始使用。

以上就是关于 Journey 项目的详细技术文档。希望这些信息能够帮助您更好地理解和使用这个项目。