Node.js 本地服务部署与常驻：避坑指南与实战技巧

在开发 Node.js 应用时，我们经常需要在本地环境部署服务，并且保持服务常驻运行，以便进行开发、测试或演示。然而，看似简单的过程，实际操作中却可能遇到各种各样的问题。本文将结合我 10 年的后端架构经验，深入探讨 Node.js 本地服务部署和常驻运行的常见问题，并提供切实可行的解决方案。

常见问题与解决方案

1. 如何使用 PM2 管理 Node.js 服务？

PM2 (Process Manager 2) 是一个流行的 Node.js 进程管理器，可以方便地管理和监控 Node.js 应用，确保服务常驻运行。它提供了进程守护、自动重启、日志管理等功能，极大地简化了 Node.js 应用的部署和运维工作。

安装 PM2：

npm install -g pm2 # 全局安装 PM2

使用 PM2 启动 Node.js 应用：

pm2 start app.js --name my-node-app # 启动 app.js，并命名为 my-node-app

常用 PM2 命令：

• pm2 list：查看所有 PM2 管理的进程。
• pm2 stop my-node-app：停止名为 my-node-app 的进程。
• pm2 restart my-node-app：重启名为 my-node-app 的进程。
• pm2 delete my-node-app：删除名为 my-node-app 的进程。
• pm2 logs my-node-app：查看名为 my-node-app 的进程的日志。
• pm2 monit：使用终端界面监控 PM2 管理的进程的资源使用情况。

设置开机自启：

pm2 startup systemd # 设置 PM2 开机自启，systemd 是常用的 Linux 初始化系统
pm2 save # 保存当前进程列表，以便开机时自动启动

避坑经验：

• 环境变量： 确保在 PM2 启动应用时，正确设置了环境变量。可以使用 --env 参数指定环境变量文件，或者在 PM2 配置文件中设置环境变量。
• 日志管理： PM2 默认会将日志输出到标准输出和标准错误，可以使用 PM2 的日志管理功能，将日志输出到文件，方便排查问题。
• 资源限制： 如果 Node.js 应用消耗大量资源，可以使用 PM2 的资源限制功能，限制应用的 CPU 和内存使用量，防止应用崩溃。

2. 使用 Supervisor 管理 Node.js 服务

Supervisor 也是一款进程管理工具，类似于 PM2，可以监控和管理 Node.js 进程。虽然 PM2 更为流行，但 Supervisor 在某些场景下可能更适用，例如对于一些老的 Linux 系统。

安装 Supervisor (Ubuntu)：

sudo apt-get update
sudo apt-get install supervisor

配置 Supervisor：

创建 Supervisor 配置文件 /etc/supervisor/conf.d/my-node-app.conf：

[program]
command=node /path/to/your/app.js # Node.js 应用的启动命令
directory=/path/to/your/app # Node.js 应用的目录
user=your_user # 运行 Node.js 应用的用户
autostart=true # 自动启动
autorestart=true # 自动重启
stderr_logfile=/path/to/your/log/error.log # 错误日志文件
stdout_logfile=/path/to/your/log/output.log # 输出日志文件

启动 Supervisor：

sudo supervisorctl reread # 重新读取配置文件
sudo supervisorctl update # 更新 Supervisor
sudo supervisorctl start my-node-app # 启动应用
sudo supervisorctl status my-node-app # 查看应用状态

3. 使用 systemd 管理 Node.js 服务

systemd 是 Linux 系统中常用的初始化系统和服务管理器。可以使用 systemd 来管理 Node.js 服务，实现开机自启和进程守护。

创建 systemd 服务文件 /etc/systemd/system/my-node-app.service：

[Unit]
Description=My Node.js Application
After=network.target

[Service]
User=your_user # 运行 Node.js 应用的用户
WorkingDirectory=/path/to/your/app # Node.js 应用的目录
ExecStart=/usr/bin/node app.js # Node.js 应用的启动命令
Restart=on-failure # 进程异常退出时重启

[Install]
WantedBy=multi-user.target

启动 systemd 服务：

sudo systemctl daemon-reload # 重新加载 systemd 配置文件
sudo systemctl enable my-node-app.service # 设置开机自启
sudo systemctl start my-node-app.service # 启动服务
sudo systemctl status my-node-app.service # 查看服务状态

4. 使用 Docker 部署 Node.js 服务

Docker 是一种容器化技术，可以将 Node.js 应用及其依赖项打包到一个容器中，方便部署和管理。Docker 提供了隔离性、可移植性和可重复性，可以有效地解决环境依赖问题。

创建 Dockerfile：

FROM node:16 # 使用 Node.js 16 镜像

WORKDIR /app # 设置工作目录

COPY package*.json ./ # 复制 package.json 文件
RUN npm install # 安装依赖

COPY . . # 复制所有文件

EXPOSE 3000 # 暴露端口
CMD [ "node", "app.js" ] # 启动命令

构建 Docker 镜像：

docker build -t my-node-app . # 构建镜像，并命名为 my-node-app

运行 Docker 容器：

docker run -d -p 3000:3000 my-node-app # 运行容器，并将容器的 3000 端口映射到主机的 3000 端口

避坑经验：

• 镜像优化： 优化 Docker 镜像的大小，可以使用多阶段构建，减少镜像的层数，避免安装不必要的依赖。
• 网络配置： Docker 容器的网络配置需要仔细考虑，确保容器可以访问外部网络，并且可以被其他容器访问。
• 数据持久化： Docker 容器中的数据默认是不持久化的，可以使用 Docker Volume 将数据存储在主机上，或者使用 Docker Compose 管理多个容器。

调用本地服务：API 设计与测试

部署好 Node.js 本地服务后，我们需要通过 API 进行调用。良好的 API 设计能够提升可维护性和可扩展性。

API 设计原则：

• RESTful API： 遵循 RESTful 架构风格，使用标准的 HTTP 方法（GET、POST、PUT、DELETE）和资源路径。
• 清晰的 API 文档： 使用 Swagger 或 OpenAPI 等工具，生成清晰的 API 文档，方便开发者使用。
• 版本控制： 使用 API 版本控制，方便后续迭代和升级。

API 测试：

• Postman： 使用 Postman 等 API 测试工具，发送 HTTP 请求，验证 API 的正确性。
• 自动化测试： 使用 Jest 或 Mocha 等测试框架，编写自动化测试用例，确保 API 的稳定性。

总结

Node.js 本地服务部署涉及到多个方面，包括进程管理、自动化部署和 API 设计。选择合适的工具和技术，可以有效地提高开发效率，并确保服务的稳定运行。希望本文能帮助你更好地理解 Node.js 本地服务部署的各个环节，并解决实际开发中遇到的问题。