NPM 使用介紹

NPM是隨同NodeJS一起安裝的包管理工具,能解決NodeJS代碼部署上的很多問題,常見的使用場景有以下幾種:

  • 允許用戶從NPM服務器下載別人編寫的第三方包到本地使用。
  • 允許用戶從NPM服務器下載并安裝別人編寫的命令行程序到本地使用。
  • 允許用戶將自己編寫的包或命令行程序上傳到NPM服務器供別人使用。

由于新版的nodejs已經集成了npm,所以之前npm也一并安裝好了。同樣可以通過輸入 **"npm -v" **來測試是否成功安裝。命令如下,出現版本提示表示安裝成功:

$ npm -v
 2.15.8

如果你安裝的是舊版本的 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命令安裝模塊

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 ECONNREFFUSED 127.0.0.1:8087

解決辦法:

 $ npm config set proxy null

本地安裝

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

全局安裝

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

如果你希望具備兩者功能,則需要在兩個地方安裝它或使用npm link
接下來我們使用全局方式安裝express

 $ npm install express -g

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

    express@4.13.3 node_modules/express
    ├── escape-html@1.0.2
    ├── range-parser@1.0.2
    ├── merge-descriptors@1.0.0
    ├── array-flatten@1.1.1
    ├── cookie@0.1.3
    ├── utils-merge@1.0.0
    ├── parseurl@1.3.0
    ├── cookie-signature@1.0.6
    ├── methods@1.1.1
    ├── fresh@0.3.0
    ├── vary@1.0.1
    ├── path-to-regexp@0.1.7
    ├── content-type@1.0.1
    ├── etag@1.7.0
    ├── serve-static@1.10.0
    ├── content-disposition@0.5.0
    ├── depd@1.0.1
    ├── qs@4.0.0
    ├── finalhandler@0.4.0 (unpipe@1.0.0)
    ├── on-finished@2.3.0 (ee-first@1.1.1)
    ├── proxy-addr@1.0.8 (forwarded@0.1.0, ipaddr.js@1.0.1)
    ├── debug@2.2.0 (ms@0.7.1)
    ├── type-is@1.6.8 (media-typer@0.3.0, mime-types@2.1.6)
    ├── accepts@1.2.12 (negotiator@0.5.3, mime-types@2.1.6)
    └── send@0.13.0 (destroy@1.0.3, statuses@1.2.1, ms@0.7.1, mime@1.3.4, http-errors@1.3.1)

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

$ npm ls -g 

我本機安裝后,express 是安裝到了:

C:\Users\Administrator\AppData\Roaming\npm

使用package.json

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

