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
[email protected] /usr/local/lib/node_modules/npm

如果是Window 系統使用以下命令即可：

npm install npm -g

使用npm 命令安裝模塊

npm 安裝Node.js 模塊語法格式如下：

$ npm install <Module Name>

以下實例，我們使用npm命令安裝常用的Node.js web框架模塊express :

$ npm install express

安裝好之後，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

本地安裝

1. 將安裝包放在./node_modules 下（運行npm 命令時所在的目錄），如果沒有node_modules 目錄，會在當前執行npm 命令的目錄下生成node_modules 目錄。
2. 可以通過require() 來引入本地安裝的包。

全局安裝

1. 將安裝包放在/usr/local 下或者你node 的安裝目錄。
2. 可以直接在命令行里使用。

如果你希望具備兩者功能，則需要在兩個地方安裝它或使用npm link 。

接下來我們使用全局方式安裝express

$ npm install express -g

安裝過程輸出如下內容，第一行輸出了模塊的版本號及安裝位置。

[email protected] node_modules/express
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] ([email protected])
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected], [email protected])
└── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected])

你可以使用以下命令來查看所有全局安裝的模塊：

$ npm ls -g

使用package.json

package.json 位於模塊的目錄下，用於定義包的屬性。接下來讓我們來看下express 包的package.json 文件，位於node_modules/express/package.json 內容：

{
  "name": "express",
  "description": "Fast, unopinionated, minimalist web framework",
  "version": "4.13.3",
  "author": {
    "name": "TJ Holowaychuk",
    "email": "[email protected]"
  },
  "contributors": [
    {
      "name": "Aaron Heckmann",
      "email": "[email protected]"
    },
    {
      "name": "Ciaran Jessup",
      "email": "[email protected]"
    },
    {
      "name": "Douglas Christopher Wilson",
      "email": "[email protected]"
    },
    {
      "name": "Guillermo Rauch",
      "email": "[email protected]"
    },
    {
      "name": "Jonathan Ong",
      "email": "[email protected]"
    },
    {
      "name": "Roman Shtylman",
      "email": "[email protected]"
    },
    {
      "name": "Young Jae Sim",
      "email": "[email protected]"
    }
  ],
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/strongloop/express.git"
  },
  "homepage": "http://expressjs.com/",
  "keywords": [
    "express",
    "framework",
    "sinatra",
    "web",
    "rest",
    "restful",
    "router",
    "app",
    "api"
  ],
  "dependencies": {
    "accepts": "~1.2.12",
    "array-flatten": "1.1.1",
    "content-disposition": "0.5.0",
    "content-type": "~1.0.1",
    "cookie": "0.1.3",
    "cookie-signature": "1.0.6",
    "debug": "~2.2.0",
    "depd": "~1.0.1",
    "escape-html": "1.0.2",
    "etag": "~1.7.0",
    "finalhandler": "0.4.0",
    "fresh": "0.3.0",
    "merge-descriptors": "1.0.0",
    "methods": "~1.1.1",
    "on-finished": "~2.3.0",
    "parseurl": "~1.3.0",
    "path-to-regexp": "0.1.7",
    "proxy-addr": "~1.0.8",
    "qs": "4.0.0",
    "range-parser": "~1.0.2",
    "send": "0.13.0",
    "serve-static": "~1.10.0",
    "type-is": "~1.6.6",
    "utils-merge": "1.0.0",
    "vary": "~1.0.1"
  },
  "devDependencies": {
    "after": "0.8.1",
    "ejs": "2.3.3",
    "istanbul": "0.3.17",
    "marked": "0.3.5",
    "mocha": "2.2.5",
    "should": "7.0.2",
    "supertest": "1.0.1",
    "body-parser": "~1.13.3",
    "connect-redis": "~2.4.1",
    "cookie-parser": "~1.3.5",
    "cookie-session": "~1.2.0",
    "express-session": "~1.11.3",
    "jade": "~1.11.0",
    "method-override": "~2.3.5",
    "morgan": "~1.6.1",
    "multiparty": "~4.1.2",
    "vhost": "~3.0.1"
  },
  "engines": {
    "node": ">= 0.10.0"
  },
  "files": [
    "LICENSE",
    "History.md",
    "Readme.md",
    "index.js",
    "lib/"
  ],
  "scripts": {
    "test": "mocha --require test/support/env --reporter spec --bail --check-leaks test/ test/acceptance/",
    "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/ test/acceptance/",
    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/ test/acceptance/",
    "test-tap": "mocha --require test/support/env --reporter tap --check-leaks test/ test/acceptance/"
  },
  "gitHead": "ef7ad681b245fba023843ce94f6bcb8e275bbb8e",
  "bugs": {
    "url": "https://github.com/strongloop/express/issues"
  },
  "_id": "[email protected]",
  "_shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
  "_from": "express@*",
  "_npmVersion": "1.4.28",
  "_npmUser": {
    "name": "dougwilson",
    "email": "[email protected]"
  },
  "maintainers": [
    {
      "name": "tjholowaychuk",
      "email": "[email protected]"
    },
    {
      "name": "jongleberry",
      "email": "[email protected]"
    },
    {
      "name": "dougwilson",
      "email": "[email protected]"
    },
    {
      "name": "rfeng",
      "email": "[email protected]"
    },
    {
      "name": "aredridel",
      "email": "[email protected]"
    },
    {
      "name": "strongloop",
      "email": "[email protected]"
    },
    {
      "name": "defunctzombie",
      "email": "[email protected]"
    }
  ],
  "dist": {
    "shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
    "tarball": "http://registry.npmjs.org/express/-/express-4.13.3.tgz"
  },
  "directories": {},
  "_resolved": "https://registry.npmjs.org/express/-/express-4.13.3.tgz",
  "readme": "ERROR: No README data found!"
}

