Node.js NPM
本文介绍了 Node.js 中 NPM 的使用,我们先来了解什么是 NPM。
NPM是随同NodeJS一起安装的,能NodeJS部署上的很多问题,常见的使用场景有以下几种:
允许从NPM服务器下载别人编写的第三方包到本地使用。
允许从NPM服务器下载并安装别人编写的命令行程序到本地使用。
允许将自己编写的包或命令行程序到NPM服务器供别人使用。
由于新版的nodejs已经集成了npm,所以之前npm也一并安装好了。同样可以通过输入
"npm -v"
来测试是否成功安装。命令如下,出现版本表示安装成功:
$ npm -v 2.3.0
如果你安装的是旧版本的 npm,可以很容易得通过 npm 命令来,命令如下:
$ sudo npm install npm -g /usr/local/bin/npm -> /usr/local/lib/node_modules/npm/bin/npm-cli.js npm@2.14.2 /usr/local/lib/node_modules/npm
如果是 Window 系统使用以下命令即可:
npm install npm -g
全局安装与本地安装
npm 的包安装分为本地安装(local)、全局安装(global)两种,从敲的命令行来看,差别只是有没有-g而已,比如
npm install express # 本地安装 npm install express -g # 全局安装
如果出现以下:
npm err! Error: connect ECONNREFUSED 127.0.0.1:8087
办法为:
$ npm con set proxy null
1. 将安装包放在 ./node_modules 下(运行 npm 命令时所在的目录),如果没有 node_modules 目录,会在当前执行 npm 命令的目录下 node_modules 目录。
2. 可以通过 require() 来引入本地安装的包。
1. 将安装包放在 /usr/local 下或者你 node 的安装目录。
2. 可以直接在命令行里使用。
如果你希望具备两者,则需要在两个地方安装它或使用 npm link。
NPM 应用
NPM建立了NodeJS生态圈,NodeJS开发者和可以在里边互通有无。以下介绍NPM应用的三种场景:
我们可以使用以下命令来下载第三方包。
$ 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服务上下载安装命令行程序的与第三方包类似。
例如上例中的node-echo提供了命令行使用方式,只要node-echo自己配置好了相关的package.json字段,对于而言,只需要使用以下命令安装程序。
$ 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 版本号
使用NPM下载和发布时都会接触到版本号。NPM使用语义版本号来管理,这里简单介绍一下。
语义版本号分为X.Y.Z三位,分别代表主版本号、次版本号和补丁版本号。当变更时,版本号按以下原则更新。
如果只是修复bug,需要更新Z位。
如果是新增了,但是向下兼容,需要更新Y位。
如果有大变动,向下不兼容,需要更新X位。
版本号有了这个保证后,在申明第三方包依赖时,除了可依赖于固定版本号外,还可依赖于某个范围的版本号。例如"argv": "0.0.x"表示依赖于0.0.x系列的最新版argv。
NPM的所有版本号范围指定方式可以查看。
NPM常用命令
除了本章介绍的部分外,NPM还提供了很多,package.json里也有很多其它有用的字段。
除了可以在查看官方文档外,这里再介绍一些NPM常用命令。
NPM提供了很多命令,例如install和publish,使用npm help可查看所有命令。
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>可以撤销发布自己发布过的某个版本。