NodeJS基础

JS是脚本语言，脚本语言都需要一个解析器才能运行，NodeJS就是一个解析器。nodejs.org

打开终端，键入node进入命令交互模式，可以输入一条代码语句后立即执行并显示结果

$node

>console('Hello World');

Hello World

如果要运行一大段代码的话，可以先写一个JS文件再运行。例如有以下hello.js

function hello() {

    console.log('Hello World!');

}

hello();

写好后在终端下键入node hello.js运行

$ node hello.js

Hello World!

模块

一般将代码合理拆分到不同的JS文件中，每一个文件就是一个模块，而文件路径就是模块名

有require、exports、module三个预先定义好的变量可供使用

require函数用于在当前模块中加载和使用别的模块　　1)相对路径（以./开头）2)绝对路径（以/或C:之类的盘符开头）3).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.hello = function () {

    console.log('Hello World!');

};

通过module对象可以访问到当前模块的一些相关信息，但最多的用途是替换当前模块的导出对象，以下模块默认导出对象被替换为一个函数

module.exports = function () {

    console.log('Hello World!');

};

模块初始化

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

主模块

通过命令行参数传递给NodeJS以启动程序的模块被称为主模块，主模块负责调度组成整个程序的其它模块完成工作

$ node main.js

二进制模块

虽然一般我们使用JS编写模块，但NodeJS也支持使用C/C++编写二进制模块。编译好的二进制模块除了文件扩展名是.node外，和JS模块的使用方式相同

代码的组织和部署

使用NodeJS编写程序前，为了有个良好的开端，首先需要准备好代码的目录结构和部署方式，就如同修房子要先搭脚手架。本章将介绍与之相关的各种知识

模块路径解析规则

require函数支持斜杠（/）或盘符（C:）开头的绝对路径，也支持./开头的相对路径。但这两种路径在模块之间建立了强耦合关系，一旦某个模块文件的存放位置需要变更，使用该模块的其它模块的代码也需要跟着调整，变得牵一发动全身。因此，require函数支持第三种形式的路径，写法类似于foo/bar，并依次按照以下规则解析路径，直到找到模块位置

内置模块

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

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

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/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找到入口模块所在位置

命令行程序

使用NodeJS编写的东西，要么是一个包，要么是一个命令行程序，而前者最终也会用于开发后者。因此我们在部署代码时需要一些技巧，让用户觉得自己是在使用一个命令行程序

例如我们用NodeJS写了个程序，可以把命令行参数原样打印出来。在主模块内实现了所有功能。并且写好后，我们把该程序部署在/home/user/bin/node-echo.js这个位置。为了在任何目录下都能运行该程序，我们需要使用以下终端命令

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

Hello World

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

$ node-echo Hello World

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目录也可被当作一个包来使用

NPM

NPM是随同NodeJS一起安装的包管理工具，能解决NodeJS代码部署上的很多问题，常见的使用场景有以下几种：

• 允许用户从NPM服务器下载别人编写的三方包到本地使用。

• 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用
• 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用

NPM建立了一个NodeJS生态圈，NodeJS开发者和用户可以在里边互通有无

下载三方包

npmjs.org

知道了包名后，比如上边argv，就可以在工程目录下打开终端，使用以下命令来下载三方包

$ npm install argv

...

argv@0.0.2 node_modules\argv

下载好之后，argv包就放在了工程目录下的node_modules目录中，因此在代码中只需要通过require('argv')的方式就好，无需指定三方包路径

以上命令默认下载最新版三方包，如果想要下载指定版本的话，可以在包名后边加上@<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 install node-echo -g

参数中的-g表示全局安装，因此node-echo会默认安装到以下位置，并且NPM会自动创建好Linux系统下需要的软链文件或Windows系统下需要的.cmd文件

- /usr/local/               # Linux系统下

    - lib/node_modules/

        + node-echo/

        ...

    - bin/

        node-echo

        ...

    ...

- %APPDATA%\npm\            # Windows系统下

    - node_modules\

        + node-echo\

        ...

    node-echo.cmd

    ...

发布代码

第一次使用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使用语义版本号来管理代码，语义版本号分为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>可以撤销发布自己发布过的某个版本代码