nodejs学习笔记

本文内容摘自七天学会NodeJS，摘抄内容只是本人觉得比较重要或者还没有理解的

模块

编写稍大一点的程序时一般都会将代码模块化。在NodeJS中，一般将代码合理拆分到不同的JS文件中，每一个文件就是一个模块，而文件路径就是模块名。

在编写每个模块时，都有

require

、

exports

、

module

三个预先定义好的变量可供使用。

require

require

函数用于在当前模块中加载和使用别的模块，传入一个模块名，返回一个模块导出对象。模块名可使用相对路径（以

./

开头），或者是绝对路径（以

/

或

C:

之类的盘符开头）。另外，模块名中的

.js

扩展名可以省略。以下是一个例子。

var foo1 = require('./foo');
var foo2 = require('./foo.js');
var foo3 = require('/home/user/foo');
var foo4 = require('/home/user/foo.js');

// foo1至foo4中保存的是同一个模块的导出对象。

另外，可以使用以下方式加载和使用一个JSON文件。

var data = require('./data.json');

exports

exports

对象是当前模块的导出对象，用于导出模块公有方法和属性。别的模块通过

require

函数使用当前模块时得到的就是当前模块的

exports

对象。以下例子中导出了一个公有方法。

exports.hello = function () {
console.log('Hello World!');
};

module

通过

module

对象可以访问到当前模块的一些相关信息，但最多的用途是替换当前模块的导出对象。例如模块导出对象默认是一个普通对象，如果想改成一个函数的话，可以使用以下方式。

module.exports = function () {
console.log('Hello World!');
};

以上代码中，模块默认导出对象被替换为一个函数。

模块初始化

一个模块中的JS代码仅在模块第一次被使用时执行一次，并在执行过程中初始化模块的导出对象。之后，缓存起来的导出对象被重复利用。

包（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/cat/main')

能达到目的，但是入口模块名称出现在路径里看上去不是个好主意。因此我们需要做点额外的工作，让包使用起来更像是单个模块。

index.js

当模块的文件名是

index.js

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

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

这样处理后，就只需要把包目录路径传递给

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

找到入口模块所在位置。

Windows

在Windows系统下的做法完全不同，我们得靠

.cmd

文件来解决问题。假设

node-echo.js

存放在

C:\Users\user\bin

目录，并且该目录已经添加到PATH环境变量里了。接下来需要在该目录下新建一个名为

node-echo.cmd

的文件，文件内容如下：

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

这样处理后，我们就可以在任何目录下使用

node-echo

命令了。

NPM

下载三方包

以上命令默认下载最新版三方包，如果想要下载指定版本的话，可以在包名后边加上

@<version>

，例如通过以下命令可下载0.0.1版的

argv

。

$ npm install argv@0.0.1
...
argv@0.0.1 node_modules\argv

如果使用到的三方包比较多，在终端下一个包一条命令地安装未免太人肉了。因此NPM对

package.json

的字段做了扩展，允许在其中申明三方包依赖。因此，上边例子中的

package.json

可以改写如下：

{
"name": "node-echo",
"main": "./lib/echo.js",
"dependencies": {
"argv": "0.0.2"
}
}

这样处理后，在工程目录下就可以使用

npm install

命令批量安装三方包了。更重要的是，当以后

node-echo

也上传到了NPM服务器，别人下载这个包时，NPM会根据包中申明的三方包依赖自动下载进一步依赖的三方包。例如，使用

npm install node-echo

命令时，NPM会自动创建以下目录结构。

- project/
- node_modules/
- node-echo/
- node_modules/
+ argv/
...
...

如此一来，用户只需关心自己直接使用的三方包，不需要自己去解决所有包的依赖关系。

发布代码

第一次使用NPM发布代码前需要注册一个账号。终端下运行

npm adduser

，之后按照提示做即可。账号搞定后，接着我们需要编辑

package.json

文件，加入NPM必需的字段。接着上边

node-echo

的例子，

package.json

里必要的字段如下。

{
"name": "node-echo",           # 包名，在NPM服务器上须要保持唯一
"version": "1.0.0",            # 当前版本号
"dependencies": {              # 三方包依赖，需要指定包名和版本号
"argv": "0.0.2"
},
"main": "./lib/echo.js",       # 入口模块位置
"bin" : {
"node-echo": "./bin/node-echo"      # 命令行程序名和主模块位置
}
}

之后，我们就可以在

package.json

所在目录下运行

npm publish

发布代码了。

版本号

使用NPM下载和发布代码时都会接触到版本号。NPM使用语义版本号来管理代码，这里简单介绍一下。

语义版本号分为

X.Y.Z

三位，分别代表主版本号、次版本号和补丁版本号。当代码变更时，版本号按以下原则更新。

+ 如果只是修复bug，需要更新Z位。

+ 如果是新增了功能，但是向下兼容，需要更新Y位。

+ 如果有大变动，向下不兼容，需要更新X位。

版本号有了这个保证后，在申明三方包依赖时，除了可依赖于一个固定版本号外，还可依赖于某个范围的版本号。例如

"argv": "0.0.x"

表示依赖于

0.0.x

系列的最新版

argv

。NPM支持的所有版本号范围指定方式可以查看官方文档。

除了本章介绍的部分外，NPM还提供了很多功能，

package.json

里也有很多其它有用的字段。除了可以在npmjs.org/doc/查看官方文档外，这里再介绍一些NPM常用命令。

NPM提供了很多命令，例如

install

和

publish

，使用

npm help

可查看所有命令。

使用

npm help <command>

可查看某条命令的详细帮助，例如

npm help install

。

在

package.json

所在目录下使用

npm install . -g

可先在本地安装当前命令行程序，可用于发布前的本地测试。

使用

npm update <package>

可以把当前目录下

node_modules

子目录里边的对应模块更新至最新版本。

使用

npm update <package> -g

可以把全局安装的对应命令行程序更新至最新版。

使用

npm cache clear

可以清空NPM本地缓存，用于对付使用相同版本号发布新版本代码的人。

使用

npm unpublish <package>@<version>

可以撤销发布自己发布过的某个版本代码。

url

format

方法允许将一个URL对象转换为URL字符串，示例如下。

url.format({
protocol: 'http:',
host: 'www.example.com',
pathname: '/p/a/t/h',
search: 'query=string'
});
/* =>
'http://www.example.com/p/a/t/h?query=string'
*/

另外，

.resolve

方法可以用于拼接URL，示例如下。

url.resolve('http://www.example.com/foo/bar', '../baz');
/* => http://www.example.com/baz */