CentOS - NPM的使用介绍

模块	地址	备注
前置依赖	CentOS - 安装配置Node.js环境
后置依赖	CentOS - Node.js+Express框架连接MySQL

一、NPM 使用介绍

1. 介绍

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

1. 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
2. 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
3. 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

  由于新版的nodejs已经集成了npm，所以之前npm也一并安装好了。可以通过输入npm -v来测试是否成功安装。
  升级NPM：Run npm install -g npm to update!

[nangy@nangy-vm node]$ npm -v
6.11.2

2. 使用 npm 命令安装模块

npm install <Module Name>

  以下实例，我们使用 npm 命令安装常用的 Node.js web框架模块 express：

[nangy@nangy-vm node]$ npm install express

  安装好之后，express 包就放在了工程目录下的node_modules目录中，因此在代码中只需要通过require('express')的方式就好，无需指定第三方包路径。

var express = require('express');

3. 全局安装与本地安装

  npm 的包安装分为本地安装（local）、全局安装（global）两种，从敲的命令行来看，差别只是有没有-g而已，比如

[nangy@nangy-vm node]$ npm install express --save	# 本地安装
[nangy@nangy-vm node]$ npm install express -g		# 全局安装

  如果出现以下错误：

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087 

  解决办法为：

[nangy@nangy-vm node]$ npm config set proxy null

本地安装

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

全局安装

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

如果你希望具备两者功能，则需要在两个地方安装它或使用npm link。

4. 查看安装信息

• 查看所有全局安装的模块

[nangy@nangy-vm node]$ npm list -g
/opt/node/node-v10.16.3-linux-x64/lib
├─┬ @vue/cli@3.11.0
│ ├─┬ @vue/cli-shared-utils@3.11.0
│ │ ├─┬ @hapi/joi@15.1.1
│ │ │ ├── @hapi/address@2.0.0
…………

• 查看某个模块的版本号，进到node_modules目录

[nangy@nangy-vm node_modules]$ npm list express
hello-world@0.0.0 /home/nangy/webProjects/hello-world
└── express@4.16.4

6. 使用package.json

  package.json 位于模块的目录下，用于定义包的属性。
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 - 关键字

二、搜索模块

[nangy@nangy-vm node_modules]$ npm search express

三、创建模块

  创建模块，package.json文件是必不可少的。我们可以使用 NPM 生成 package.json 文件，生成的文件包含了基本的结果。

[nangy@nangy-vm test_modules]$ 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>` afterwards to install a package and
save it as a dependency in the package.json file.

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

{
  "name": "test_modules",
  "version": "1.0.0",
  "description": "Node.js 测试模块",
  "main": "index.js",
  "scripts": {
    "test": "make test"
  },
  "author": "",
  "license": "ISC"
}


Is this OK? (yes) yes

  以上的信息，需要根据自己的情况输入。在最后输入yes后会生成 package.json 文件。可以使用以下命令在 npm 资源库中注册用户（使用邮箱注册）：

[nangy@nangy-vm test_modules]$ npm adduser
Username: xxx
Password:
Email: (this IS public) [e-mail]

  用以下命令来发布模块：

[nangy@nangy-vm test_modules]$ npm publish

四、更新模块

[nangy@nangy-vm node_modules]$ npm update express

五、卸载模块

  我们可以使用以下命令来卸载 Node.js 模块。

[nangy@nangy-vm node_modules]$ npm uninstall express

卸载后，你可以到/node_modules/目录下查看包是否还存在，或者使用以下命令查看：

[nangy@nangy-vm node_modules]$ npm ls

六、版本号

  使用NPM下载和发布代码时都会接触到版本号。NPM使用语义版本号来管理代码，这里简单介绍一下。
  语义版本号分为X.Y.Z三位，分别代表主版本号、次版本号和补丁版本号。当代码变更时，版本号按以下原则更新。

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

  版本号有了这个保证后，在申明第三方包依赖时，除了可依赖于一个固定版本号外，还可依赖于某个范围的版本号。例如"argv": "0.0.x"表示依赖于0.0.x系列的最新版argv。
  NPM支持的所有版本号范围指定方式可以查看官方文档。

七、NPM 常用命令

  NPM还提供了很多功能，package.json里也有很多其它有用的字段。除了可以在docs.npmjs.com查看官方文档外，下面介绍一些NPM常用命令。NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。

• 使用npm help ……可查看某条命令的详细帮助，例如npm help install。
• 在package.json所在目录下使用npm install . -g可先在本地安装当前命令行程序，可用于发布前的本地测试。
• 使用npm update [package_name]可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。
• 使用npm update [package_name] -g可以把全局安装的对应命令行程序更新至最新版。
• 使用npm cache clear可以清空NPM本地缓存，用于对付使用相同版本号发布新版本代码的人。
• 使用npm unpublish [package_name]@[version]可以撤销发布自己发布过的某个版本代码。

八、设置NPM国内镜像源

  对于中国大陆用户，建议将 NPM 源设置为国内的镜像，可以大幅提升安装速度。
  可以使用定制的 cnpm (gzip 压缩支持) 命令行工具代替默认的 npm:

[nangy@nangy-vm node]$ npm install -g cnpm --registry=https://registry.npm.taobao.org

  这样就可以使用 cnpm 命令来安装模块了：

[nangy@nangy-vm node]$ cnpm install [package_name]

九、快速创建Express Web应用程序

[nangy@nangy-vm webProjects]$ mkdir hello-express
[nangy@nangy-vm webProjects]$ cd hello-express/
[nangy@nangy-vm hello-express]$ npm init -y
[nangy@nangy-vm hello-express]$ npm i express --save

  参数-y表示yes。这样 npm 就会创建一个全部使用默认值的package.json文件。如果你想要更多的控制权，去掉参数 -y，你就能看到 npm 提出的一系列问题，包括授权许可、作者姓名，等等。完成之后看一下 package.json，你会在其中发现自己提供的那些答案。你也可以手动编辑，但记得必须是有效的JSON。

十、学习资料

学习地址	备注
淘宝 NPM 镜像
NPM 使用介绍 - 菜鸟教程

---