代码的组织与部署

使用node编写程序，要有一个良好的开端，要考虑到代码结构、部署方式等方面。本节会阐述一下

模块路径解析规则

如nodejs基础所述，require后通过路径，找到对应的模块。其中可以是./相对路径，也可以是C:/绝对路径，也可以是require（’fs‘）方式。下面我们一个个的对其讲解下：

内置模块

如果传递进去的是内置模块，不做路径解析，直接返回导出对象，如require（“fs’）
node_modules目录

nodejs定义了一个node_modules存放目录，例如某个模块绝对路径是/home/user/hello.js,其内部引用foo/bar, 则require（‘foo/bar’），其查找路径分别是
```
/home/user/node_modules/foo/bar
/home/node_modules/foo/bar
/node_modules/foo/bar
```
若还是找不到，则报错
node_path环境变量

与path环境变量一样，NodeJS允许通过NODE_PATH环境变量来指定额外的模块搜索路径。如下
```
NODE_PATH=/home/user/lib:/home/lib
```
当使用require('foo/bar')方式加载模块时，node尝试以下路径查找
```
/home/user/lib/foo/bar
/home/lib/foo/bar
```
其加载时机是发生在从项目的根位置递归搜寻 node_modules 目录，直到文件系统根目录的 node_modules，如果还没有查找到指定模块的话，就会去 NODE_PATH中注册的路径中查找。

包

js的基本模块单位是单个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/cat/main')能达到目的，但是入口模块名称出现在路径里看上去不是个好主意。因此我们需要做点额外的工作，让包使用起来更像是单个模块。

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

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

这样处理后，就只需要把包目录路径传递给require函数，感觉上整个目录被当作单个模块使用，更有整体感。

如果想自定义入口模块的文件名和存放位置，就需要在包目录下包含一个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找到入口模块所在位置。

xiaokeqi / i-learned

7天学会nodejs-day2 #38

代码的组织与部署

模块路径解析规则

包