整理自菜鸟教程

一、npm 简介

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

* 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
* 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
* 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。
由于新版的nodejs已经集成了npm,所以之前npm也一并安装好了。同样可以通过输入 “npm -v”
来测试是否成功安装。命令如下,出现版本提示表示安装成功:
C:\Users\peipei3514>npm -v 5.5.1
如果你安装的是旧版本的 npm,可以很容易得通过 npm 命令来升级,命令如下(管理员权限):
C:\WINDOWS\system32>npm install npm -g C:\Program Files\nodejs\node_gobal\npm
-> C:\Program Files\nodejs\node_gobal\node_modules\npm\bin\npm-cli.js C:\Program
Files\nodejs\node_gobal\npx -> C:\Program Files\nodejs\node_gobal\node_modules
\npm\bin\npx-cli.js + [email protected] added 476 packages in 17.895s
二、使用 npm 命令安装模块

npm 安装 Node.js 模块语法格式如下:
npm install <Module Name>
以下实例,我们使用 npm 命令安装常用的 Node.js web框架模块 express:
C:\WINDOWS\system32>npm install express -g + [email protected] added 48 packages
in 11.272s
安装好之后,express 包就放在了工程目录下的 node_modules 目录中,因此在代码中只需要通过 require(‘express’)
的方式就好,无需指定第三方包路径。
var express = require('express');
三、全局安装与本地安装

npm 的包安装分为本地安装(local)、全局安装(global)两种,从敲的命令行来看,差别只是有没有-g而已,比如
npm install express # 本地安装 npm install express -g # 全局安装
如果出现以下错误:
npm err! Error: connect ECONNREFUSED 127.0.0.1:8087
解决办法为:
npm config set proxy null
本地安装

* 将安装包放在 ./node_modules 下(运行 npm 命令时所在的目录),如果没有 node_modules 目录,会在当前执行 npm
命令的目录下生成 node_modules 目录。
* 可以通过 require() 来引入本地安装的包。
全局安装

* 将安装包放在 /usr/local 下或者你 node 的安装目录。
* 可以直接在命令行里使用。
如果你希望具备两者功能,则需要在两个地方安装它或使用 npm link。

接下来我们使用全局方式安装 express
C:\WINDOWS\system32>npm install express -g + [email protected] added 48 packages
in 11.272s
查看安装信息

你可以使用以下命令来查看所有全局安装的模块:
C:\WINDOWS\system32>npm list -g C:\Program Files\nodejs\node_gobal `-- express
@4.16.2 +-- [email protected] | +-- [email protected] | | `-- [email protected] | `--
[email protected] +-- [email protected] +-- [email protected] | +-- [email protected]
.0 | +-- [email protected] deduped | +-- [email protected] deduped
如果要查看某个模块的版本号,可以使用命令如下:
C:\WINDOWS\system32>npm list express -g C:\Program Files\nodejs\node_gobal `--
[email protected]
四、使用 package.json

package.json 位于模块的目录下,用于定义包的属性。接下来让我们来看下 express 包的 package.json 文件,位于
node_modules/express/package.json 内容:
{ "_from": "express", ... "_phantomChildren": {}, "_requested": { "type": "tag"
,"registry": true, ... "fetchSpec": "latest" }, "_requiredBy": [ "#USER" ],
"_resolved": "https://registry.npmjs.org/express/-/express-4.16.2.tgz",
"_shasum": "e35c6dfe2d64b7dca0a5cd4f21781be3299e076c", "_spec": "express",
"_where": "C:\\WINDOWS\\system32", "author": { "name": "TJ Holowaychuk", "email"
:"[email protected]" }, "bugs": { "url":
"https://github.com/expressjs/express/issues" }, "bundleDependencies": false,
"contributors": [ { "name": "Aaron Heckmann", "email":
"[email protected]" } ], "dependencies": { "accepts": "~1.3.4",
"array-flatten": "1.1.1", ... "type-is": "~1.6.15", "utils-merge": "1.0.1",
"vary": "~1.1.2" }, "deprecated": false, "description": "Fast, unopinionated,
minimalist web framework", "devDependencies": { "after": "0.8.2",
"connect-redis": "~2.4.1", ... "vhost": "~3.0.2" }, "engines": { "node": ">=
0.10.0" }, "files": [ "LICENSE", "History.md", "Readme.md", "index.js", "lib/"
],"homepage": "http://expressjs.com/", "keywords": [ "express", ... "app", "api"
],"license": "MIT", "name": "express", "repository": { "type": "git", "url":
"git+https://github.com/expressjs/express.git" }, "scripts": { "lint": "eslint
.", ... "test-tap": "mocha --require test/support/env --reporter tap
--check-leaks --no-exit test/ test/acceptance/" }, "version": "4.16.2" }
Package.json 属性说明:

* name - 包名。
* version - 包的版本号。
* description - 包的描述。
* homepage - 包的官网 url 。
* author - 包的作者姓名。
* contributors - 包的其他贡献者姓名。
* dependencies - 依赖包列表。如果依赖包没有安装,npm 会自动将依赖包安装在 node_module 目录下。
* repository - 包代码存放的地方的类型,可以是 git 或 svn,git 可在 Github 上。
* main - main 字段指定了程序的主入口文件,require(‘moduleName’) 就会加载这个文件。这个字段的默认值是模块根目录下面的
index.js。
* keywords - 关键字。
五、卸载模块

我们可以使用以下命令来卸载 Node.js 模块。
npm uninstall express
卸载后,你可以到 /node_modules/ 目录下查看包是否还存在,或者使用以下命令查看:
npm ls
六、更新模块

我们可以使用以下命令更新模块:
npm update express
七、搜索模块

使用以下来搜索模块:
npm search express
八、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>可以撤销发布自己发布过的某个版本代码。
九、使用淘宝 NPM 镜像

大家都知道国内直接使用 npm 的官方镜像是非常慢的,这里推荐使用淘宝 NPM 镜像。

淘宝 NPM 镜像是一个完整 npmjs.org 镜像,你可以用此代替官方版本(只读),同步频率目前为 10分钟 一次以保证尽量与官方服务同步。

你可以使用淘宝定制的 cnpm (gzip 压缩支持) 命令行工具代替默认的 npm:
npm install -g cnpm --registry=https://registry.npm.taobao.org
这样就可以使用 cnpm 命令来安装模块了:
cnpm install [name]