NodeJS学习笔记【代码的组织和部署】

December 26 , 2014

使用NodeJS编写程序前,为了有个良好的开端,首先需要准备好代码的目录结构和部署方式。这里讲介绍与之相关的各种知识。


模块路径解析规则

在上篇笔记中了解到,require函数支持斜杠(/)或盘符(C:)开头的绝对路径,也支持./开头的相对路径。

但是这两种路径在模块之间建立了强耦合关系,一旦某个模块文件位置需要更变,使用该模块的其他模块代码页需要跟着调整,变得牵一发动全身。

因此,require函数支持第三种形式的路径,写法类似于foo/bar,并依次按照以下规律解析路径,直到找到模块位置。

1.内置模块

如果传递给require函数的是NodeJS内置模块名称,不做路径解析,直接返回内部模块的导出对象。 例如:require('fs')

2.node_modules目录

NodeJS定义了一个特殊的node_modules目录用于存放模块。

例如某个模块的绝对路径是/home/user/hello.js,在该模块中使用require('foo/bar')方式加载模块时,则NodeJS依次尝试使用以下路径。

 /home/user/node_modules/foo/bar
 /home/node_modules/foo/bar
 /node_modules/foo/bar

3.NODE_PATH环境变量

与PATH环境变量类似,NodeJS允许通过NODE_PATH环境变量来指定额外的模块搜索路径。NODE_PATH环境变量中包含一到多个目录路径,路径之间在Linux下使用:分隔,在Windows下使用;分隔。

例如定义了以下NODE_PATH环境变量:

 NODE_PATH=/home/user/lib:/home/lib

当使用require('foo/bar')的方式加载模块时,则NodeJS依次尝试以下路径。

 /home/user/lib/foo/bar
 /home/lib/foo/bar

包(package)

JS模块的基本单位是单个JS文件,但是复杂些的模块往往由多个子模块组成。为了便于管理和使用,我们可以把多个子模块组成的大模块称作,并把所有子模块放在同一个目录里。

在组成一个包的所有子模块中,需要有一个入口模块,入口模块的导出对象被作为包的导出对象。例如有以下目录结构。

- /home/user/lib/
    - cat/
        head.js
        body.js
        main.js

其中cat目录定义了一个包,其中包含了3个子模块。main.js作为入口模块,内容如下:

var head = require('./head');
var body = require('./body');

exports.create = function (name) {
    return {
        name: name,
        head: head.create(),
        body: body.create()
    };
};

在其他模块中使用包的时候,需要加载包的入口模块。

使用require('/home/user/lib/main')能达到目的,但是入口模块名称出现在路径里看上去不是很好。因此我们要让包使用起来更像是单个模块。

index.js

当模块的文件名是index.js,加载模块时可以视同模块所在目录的路径代替模块文件路径,即:

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

这里2条语句是等价的。这样处理后,就只需要把包目录路径传递给require函数,感觉上整个目录被当作单个模块使用,更有整体感。

package.json

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

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

其中package.json内容如下:

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

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

发表评论

(请不要填写空的评论)
提交评论 使用QQ登录