Package.json 屬性說明

name -包名。
version -包的版本號。
description -包的描述。
homepage -包的官網url 。
author -包的作者姓名。
contributors -包的其他貢獻者姓名。
dependencies -依賴包列表。如果依賴包沒有安裝，npm 會自動將依賴包安裝在node_module 目錄下。
repository -包代碼存放的地方的類型，可以是git或svn，git可在Github上。
main - main字段是一個模塊ID，它是一個指向你程序的主要項目。就是說，如果你包的名字叫express，然後用戶安裝它，然後require("express")。
keywords -關鍵字

卸載模塊

我們可以使用以下命令來卸載Node.js 模塊。

$ npm uninstall express

卸載後，你可以到/node_modules/ 目錄下查看包是否還存在，或者使用以下命令查看：

$ npm ls

更新模塊

我們可以使用以下命令更新模塊：

$ npm update express

搜索模塊

使用以下來搜索模塊：

$ npm search express

創建模塊

創建模塊，package.json 文件是必不可少的。我們可以使用NPM 生成package.json 文件，生成的文件包含了基本的結果。

$ npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg> --save` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
name: (node_modules) w3big                   # 模块名
version: (1.0.0) 
description: Node.js 测试模块(www.w3big.com)  # 描述
entry point: (index.js) 
test command: make test
git repository: https://github.com/w3big/w3big.git  # Github 地址
keywords: 
author: 
license: (ISC) 
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "w3big",
  "version": "1.0.0",
  "description": "Node.js 测试模块(www.w3big.com)",
  ……
}


Is this ok? (yes) yes

以上的信息，你需要根據你自己的情況輸入。在最後輸入"yes" 後會生成package.json 文件。

接下來我們可以使用以下命令在npm 資源庫中註冊用戶（使用郵箱註冊）：

$ npm adduser
Username: mcmohd
Password:
Email: (this IS public) [email protected]

接下來我們就用以下命令來發布模塊：

$ npm publish

如果你以上的步驟都操作正確，你就可以跟其他模塊一樣使用npm 來安裝。

版本號

使用NPM下載和發布代碼時都會接觸到版本號。 NPM使用語義版本號來管理代碼，這裡簡單介紹一下。

語義版本號分為XYZ三位，分別代表主版本號、次版本號和補丁版本號。當代碼變更時，版本號按以下原則更新。

如果只是修復bug，需要更新Z位。
如果是新增了功能，但是向下兼容，需要更新Y位。
如果有大變動，向下不兼容，需要更新X位。

版本號有了這個保證後，在申明第三方包依賴時，除了可依賴於一個固定版本號外，還可依賴於某個範圍的版本號。例如"argv": "0.0.x"表示依賴於0.0.x系列的最新版argv。

NPM支持的所有版本號範圍指定方式可以查看官方文檔。

NPM 常用命令

除了本章介紹的部分外，NPM還提供了很多功能，package.json裡也有很多其它有用的字段。

除了可以在npmjs.org/doc/查看官方文檔外，這裡再介紹一些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>可以撤銷發布自己發布過的某個版本代碼。

使用淘寶NPM 鏡像

大家都知道國內直接使用npm 的官方鏡像是非常慢的，這裡推薦使用淘寶NPM 鏡像。

淘寶NPM 鏡像是一個完整npmjs.org 鏡像，你可以用此代替官方版本(只讀)，同步頻率目前為10分鐘一次以保證盡量與官方服務同步。

你可以使用淘寶定制的cnpm (gzip 壓縮支持) 命令行工具代替默認的npm:

$ npm install -g cnpm --registry=https://registry.npm.taobao.org

這樣就可以使用cnpm 命令來安裝模塊了：

$ cnpm install [name]

更多信息可以查閱： http://npm.taobao.org/ 。

上一頁： Node.js REPL(交互式解釋器)

下一頁： Node.js回調函數

Node.js 教程