npm的简单了解与运用

npm与包

包

什么是包

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

包的来源

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

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

为什么需要包

由于Node.js的内置模块仅提供了一些底层的API，导致在基于内置模块进行项目开发的时候，效率很低。

包是基于内置模块封装出来的，提供了更高级、更方便的API，极大的提高了开发效率。

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

在项目中安装包的命令

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

npm install 包的完整名称

可以简写为：

npm i 完整的包名称

安装指定版本的包

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

npm i moment@2.22.2

包的语义化版本规范

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

其中每一位数字代表的含义如下：

第一位数字：大版本

第二位数字：功能版本

第三位数字：Bug修复版本

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

包管理配置文件

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

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

多人协作问题

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

解决方案：共享时提出node_modules

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

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

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

快速创建package.json

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

npm init -y

注意：

1.上述命令只能在英文的目录下成功运行。所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。

2.运行npm install命令安装包的时候，npm包管理工具会自动把包和版本号，记录到package.json中。

dependencies节点

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

一次性安装所有包

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

Error：Cannot find module ‘moment ’

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

卸载包

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

npm uninstall moment

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

devDependencies节点

如果某些包只在项目开发这阶段会用到，在项目上线之后不会用到，则建议把这些包记录到devDependencies节点中。

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

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

npm i 包名 -D

npm install 包名 --save -dev

解决下包速度慢的问题

为什么下包速度慢

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

淘宝NPM镜像服务器

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

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

切换npm下包镜像源

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

npm config get registry

npm config set registry=https://registry.npm.taobao.org/

npm config get registry

nrm

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

安装nrm

npm i nrm -g

查看可切换的镜像源列表

nrm ls

选用淘宝的镜像源

nrm use taobao

包的分类

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

• 项目包
• 全局包

项目包

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

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

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

全局包

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

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

npm i 包名 -g 全局安装指定的包

npm uninstall 包名 -g 卸载全局安装的包

注意：

1.只有工具性质的包，才会全局安装的必要性，因为它们提供了好用的终端命令。

2.判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

i5ting_toc

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

npm install -g i5ting_toc

i5ting_toc -f 要转化的md文件路径 -o

规范的包结构

在清楚了包的概念，以及如何下载和使用包之后，就要深入了解一下包的内部结构

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

1.包必须以单独的目录而存在

2.包的顶级目录下面必须包含package.json这个包管理配置文件

3.package.json中必须包含name,version,main这三个属性，分别代表包的名字，版本号，包的入口。

开发属于自己的包

需要实现的功能

1.格式化日期

2.转义HTML中的特殊字符

3.还原HTML中的特殊字符

编写包的说明文档

包根目录中的README.md文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以markdown的格式写出来，方便用户参考。

发布包

登录npm帐号

npm login

把包发布到npm上

npm publish

删除已发布的包

运行npm unpublish 包名 --force命令，即可从npm删除已发布的包

注意：

1.npm unpublish 命令只能删除72小时以内发布的包

2.npm unpublish 删除的包，在24小时内不允许重复发布

3.发布包的时候慎重，尽量不要往npm上发布没有意义的包

模块加载机制

优先从缓存中加载

模块在第一次加载后会被缓存。这也意味着多次调用reuire()不会导致模块的代码被执行多次。

注意：不论是内置模块，用户自定义模块，还是第三方模块，它们都会优先缓存中加载，从而提高模块的加载效率。

内置模块加载机制

内置模块是由Node.js官方提供的模块，内置模块的加载优先级最高。

例如，require（‘fs’）始终返回内置的fs模块，即使在node_modules目录下有名字相同的包也叫fs。

自定义模块的加载机制

使用reuire()加载自定义模块时，必须指定以./或…/开头的路径标识符。在加载自定义模块时，如果没有指定./或…/这样的路径标识符，则node会把它当作内置模块或第三方模块进行加载。

同时，在使用reuire()导入自定义模块时，如果省略了文件的扩展名，则Node.js会按顺序分别尝试加载以下的文件：

1.按照确切的文件名进行加载

2.补全.js扩展名进行加载

3.补全.json扩展名进行加载

4.补全.node扩展名进行加载

5.加载失败，终端报错

第三方模块的加载机制

如果传递给reuire()的模块标识符不是一个内置模块，也没有以’./‘或’…/'开头，则Node.js会从当前模块的父目录开始，尝试从/node.modules文件夹中加载第三方模块。

如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。

目录作为模块

当把目录作为模块标识符，传递给reuire()进行加载的时候，有三种加载方式：

1.在被加载的目录下查找一个叫做package.json的文件，并寻找main属性，作为require()加载的入口。

2.如果目录没有package.json文件，或者main入口不存在或无法解析，则Node.js将会试图加载目录下的index.js文件。

3.如果以上两步都失败了，则Node.js会在终端打印错误消息，报告模块的缺失：Error:Cannot find module ‘xxx’