NodeJs——npm

写在前面

npm是Node Package Manager（Node.js包管理器）的缩写，是Node.js社区最流行的包管理工具之一。它不仅提供了包管理的功能，还提供了发布和共享代码、管理依赖、版本控制等功能，可以帮助开发者更方便地开发和分享代码。

npm可以用来从全球的代码库中获取并安装Node.js模块，这些模块可以用于构建应用程序、工具和包等。开发者可以通过npm来搜索、安装、更新和卸载各种Node.js模块。npm包管理器还支持各种依赖关系管理工具，如开发依赖、生产依赖、测试依赖等，可以帮助开发者更好地管理自己的项目。

npm的使用非常广泛，已经成为了前端开发的标配之一。无论是开发Web应用、移动应用、命令行工具还是桌面应用程序，npm都可以为开发者提供丰富的功能和支持。

一、dependencies、devDependencies和peerDependencies区别：

在NPM中使用npm init生成的package.json文件里，dependencies、devDependencies和peerDependencies是用于管理项目依赖的三个重要概念。

dependencies：项目中依赖的包列表，这些包会在项目运行时自动安装，也可以理解是生产环境所需要的依赖，如vue、vuex、vue-router、md5等

devDependencies：开发依赖列表。项目开发过程中所所需要的包的列表，这些包不会随项目一起发布，而是只在开发时使用。 安装在此的包通常使用npm i 包名 --save-dev或者简写npm i 包名 -D安装。什么是开发依赖呢？比如说 webpack vite rollup 等配置工具，只会在打包时使用，生产环境不需要使用，这类依赖就是开发依赖

peerDependencies：给编写插件人员或者编写npm包的开发人员去使用的；比如你要开发vite的插件，那么vite plugin插件是不能凭空运行的，需要依赖宿主环境，也就是依赖vite，要把vite安装下来才能使用插件，因此就要把vite安装在peerDependencies里。

二、需要牢记的npm命令

更多npm命令参考博客：满神之Npm Package json

2.1 npm

npm i用于初始化生成一个新的package.json文件。它会让用户设置一些配置，如包名、版本、描述等…可以一路回车使用默认配置，尾缀带-f表示force、-y表示yes，则跳过配置阶段，直接生产一个新的package.json文件，创建好之后可以在package.json直接查看或修改更新。

2.2 npm config list

npm config list用于列出所有的npm配置信息。执行该命令可以查看当前系统和用户级别的所有npm配置信息，以及当前项目的配置信息（如果在项目目录下执行该命令）

2.3 npm配置镜像源

npm config set registry 镜像源配置镜像源

npm get registry查看已配置的镜像源

扩展安装满神自己写的包xmzs，可以实现快捷切换各种镜像

如果公司有自定义的镜像 也可以使用这个包添加镜像

三、npm install 的原理

参考博客：满神——Npm install 原理

package.json和package-lock.json文件内的包版本一致或不一致时，包的安装版本依据是怎么样的？

不一致时：

会根据package.json的版本号去下载对应版本，并更新lock文件

一致时：

根据package-lock.json中的版本号去下载

其实包在下载前都会检查缓存中是否有对应包，如果有就直接解压到node_modules，如果没有就下载包资源，检查包的完整性后添加到缓存中再更新package-lock.json。

node_modules中的很多包都会依赖其他的包，因此这样的包里面也会有node_modules文件夹，因此，在遍历依赖树的时候，会使用广度优先遍历算法，逐层处理每个依赖包的依赖，直到所有依赖包都被处理完毕。

安装包（依赖）的时候会采用扁平化的方式安装，简单理解就是：比如要安装两个包，分别是vue和react，它们都会依赖一个名为child子包，也可以称为二级依赖，如果这二级依赖版本是一致的，那么这个二级依赖会被提到一级依赖中，让vue和react共用这个依赖，这就是扁平化处理，如果不是一致的，那就在分别安装在vue和react的node_modules中作为二级依赖。

