六千字梳理 Node.js 的多进程模型和项目部署流程
前言
昨天有小伙伴问 express 项目该如何部署。于是整理了这篇文章,主要介绍如何部署一个基于 node.js 开发的应用,比如使用 express.js 或者 koa.js 框架开发的服务端项目, 供有需要的朋友们参考。
本文包含几个部分:
线程和进程
node.js 实现多进程的方案
云服务器安装 Node.js 环境
使用 PM2 管理 Node.js 项目
使用 Nginx 实现接口服务的代理转发
进程 VS 线程
进程
进程(process)是计算机操作系统分配和调度任务的基本单位。打开任务管理器,可以看到其实在计算机的后台运行着非常多的程序,每个程序都是一个进程。
现代浏览器基本都采用多进程架构,以 Chrome 浏览器为例,打开“更多工具” - “任务管理器”,就能看到当前浏览器的进程信息,其中一个页面就是一个进程,除此之外,还有网路进程,GPU 进程,渲染进程等。
多进程的架构,得以保证应用更稳定的运行。还是以浏览器为例,假如所有的程序都运行在一个进程中,如果网络出现故障,或者页面渲染出错问题,都会导致整个浏览器的崩溃。通过多进程的架构,哪怕网络进程崩溃了,它不会影响到已有页面的展示,最坏也就是暂时不能接入网络。
线程
线程(thread)是操作系统能够进行运算调度的最小单位。它被包含在进程之中,是进程中的实际运作单位。举一个例子,一个程序好比是一家公司,下设多个部门,就是若干个进程;每个部门的通力合作使得公司正常运行,而线程就是员工,是具体干活的人。
我们都知道 JavaScript 是一门单线程语言。这么设计是因为早期 JS 主要用来编写脚本程序,负责实现页面的交互效果。如果设计成多线程语言,一是没有必要,二是多个线程共同操作一个 dom 节点,那么浏览器该听谁的?当然随着技术的发展,现在的 JS 也支持了多线程,不过仅用来处理一些和 dom 操作无关的逻辑。
单进程存在的问题
单线程单进程带来一个严重的问题,一个运行中的 node.js 程序,一旦主线程挂掉,那么这个进程也就挂掉了,整个应用也就随之挂掉。再者,现代计算机大都是多核 CPU,四核八线程,八核十六线程,都是很常见的设备了。而 node.js 作为一个单进程的程序,白白浪费掉了多核 CPU 的性能。
针对这种情况,我们需要一个合适的多进程模型,将一个单进程的 node.js 程序变为多进程的架构。
Node.js 的多进程实现
Node.js 实现多进程架构有两种常用方案,都是使用原生模块,分别是 child_process
模块和 cluster
模块。
child_process
child_process
是 node.js 的内置模块,看名字也能猜到它负责的是和子进程有关的事。
我们不再细说该模块的具体用法,实际上它大概只有六七个方法,还是非常容易理解的。我们使用其中的一个 fork
方法来演示如何实现多进程以及多进程之间的通信。
先看下准备好的演示案例的目录结构:
我们使用 http
模块创建了一个 http server,当有 /sum
请求进来时,会通过 child_process
模块创建一个子进程,并通知子进程执行计算的逻辑,同时父进程也要监听子进程发来的消息:
sum.js
用来模拟子进程要执行的任务。子进程监听父进程发来的消息,处理计算任务,然后将结果发送给父进程:
打开终端,运行命令 node 1.child_process
:
访问浏览器:
接着来模拟子进程报错的情况:
再次访问浏览器,5 秒之后观察控制台:
子进程已经挂掉了,然后再访问另一个 url :/hello
,
可见,父进程依然能正确处理请求,说明子进程报错,并不会影响父进程的运行。
接着我们来模拟父进程报错的场景,注释掉 sum.js
模块的模拟报错,然后重启服务,浏览器访问 /error
:
发现父进程挂掉后,整个 node.js 程序自动退出了,服务完全崩溃,没有挽回的余地。
可见,通过 child_process
的 fork
方法实现 node.js 的多进程架构并不复杂。进程间的通信主要通过 send
和 on
方法,从这个命名上也能知道,其底层应该是一个发布订阅模式。
但是它存在一个严重的问题,虽然子进程不影响父进程,但是一旦父进程出错挂掉,所有的子进程会被”一锅端掉“ 。所以,这种方案适用于将一些复杂耗时的运算,fork 出一个单独的子进程去做。更准确的来说,这种用法是用来代替多线程的实现,而非多进程。
cluster
使用 child_process
模块实现多进程,貌似不堪大用。所以一般更推荐使用 cluster
模块来实现 node.js 的多进程模型。
cluster
,集群的意思,这个名词相信大家都不陌生。打个比方,以前公司只有一个前台,有时候太忙就没办法及时接待访客。现在公司分配了 4 个前台,即使有三个都在忙,也还有一个能接待新来的访客。集群大致也就是这个意思,对于同一件事,合理的分配给不同的人去干,以此来保证这件事能做到最好。
cluster
模块的使用也比较简单。如果当前进程是主进程,则根据 CPU 的核数创建合适数量的子进程,同时监听子进程的 exit
事件,有子进程退出,就重新 fork 新的子进程。如果不是子进程,则进行实际业务的处理。
启动服务:
可以看到,cluster
模块创建出了非常多的子进程,好像是每个子进程都运行着同一个 web 服务。
需要注意的是,此时并非是这些子进程共同监听同一个端口。端口的监听依然是由 createServer 方法创建的 server 去负责,将请求转发给各个子进程。
我们编写一个请求脚本,来请求上面的服务,看下效果。
http 模块不仅可以创建 http server,还能用来发送 http 请求。Axios 支持浏览器和服务器环境,在服务器端就是使用 http 模块发送 http 请求。
使用 node
命令执行该文件,再看下原来的控制台:
打印出了具体处理请求的不同子进程的进程 ID。
这就是通过 cluster
模块实现的 nodd.js 的多进程架构。
当然,我们在部署 node.js 项目时不会这么干巴巴的写和使用 cluster
模块。有一个非常好用的工具,叫做 PM2,它是一个基于 cluster 模块实现的进程管理工具。在后面的章节中会介绍它的基本用法。
小结
到此为止,我们花了一部分篇幅介绍 node.js 中多进程的知识,其实仅是想要交代下为什么需要使用 pm2 来管理 node.js 应用。本文由于篇幅有限,再加上描述不够准确/详尽,仅做简单介绍。如果是第一次接触这一块内容的朋友,可能没有太明白,也不打紧,后面会再出一篇更细节的文章。
部署实践
准备一个 express 项目
本文已经准备了一个使用 express 开发的示例程序,点此访问。
它主要实现了一个接口服务,当访问 /api/users
时,使用 mockjs
模拟了 10 条用户数据,返回一个用户列表。同时会开启一个定时器,来模拟报错的情况:
本地测试一下,在终端中执行命令:
打开浏览器,访问用户列表接口:
五秒钟后,服务器会挂掉:
后面我们使用 pm2 来管理应用后,就可以解决这个问题。
讨论:express 项目是否需要打包
通常完成一个 vue/react 项目后,我们都会先执行打包,再进行发布。其实前端项目要进行打包,主要是因为程序最终的运行环境是浏览器,而浏览器存在各种兼容性问题和性能问题,比如:
高级语法的不支持,需要将 ES6+ 编译为 ES5 语法
不能识别
.vue
,.jsx
,.ts
文件,需要编译减少代码体积,节省带宽资源,提高资源加载速度
......
而使用 express.js 或者 koa.js 开发的项目,并不存在这些问题。并且,Node.js 采用 CommonJS 模块化规范,有缓存的机制;同时,只有当模块在被用到时,才会被导入。如果进行打包,打包成一个文件,其实就浪费了这个优势。所以针对 node.js 项目,并不需要打包。
服务器安装 Node.js
本文以 CentOS 系统为例进行演示。
NVM
为了方便切换 node 的版本,我们使用 nvm 来管理 node。
Nvm(Node Version Manager) ,就是 Node.js 的版本管理工具。通过它,可以让 node 在多个版本之间进行任意切换,避免了需要切换版本时反复的下载和安装的操作。
Nvm 的官方仓库是 https://github.com/nvm-sh/nvm。它的安装脚本经常不能访问,所以我在 gitee 上新建了它的镜像仓库,这样就能从 gitee 上访问到它的安装脚本了。
通过 curl
命令下载安装脚本,并使用 bash
执行脚本,会自动完成 nvm 的安装工作:
当安装完成之后,我们再打开一个新的窗口,来使用 nvm :
可以正常打印版本号,说明 nvm 已经安装成功了。
安装 Node.js
现在就可以使用 nvm 来安装和管理 node 了。
查看可用的 node 版本:
安装 node:
查看已经安装的 node 版本:
选择一个版本进行使用:
需要注意的一点,在 Windows 上使用 nvm 时,需要使用管理员权限执行 nvm 命令。在 CentOS 上,我默认使用 root 用户登录的,因而没有出现问题。大家在使用时遇到了未知错误,可以搜索一下解决方案,或者尝试下是否是权限导致的问题。
在安装 node 的时候,会自动安装 npm。查看 node 和 npm 的版本号:
默认的 npm 镜像源是官方地址:
切换为国内淘宝的镜像源:
到此为止,服务器就已经安装好 node 环境和配置好 npm 了。
项目上传到服务器
方法有很多,或者从 Github / GitLab / Gitee 仓库中 clone 到服务器中,或者本地通过 ftp 工具上传。步骤很简单,不再演示。
我们的演示项目放到了服务器的 /www
目录 下:
服务器开放端口
一般云服务器仅开放了 22 端口用于远程登录。而常用的 80,443 等端口并未开放。另外,我们准备好的 express 项目运行在 3000 端口上。所以需要先到云服务器的控制台中,找到安全组,添加几条规则,开放 80 和 3000 端口。
在快速添加规则面板中,提供了常用的端口号,选择作为 HTTP 服务使用的 80 端口号:
<img src="https://static.kunwu.tech/images/2022-08/202208022240690.webp" alt="image-20220802224056562" style="zoom:80%;" />
再添加一条规则,开放 3000 端口号:
<img src="https://static.kunwu.tech/images/2022-08/202208022243860.webp" alt="image-20220802224316755" style="zoom:80%;" />
使用 PM2 管理应用
在开发阶段,我们可以使用 nodemon
来做实时监听和自动重启,提高开发效率。在生产环境,就需要祭出大杀器—PM2 了。
基本使用
首先全局安装 pm2:
执行 pm2 -v
命令查看是否安装成功:
切换到项目目录,先把依赖装上:
然后使用 pm2
命令来启动应用:
PM2 管理应用有 fork 和 cluster 两种模式。在启动应用时,通过使用 -i 参数指定创建实例的个数,会自动开启 cluster 模式。此时就具备了负载均衡的能力。
-i :instance,实例的个数。可以写具体的数字,也可以配置成 max,
PM2
会自动检查可用的 CPU 的数量,然后尽可能多地启动进程。
此时应用就启动好了。PM2 会以守护进程的形式管理应用,这个表格展示了应用运行的一些信息,比如运行状态,CPU 使用率,内存使用率等。
在本地的浏览器中访问服务 ironfan.site:3000/api/users
:
我们编写的 web 服务已经可以正常运行了。但是根据我们代码里挖的坑,过一会服务就该崩掉了。
回到服务器终端,执行 pm2 logs
命令,查看下 pm2 的日志:
可见,id 为 1 的应用实例挂掉了,但又马上自动重启了。注意,这里的 id 是应用实例的 id,并非进程 id。
Cluster 模式是一个多进程多实例的模型,请求进来后会分配给其中一个进程处理。正如前面我们看过的 cluster
模块的用法一样,由于 pm2 的守护,即使某个进程挂掉了,也会立刻重启该进程。
到这里,一个 express 项目的简单部署就完成了。通过使用 pm2 工具,基本能保证我们的项目可以稳定可靠的运行。
PM2 常用命令小结
这里整理了一些 pm2 工具常用的命令,可供查询参考。
每一条命令都可以亲自尝试一下,看看效果。
这里特别展示下 monit
命令,它会在终端中启动一个面板,实时展示应用的运行状态,面板中展示了所有实例运行状态,包括实时日志,一些自定义的指标和应用的元数据等:
进阶:使用 pm2 配置文件
PM2 的功能十分强大,远不止上面的这几个命令。
在真实的项目部署中,可能还需要配置日志文件,环境变量,内存控制,自定义应用重启时间等等。如果每次都手敲命令是十分繁琐的,所以 pm2 提供了配置文件来管理和部署应用。
可以通过以下命令来快速生成一份配置文件:
会生成一个ecosystem.config.js
文件:
也可以自己创建一个配置文件,比如 app.config.js
:
让 pm2 使用配置文件来管理 node 应用:
现在 pm2 管理的应用,会将日志放到项目目录下(默认是放到 pm2 的安装目录下),并且能监听文件的变化,自动重启服务。
更多有用的配置可以参考 PM2 官方文档,点此访问。
Nginx 代理转发接口
上面我们直接将 nodejs 项目的 3000 端口暴露了出去。一般我们都会使用 nginx 做一个代理转发,只对外暴露 80 端口。
安装 Nginx
首先服务器中需要安装 nginx ,有三种方式:
下载源码编译安装
使用 docker 安装
使用包管理工具安装
我这里的系统是 CentOS 8,已经更换了可用的 yum 源,可以直接安装 nginx。如果你的操作系统为 CentOS 7 或者其他发行版,可以搜索适合的安装方法。
使用 yum 安装:
然后启动 nginx:
打开浏览器访问服务器地址,可以看到 nginx 默认的主页:
配置接口转发
为项目新建一个配置文件:
监听 80 端口,将所有请求转发给服务器本地的 3000 端口的程序处理:
conf
目录下的配置文件,会被主配置文件 /etc/nginx/nginx.conf
加载:
修改完配置文件,一定要重启服务:
然后本地打开浏览器,去掉原来的 3000 端口号,直接访问完整的 url:
到这里,就完成了接口转发的配置。我们编写的 web 服务就算是可以正式上线了。
总结
首先我们比较系统的讲解了为何需要在 node.js 项目中开启多进程,以及两种实现方式:
child_process
模块的fork
方法cluster 模块
的fork
方法
之后,又讲解了如何在 Linux 服务器中安装 node 环境,以及部署一个 node.js 项目的大致流程:
上传项目到服务器中
安装项目依赖
使用 pm2 管理应用
关于 pm2,我们介绍了常用的命令,以及配置文件的编写和使用。
最后,我们讲解了使用 nginx 实现接口服务的代理转发,将用户请求转发到服务器本地 3000 端口的服务。
至此,我们完成了最初的目标,将一个 express 项目部署到服务器,并能稳定可靠的运行。
本文演示代码,已上传至 Github,点击访问。
阅读中遇到了问题,或者发现文章有误,欢迎小伙伴们积极留言,一起交流!
版权声明: 本文为 InfoQ 作者【昆吾kw】的原创文章。
原文链接:【http://xie.infoq.cn/article/a34e1f2086ff03a26521321e0】。文章转载请联系作者。
评论