Node.js之 npm与包一、包 1. 什么是包 Node.js中的第三方模块又叫做包。就像电脑和计算机指的是相同的

一、包

1. 什么是包

Node.js中的第三方模块又叫做包。

就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一个概念，只不过叫法不同。

2. 包的来源

不同于Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，

注意： Node.js中的包都是免费且开源的，不需要付费即可免费下载使用。

3. 为什么需要包

由于Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时候，效率很低。包是基于内置模块封装出来的，提供了更高级、更方便的API，极大的提高了开发效率。

包和内置模块之间的关系，类似于jQuery和浏览器内置API之间的关系。

4. 从哪里下载包

国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： www.npmjs.com/，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！

到目前位置，全球约1100多万的开发人员，通过这个包共享平台，开发并共享了超过120多万个包供我们使用。

npm, Inc.公司提供了一个地址为 registry.npmjs.org/的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：

从 www.npmjs.com/ 网站上搜索自己所需要的包
从 registry.npmjs.org/ 服务器上下载自己需要的包

二、npm 初体验

1. 格式化时间的传统做法

创建格式化时间的自定义模块
定义格式化时间的方法
创建补零函数
从自定义模块中导出格式化时间的函数
导入格式化时间的自定义模块
调用格式化时间的函数

格式化时间传统做法.png

2. 格式化时间的高级做法

使用 npm 包管理工具，在项目中安装格式化时间的包 moment
使用 require() 导入格式化时间的包
参考 moment 的官方 API 文档对时间进行格式化

3. 在项目中安装包的命令

如果想要在项目中安装指定名称的包，需要运行如下的命令：

npm install 包的完整名称

上述的装包命令，可以简写成如下格式：

npm i 完整的包名称

4. 初次装包后多了哪些文件

初次装包完成后，在项目文件夹下多了一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。

其中：

node_modules文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。

package-lock.json配置文件用来记录 node_modules 目录下的每一个包的下载信息， 例如包的名字、版本号、下载地址等。

注意： 程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理器会自动维护它们。

5. 安装指定版本的包

默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。 如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本，例如：

npm i moment@2.22.2

6. 包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0

第一位数字：大版本(底层重构时加1)

第二位数字：功能版本(新增功能的时候加1)

第三位数字：Bug修复版本(Bug修复后加1)

版本号提升的规则： 只要前面的版本号增长了，则后面的版本号归零。

三、包管理配置文件

npm规定，在项目根目录中，必须提供一个叫做package.json的包管理配置文件。用来记录与项目有关的一些配置信息。例如：

项目的名称、版本号、描述等
项目中都用到了哪些包
哪些包只在开发期间会用到
哪些包在开发和部署时都需要用到

1. 多人协作的问题

比如一个项目中，整个项目的体积是30.4M，第三方包的体积是28.8M，项目源代码的体积是1.6M。

遇到的问题：第三方包的体积过大，不方便团队成员之间共享项目源代码。

解决方案：共享时剔除node_modules

2. 如何记录在项目中安装了哪些包

在项目根目录中，创建一个叫做package.json的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除node_modules目录之后，在团队成员之间共享项目的源代码。

注意： 今后在项目开发中，一定要把node_modules文件夹，添加到.gitignore忽略文件中。

3. 快速创建 package.json

npm 包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建package.json这个包管理配置文件：

// 作用：在执行命令所处的目录中，快速新建 package.json 文件
npm init -y

注意：

上述命令只能在英文的目录下成功运行！ 所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。
运行 npm install 命令安装包的时候，npm包管理工具会自动把包的名称和版本号，记录到package.json中。

4. dependencies 节点

package.json 文件中，有一个dependencies节点，专门用来记录您使用 npm install 命令安装了哪些包。

5. 一次性安装所有包

当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。否则会报类似于下面的错误：

// 由于项目运行依赖于 moment 这个包，如果没有提前安装好这个包，就会报如下的错误：
Error: Cannot find module 'moment'

可以运行 npm install 命令（或 npm i）一次性安装所有的依赖包：

// 执行 npm install 命令时，npm 包管理工具会先读取 package.json 中的 dependencies 节点。
// 读取到记录的所有依赖包名称和版本之后，npm 包管理工具会把这些包一次性下载到项目中
npm install

6. 卸载包

可以运行 npm uninstall 命令，来卸载指定的包：

// 使用 npm uninstall 具体的包名               来卸载包
npm uninstall moment

注意： npm uninstall 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除掉。

7. devDependencies节点

如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies节点中。与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies节点中。

您可以使用如下的命令，将包记录到 devDependencies节点中：

// 安装指定的包，并记录到 devDependencies 节点中
npm i 包名 -D
// 注意：上述命令时简写形式，等价于下面完整的写法：
npm install 包名 --save-dev

四、解决下包速度慢的问题

1. 为什么下包速度慢

在使用npm下包的时候，默认从国外的 registry.npmjs.org/ 服务器进行下载，此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。

2. 淘宝NPM镜像服务器

淘宝在国内搭建了一个服务器，专门把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。

扩展：

镜像（Mirroring）是一种文件存储形式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。

3. 切换 npm 的下包镜像源

下包的镜像源，指的就是 下包的服务器地址。

# 查看当前的下包镜像源
npm config get registry
# 将下包的镜像源切换
npm config set registry=https://registry.npm.taobao.org/
# 检查镜像源是否下载成功
npm config get registry

4. nrm

为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，利用 nrm 提供的终端命令，可以快速查看和切换下包的镜像源。

# 通过 npm 包管理器，将 npm 安装为全局可用的工具
npm i nrm -g
# 查看所有可用的镜像源
nrm ls 
# 将下包的镜像源切换为 taobao 镜像
nrm use taobao

五、包的分类

使用 npm 包管理工具下载的包，共分为两大类，分别是：

项目包
全局包

1. 项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。

项目包又分为两类，分别是：

开发依赖包（被记录到 devDependencies节点中的包，只在开发期间会用到）

核心依赖包（被记录到 dependencies节点中的包，在开发期间和项目上线之后都会用到）

npm i 包名 -D     # 开发依赖包（会被记录到 devDependencies 节点下）
npm i 报名        # 核心依赖包（会被记录到 dependencies 节点下）

2. 全局包

在执行 npm install 命令时，如果提供了 -g参数，则会把包安装为全局包。

全局包会被安装到 C:\user\用户目录\AppData\Roaming\npm\node_modules 目录下。

npm i 包名 -g         # 全局安装指定的包
npm uninstall 包名 -g  # 卸载全局安装的包

注意：

只有工具性值的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
判断某个包是否需要全局安装后才能使用，可用参考官方提供的使用说明即可。

3. i5ting_toc

i5ting_toc 是一个可用把 md 文档转换为 html 页面的小工具，使用步骤如下：

# 将 i5ting_toc 安装为全局包
npm install -g i5ting_toc
# 调用 i5ting_toc，轻松实现 md 转 html 的功能
i5ting_toc -f 要转换的md文件路径 -o

六、规范的包结构

在清除了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。

一个规范的包，它的组成解耦，必须符合以下3点要求：

包必须以单独的目录而存在
包的顶级目录下要必须包含 package.json这个包管理配置文件(比如moment文件夹下一点开就有package.json)
package.json中必须包含 name, version, main 这三个属性，分别代表包的名字、版本号、包的入口(其实外界通过require方法导入包时，会先找到package.json，然后导入main属性指向的文件)。

注意：以上3点要求时一个规范的包结构必须遵守的格式

Node.js之 npm与包

一、包