npm install 原理总结：执行该命令时会安装package.json/package-lock.json记录的依赖，在安装对应依赖前它会判断package.json和package-lock.json内记录的包版本是否一致，从而决定根据package.json还是从-lock.json记录的版本下载，如果不一致会根据package.json下载，并更新-lock.json文件，如果一致则根据-lock.json下载【其实就是根据package.json下载】，下载前会使用广度优先遍历算法逐层遍历依赖树，判断是否要做扁平化处理，再检查缓存中是否有对应包，如果有就直接解压到node_modules，如果没就下载资源包并检查包完整性后添加到缓存并更新package-lock.json。

四、package-lock.json的作用

1. 锁定版本，记录依赖树详细信息
2. 实现依赖缓存，它会通过name + version + integrity信息生成一个唯一的key，这个key能找到对应的index-v5下的缓存记录，如果有缓存记录就找到对应二进制文件解压到node_modules中。

包详细信息：

五、npm run 的原理

如上图，执行npm run dev，它会运行对应的可执行命令vite --mode dev，这些可执行命令是无法直接运行的，在package.json中配置完成后，在node环境下通过npm run scriptName 运行。那么这个可执行命令是如何运行的呢？这里以上面的vite举例：

它会从node_modules中找到.bin文件夹下的vite命令，可执行命令都在.bin文件夹下，如下图

这里的vite可执行命令还有cmd和powershell的版本，因此可以在cmd和powershell命令行内运行npm run dev命令，常规的vite可执行命令由于node是跨平台的，因此也可以给unix、Linux以及MacOs去使用，window比较特殊因此会有cmd和ps版的命令，

当然这个可执行命令也不是凭空产生的，它是在用户安装vite时，根据vite依赖的package.json文件下的bin配置生成的。

以上讲述了运行npm run命令会在当前项目的node_modules/.bin中运行可执行命令，如果没有.bin目录他还会从其他目录中找可执行命令，如下查找优先级

1. 当前项目先去找有没有node_modules/.bin
2. 全局的node_modules下面去找。使用npm config list查看配置，找到全局依赖的路径【prefix】，去这个路径找
3. 去环境变量找
4. 报错

npm run 的生命周期prev和post

npm run也是有生命周期的，以dev举例:如下图，这里运行npm run dev命令

如下，切换脚本代码顺序，依旧是先执行predev，接着dev，最后再执行postdev。

应用场景：比如说运行npm run build命令，可以写个前置脚本实现清除dist文件夹，也可以写个后置脚本实现CI操作提交代码。

比如说熟悉的vue脚手架vue-cli就在使用pre前置命令，如下图：

所以说npm run生命周期的应用场景是非常多的。

六、npx

6.1 npx是什么

npx是一个命令行工具，它是npm5.2.0版本中新增的功能。它允许用户在不安装全局包的情况下，运行已安装在本地项目中的包或者远程仓库中的包。

npx的作用是在命令行中运行node包中的可执行文件，而不需要全局安装这些包。这可以使开发人员更轻松地管理包的依赖关系，并且可以避免全局污染的问题。它还可以帮助开发人员在项目中使用不同版本的包，而不会出现版本冲突的问题。

6.2 npx的优势

• 避免全局安装：npx运行你执行npx package，而不需要你先全局安装package
• 总是使用最新版本：如果你没有在本地安装相应的npm package，npx会从npm的包仓库中下载并使用最新版，并且使用完会自动删除。
• 执行任意的npm包：npx不仅可以执行在package.json的scripts部分定义的命令，还可以执行任何npm package。
• 执行GitHub gist：npx甚至可以执行GitHub gist或者其他公开的JavaScript文件。

6.3 npm和npx区别

npx侧重于执行命令，执行某个模块命令。虽然会自动安装模块，但是重在执行某个命令。

