npm包基础知识 | 青训营笔记这是我参与「第四届青训营」笔记创作活动的的第14天。记录一些关于Node.js中npm

这是我参与「第四届青训营」笔记创作活动的的第14天。记录一些关于Node.js中npm包管理的基础知识。

基本知识

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

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

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

下载

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

如何下载包

npm, Inc.公司提供了一个包管理工具，我们可以使用这个包管理工具，从 registry.npmjs.org/ 服务器把需要的包下载到本地使用。

这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。

大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号。

npm使用

(1) 安装包的命令

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

 npm install 报的完整名称

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

 npm i 完整的包名称

(2) 例子:格式化时间

终端命令：

 npm i moment
 cd 当前文件目录
 node js文件

打开www.npmjs.com/ 搜索moment使用方法

 // 导入需要的包
 //  注意：导入的名称，就是包装时的名称
 const moment = <font color = "red">require('moment')
 
 // 格式化当前时间
 const dt = moment().format('YYYY-MM-DD HH:mm:ss')
 console.log(dt)

(3) 相关文件介绍

初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件 —— C:\Windows\System32\node_modules

其中：

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

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

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

(4) 安装指定版本的包

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

 npm i moment@2.29.4

下载别的版本的包，不用卸载，会覆盖原有的版本号

(5) 查看已安装的包

 # 查看全局安装的包
 npm list -g --depth 0
 # 查看当前项目已安装包（项目跟目录必须有 package.json 文件）
 npm ls

(6) 包的语义化版本规范

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

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

第1位数字：大版本

第2位数字：功能版本

第3位数字：Bug修复版本

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

包管理配置文件

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 init -y" 命令，再写代码。该命令只用执行一次就可，后续安装包，会自动记录在dependencies节点中。
上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，(不要使用中文)，不能出现空格。
运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中

(4) dependencies 节点

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

(5) 一次性安装所有的包

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

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

(6) 卸载包

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

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

(7) devDependencies 节点

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

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

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

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

 npm i webpack -D

解决下包速度慢的问题

(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 提供的终端命令，可以快速查看和切换下包的镜像源。

 # 查看nodeJS全局安装路径中的prefix路径
 npm config ls
 # 切换到全局安装路径
 cd nodeJS全局安装路径
 # 通过npm包管理器，将nrm安装为全局可用的工具
 # --no-fund :  解决run `npm fund` for details问题
 npm i nrm -g --no-fund
 # 查看所有可用的镜像源
 nrm ls
 # 将下包的镜像源切换为 taobao 镜像
 nrm use taobao