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阅读 159,219评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,363评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,933评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,020评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,400评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,640评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,896评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,597评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,327评论 1 244
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,581评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,072评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,399评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,054评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,849评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,672评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,585评论 2 270

推荐阅读更多精彩内容

  • NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种: ...
    街角仰望阅读 424评论 0 0
  • NPM是随NodeJs一起安装的包管理工具,能解决NodeJs代码部署上的很多问题,常见的使用场景有以下几种 在上...
    南蓝NL阅读 558评论 0 1
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,203评论 2 36
  • 大家好,我是IT修真院深圳分院第3期的学员,一枚正直纯洁善良的前端程序员,今天给大家分享一下,修真院官网前端工程师...
    大大头大阅读 2,891评论 0 1
  • 管理者的最基本功能是发展与维系一个畅通的沟通管道。——巴纳德 沟通是人与人之间必不可少的技能 但在实践过程中总是不...
    花影月移阅读 333评论 0 2