npm侧重于安装或者卸载某个模块。重在安装，并不具备执行某个模块的功能。

这里卸载vite，并写了一个简易的html文件，执行npx vite可以看到成功使用vite运行index.html文件，并且package.json文件中并没有看到新增vite依赖。

七、发布npm包

发布npm包的好处是什么？

• 方便团队或者跨团队共享代码，使用npm包就可以方便的管理，并进行版本控制
• 做开源造轮子必备技术，否则你做完的轮子如何让别人使用，难道是u盘拷贝？
• 面试题会问，字节就问过
• 增加个人IP，让更多的人知道你的技术能力和贡献

发布npm包前需要注册npm账号，可以去npm官网注册，也可以命令行输入npm adduser。

输入npm adduser会自动跳转npm账号注册网站，需要注意的是，注册时一定要将镜像源切换成npm官方镜像源https://npmjs.com/registry/，如下：

如未使用npm官方镜像源注册是会提示如下错误：

注册完成后使用npm login命令登录：

登录成功后使用npm publish命令发布包，如果发布时报403错误，表示包重名了需要重命名或者是版本重合，需要提升版本序号，如下：

下面我们更改包的名称，重新发布，如下：

接着，我们在npm官网搜索刚发的包，可以看到自己刚发布的包如下：是不是非常神奇？！

八、搭建npm私服

npm私服：通过npm install命令下载前端项目依赖时，每次都需要从淘宝等第三方npm服务器下载，速度慢，耗时长；第三方npm服务器一般不支持包的上传，公司内部开发的公共包只能通过拷贝的方式添加到各个程序员开发的前端项目内，效率低，不方便；因此，搭建npm私有服务器（简称npm私服）显得尤为重要。

npm私服工作原理：用户通过 npm install 命令安装某个模块时，npm会先检查 node_modules目录中是否已经存在该模块，如果存在，则结束该模块安装，否则向npm私服发起请求，npm私服先查询该模块是否是我们自己的私有模块或已经缓存过的公共模块，如果是则直接将其返回给用户，如果不是，则继续向上游npm服务器(如淘宝、yarnpkg和npmjs等npm服务器)查找，如果找到，则将该模块返回给用户并将其缓存至npm私服，否则响应用户“npm ERR! 404 Not Found”错误。

npm私服的优势

• 可以离线使用，你可以将npm私服部署到内网集群，这样离线也可以访问私有的包
• 提高包的安全性，使用私有的npm仓库可以更好的管理你的包，避免在使用公共的npm包的时候出现漏洞
• 提高搞的下载速度，使用私有的npm仓库，你可以将经常使用的npm包缓存到本地，从而显著提高包的下载速度，减少依赖包的下载时间。这对于团队内部开发和持续集成、部署等场景非常有用

如何搭建npm私服

Verdaccio是一个通过Node.js创建的企业级npm私有仓库程序，可以安装运行在Windows系统和Linux系统，为了更好地让大家理解npm私有仓库用法，这里将其安装运行在Linux系统中。

官网：https://verdaccio.org/zh-CN/

安装指令：npm install verdaccio -g

使用方式非常简单：直接运行verdaccio即可。

运行verdaccio生成的默认端口是4873，打开此端口如下：可以点击设置更改翻译为中文

使用verdaccio --listen 自定义端口号可以指定开启端口，如下

下面我们可以根据启动的端口中所给指示创建用户并发布包：

刷新端口页面，可以成功看到新发布的包，再去查看npm官网中我们先前发布的包，可以看到版本还是1.0.0，说明npm私服并不会影响到npm官网中上传的包。

每次发包都要需要加上--registry http://localhost:2270/显然非常麻烦，因此我们可以使用mmp将端口存储端口镜像，如下：

刷新端口页面验证结果如下：

这样，以后我们想将包发布私服或者发布到npm官网，只需要切换镜像源即可。文章来源地址https://uudwc.com/A/Y6dEx