{
  "name": "express",       // 包名
  "description": "Fast, unopinionated, minimalist web framework",                      // 描述,很快很流行,一個極簡的web框架
  "version": "4.14.0",      // 版本號
  "author": {                                 // 作者 
    "name": "TJ Holowaychuk",      
    "email": "tj@vision-media.ca"   // 郵箱
  },
  "contributors": [                        // 參與的貢獻者
    {
      "name": "Aaron Heckmann",
      "email": "aaron.heckmann+github@gmail.com"
    },
    {
      "name": "Ciaran Jessup",
      "email": "ciaranj@gmail.com"
    },
    {
      "name": "Douglas Christopher Wilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "Guillermo Rauch",
      "email": "rauchg@gmail.com"
    },
    {
      "name": "Jonathan Ong",
      "email": "me@jongleberry.com"
    },
    {
      "name": "Roman Shtylman",
      "email": "shtylman+expressjs@gmail.com"
    },
    {
      "name": "Young Jae Sim",
      "email": "hanul@hanul.me"
    }
  ],
  "license": "MIT",                          // 許可證
  "repository": {                             // 包代碼存放的地方和類型
    "type": "git",
    "url": "git+https://github.com/expressjs/express.git"
  },
  "homepage": "http://expressjs.com/",    // 包的官網 url
  "keywords": [                                          // 關鍵字
    "express",
    "framework",
    "sinatra",
    "web",
    "rest",
    "restful",
    "router",
    "app",
    "api"
  ],
  "dependencies": {                                     // 包依賴列表
    "accepts": "~1.3.3",
    "array-flatten": "1.1.1",
    "content-disposition": "0.5.1",
    "content-type": "~1.0.2",
    "cookie": "0.3.1",
    "cookie-signature": "1.0.6",
    "debug": "~2.2.0",
    "depd": "~1.1.0",
    "encodeurl": "~1.0.1",
    "escape-html": "~1.0.3",
    "etag": "~1.7.0",
    "finalhandler": "0.5.0",
    "fresh": "0.3.0",
    "merge-descriptors": "1.0.1",
    "methods": "~1.1.2",
    "on-finished": "~2.3.0",
    "parseurl": "~1.3.1",
    "path-to-regexp": "0.1.7",
    "proxy-addr": "~1.1.2",
    "qs": "6.2.0",
    "range-parser": "~1.2.0",
    "send": "0.14.1",
    "serve-static": "~1.11.1",
    "type-is": "~1.6.13",
    "utils-merge": "1.0.0",
    "vary": "~1.1.0"
  },
  "devDependencies": {                             // 開發  依賴包列表
    "after": "0.8.1",
    "body-parser": "~1.15.1",
    "cookie-parser": "~1.4.3",
    "ejs": "2.4.2",
    "istanbul": "0.4.3",
    "marked": "0.3.5",
    "method-override": "~2.3.6",
    "mocha": "2.5.3",
    "morgan": "~1.7.0",
    "should": "9.0.2",
    "supertest": "1.2.0",
    "connect-redis": "~2.4.1",
    "cookie-session": "~1.2.0",
    "express-session": "~1.13.0",
    "jade": "~1.11.0",
    "multiparty": "~4.1.2",
    "vhost": "~3.0.2"
  },
  "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": "9375a9afa9d7baa814b454c7a6818a7471aaef00",
  "bugs": {
    "url": "https://github.com/expressjs/express/issues"
  },
  "_id": "express@4.14.0",
  "_shasum": "c1ee3f42cdc891fb3dc650a8922d51ec847d0d66",
  "_from": "express@latest",
  "_npmVersion": "1.4.28",
  "_npmUser": {
    "name": "dougwilson",
    "email": "doug@somethingdoug.com"
  },
  "maintainers": [
    {
      "name": "dougwilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "hacksparrow",
      "email": "captain@hacksparrow.com"
    },
    {
      "name": "jasnell",
      "email": "jasnell@gmail.com"
    },
    {
      "name": "mikeal",
      "email": "mikeal.rogers@gmail.com"
    }
  ],
  "dist": {
    "shasum": "c1ee3f42cdc891fb3dc650a8922d51ec847d0d66",
    "tarball": "https://registry.npmjs.org/express/-/express-4.14.0.tgz"
  },
  "_npmOperationalInternal": {
    "host": "packages-12-west.internal.npmjs.com",
    "tmp": "tmp/express-4.14.0.tgz_1466095407850_0.17484632693231106"
  },
  "directories": {},
  "_resolved": "https://registry.npmjs.org/express/-/express-4.14.0.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) runoob                   # 模塊名
    version: (1.0.0) 
    description: Node.js 測試模塊(www.runoob.com)  # 描述
    entry point: (index.js) 
    test command: make test
    git repository: https://github.com/runoob/runoob.git  # Github 地址
    keywords: 
    author: 
    license: (ISC) 
    About to write to ……/node_modules/package.json:      # 生成地址

    {
      "name": "runoob",
      "version": "1.0.0",
      "description": "Node.js 測試模塊(www.runoob.com)",
      ……
    }


    Is this ok? (yes) yes

以上信息,你需要根據你自己的情況輸入。最后輸入“yes”后會生產一個package.json文件。
接下來我們可以使用以下命令在npm資源庫中注冊用戶(使用郵箱注冊
):

$ npm adduser
Username: mcmohd
Password:
Email: (this IS public) mcmohd@gmail.com

接下來我們就用一下的命令來發布模塊:

$ 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里也有很多其它有用的字段。
除了可以在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>可以撤銷發布自己發布過的某個版本代碼。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,885評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,312評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,993評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,667評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,410評論 6 411
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,778評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,775評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,955評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,521評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,266評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,468評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,998評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,696評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,095評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,385評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,193評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,431評論 2 378

推薦閱讀更多精彩內容

  • NPM是隨同NodeJS一起安裝的包管理工具,能解決NodeJS代碼部署上的很多問題,常見的使用場景有以下幾種: ...
    街角仰望閱讀 463評論 0 0
  • NPM是隨NodeJs一起安裝的包管理工具,能解決NodeJs代碼部署上的很多問題,常見的使用場景有以下幾種 在上...
    南藍NL閱讀 587評論 0 1
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey閱讀 6,262評論 2 36
  • 大家好,我是IT修真院深圳分院第3期的學員,一枚正直純潔善良的前端程序員,今天給大家分享一下,修真院官網前端工程師...
    大大頭大閱讀 2,968評論 0 1
  • 管理者的最基本功能是發展與維系一個暢通的溝通管道。——巴納德 溝通是人與人之間必不可少的技能 但在實踐過程中總是不...
    花影月移閱讀 360評論 0 2