Ni 项目技术文档

1. 安装指南

1.1 获取 Ni

你可以通过以下两种方式获取 Ni：

• 下载源代码
• 使用 git clone 命令克隆仓库

1.2 安装 Ni

将 lib/ni.js 文件复制到你的 ~/.node_libraries 目录下，或者使用 npm install 命令安装 Ni（即将支持）。

1.3 运行示例项目

1. 复制 /example 目录并根据需要进行修改。
2. 在复制的目录中运行 node app.js 启动服务器。

2. 项目的使用说明

2.1 项目结构

Ni 帮助你设置一个结构良好的项目，文件结构分为模型、视图、控制器、库和助手。每个部分都作为一个 Node 模块进行组织。

2.2 启动 Ni

使用 Ni 非常简单，只需告诉 Ni 在哪里查找你的文件，然后启动它：

var Ni = require('../lib/ni');

Ni.config('root', "myapp/src");

Ni.boot(function() {
    // 准备启动服务器
});

2.3 访问模型、视图和控制器

在你的代码中，可以通过以下方式访问模型、视图和控制器：

• Ni.model('MODELNAME')
• Ni.view('VIEWNAME')
• Ni.controller('CONTROLLERNAME')

2.4 路由

Ni 提供了一个路由器，可以与 Connect 一起使用，根据 URL 段将请求发送到适当的控制器函数。

var app = Connect.createServer(
    Ni.router
    // 你可以在这里添加其他 Connect 中间件
);

3. 项目API使用文档

3.1 配置

Ni.config('root', "myapp/src");

设置项目根目录。

3.2 启动

Ni.boot(function() { ... });

启动 Ni，准备启动服务器。

3.3 访问模型、视图和控制器

• Ni.model('MODELNAME')
• Ni.view('VIEWNAME')
• Ni.controller('CONTROLLERNAME')

3.4 添加自定义路由

Ni.addRoute(source, destination, [method])

示例：

Ni.addRoute('/', '/News/index');
Ni.addRoute(/^\/register/i, '/User/register');
Ni.addRoute(/^\/details\/(.*)$/i, '/User/details/$1');

3.5 路由函数

你可以定义函数来测试路径：

Ni.addRoute(function(path) {
    var args = path.split('/'),
    firstNum = parseInt(args[2]),
    secondNum = parseInt(args[3]),
    result = firstNum + secondNum;
    if (args[1] !== 'add')
        return false;
    return result > 0 ? '/Number/positive' : '/Number/negative';
});

4. 项目安装方式

4.1 手动安装

1. 下载或克隆 Ni 仓库。
2. 将 lib/ni.js 文件复制到 ~/.node_libraries 目录下。
3. 复制 /example 目录并根据需要进行修改。
4. 运行 node app.js 启动服务器。

4.2 使用 npm（即将支持）

未来将支持通过 npm install 命令安装 Ni。