Node 代码的组织和部署

 

 

使用NodeJS编写程序前，为了有个良好的开端。

首先需要准备好代码的目录结构和部署方式，就如同修房子要先搭脚手架。

 

模块路径解析规则

　　每一个文件就是一个模块，而文件路径就是模块名。

　　模块的查找顺序

　　1　内置模块

　　2　node_modules目录

　　3　NODE_PATH环境变量

 

包（package）

　　把由多个子模块组成的大模块称做包

　　入口: 　　入口模块的导出对象被作为包的导出对象。

　　

　　index.js

　　当模块的文件名是 index.js ，加载模块时可以使用模块所在目录的路径代替模块文件路径，因此接着上例，以下两条语句等价。

　　var cat = require('/home/user/lib/cat');
　　var cat = require('/home/user/lib/cat/index');

　　package.json

　　如果想自定义入口模块的文件名和存放位置，就需要在包目录下包含一个package.json文件，并在其中指定入口模块的路径。

- /home/user/lib/
    - cat/
        + doc/
        - lib/
            head.js
            body.js
            main.js
        + tests/
        package.json

其中package.json内容如下。自定入口为  main.js

{
    "name": "cat",
    "main": "./lib/main.js"
}

同样可以使用require('/home/user/lib/cat')的方式加载模块。NodeJS会根据包目录下的package.json找到入口模块所在位置

命令行程序

使用NodeJS编写的东西，要么是一个包，要么是一个命令行程序，而前者最终也会用于开发后者。

因此我们在部署代码时需要一些技巧，让用户觉得自己是在使用一个命令行程序。

例如我们用NodeJS写了个程序，可以把命令行参数原样打印出来。该程序很简单，在主模块内实现了所有功能。并且写好后，

我们把该程序部署在/home/user/bin/node-echo.js这个位置。为了在任何目录下都能运行该程序，我们需要使用以下终端命令。

$ node /home/user/bin/node-echo.js Hello World
Hello World

这种使用方式看起来不怎么像是一个命令行程序，下边的才是我们期望的方式。

$ node-echo Hello World

Linux

在Linux系统下，我们可以把JS文件当作shell脚本来运行，从而达到上述目的，具体步骤如下：

1. 1. 在shell脚本中，可以通过#!注释来指定当前脚本使用的解析器。所以我们首先在node-echo.js文件顶部增加以下一行注释，表明当前脚本使用NodeJS解析。

       #! /usr/bin/env node

      NodeJS会忽略掉位于JS模块首行的#!注释，不必担心这行注释是非法语句。

   2. 然后，我们使用以下命令赋予node-echo.js文件执行权限。

       $ chmod +x /home/user/bin/node-echo.js

   3. 最后，我们在PATH环境变量中指定的某个目录下，例如在/usr/local/bin下边创建一个软链文件，文件名与我们希望使用的终端命令同名，命令如下：

       $ sudo ln -s /home/user/bin/node-echo.js /usr/local/bin/node-echo

这样处理后，我们就可以在任何目录下使用node-echo命令了。

Windows

在Windows系统下的做法完全不同，我们得靠.cmd文件来解决问题。假设node-echo.js存放在C:\Users\user\bin目录，并且该目录已经添加到PATH环境变量里了。接下来需要在该目录下新建一个名为node-echo.cmd的文件，文件内容如下：

@node "C:\User\user\bin\node-echo.js" %*

这样处理后，我们就可以在任何目录下使用node-echo命令了。

工程目录

完整地规划一个工程目录了。以编写一个命令行程序为例，一般我们会同时提供命令行模式和API模式两种使用方式，并且我们会借助三方包来编写代码。除了代码外，一个完整的程序也应该有自己的文档和测试用例。因此，一个标准的工程目录都看起来像下边这样。

- /home/user/workspace/node-echo/   # 工程目录
    - bin/                          # 存放命令行相关代码
        node-echo
    + doc/                          # 存放文档
    - lib/                          # 存放API相关代码
        echo.js
    - node_modules/                 # 存放三方包
        + argv/
    + tests/                        # 存放测试用例
    package.json                    # 元数据文件
    README.md                       # 说明文件

其中部分文件内容如下：

/* bin/node-echo */
var argv = require('argv'),
    echo = require('../lib/echo');
console.log(echo(argv.join(' ')));

/* lib/echo.js */
module.exports = function (message) {
    return message;
};

/* package.json */
{
    "name": "node-echo",
    "main": "./lib/echo.js"
}

以上例子中分类存放了不同类型的文件，并通过node_moudles目录直接使用三方包名加载模块。

此外，定义了package.json之后，node-echo目录也可被当作一个包来使用。