使用node-windows将Node.js应用部署为Windows服务

使用node-windows将Node.js应用部署为Windows服务

【免费下载链接】node-windows Windows support for Node.JS scripts (daemons, eventlog, UAC, etc). 项目地址: https://gitcode.com/gh_mirrors/no/node-windows

项目概述

node-windows是一个强大的Node.js模块，它允许开发者将Node.js应用程序作为Windows服务运行。这对于需要在后台持续运行的Node.js应用特别有用，比如Web服务器、数据处理服务或定时任务等。

为什么需要Windows服务

在Windows系统中，服务是一种特殊的应用程序类型，它可以在系统启动时自动运行，无需用户登录，并且可以在后台持续运行。将Node.js应用转换为服务可以带来以下优势：

1. 自动启动：系统重启后服务会自动启动
2. 后台运行：无需保持用户会话
3. 集中管理：可以通过服务管理器统一管理
4. 稳定性：具备自动重启等恢复机制

基础使用指南

安装服务

首先，我们需要创建一个服务配置并安装它：

const { Service } = require('node-windows');

// 创建服务对象
const svc = new Service({
  name: 'MyNodeApp',  // 服务名称
  description: '我的Node.js应用程序服务',  // 服务描述
  script: 'C:\\path\\to\\your\\app.js'  // 要运行的脚本路径
});

// 监听安装完成事件
svc.on('install', () => {
  console.log('服务安装完成');
  svc.start();  // 安装完成后立即启动服务
});

// 执行安装
svc.install();

服务事件

node-windows服务对象提供了多个事件，方便我们监控服务状态：

• install - 服务安装完成时触发
• alreadyinstalled - 当服务已存在时触发
• invalidinstallation - 安装不完整时触发
• uninstall - 服务卸载完成时触发
• start - 服务启动时触发
• stop - 服务停止时触发
• error - 发生错误时触发

高级配置选项

环境变量设置

服务运行时可能需要访问特定的环境变量：

const svc = new Service({
  name: 'MyNodeApp',
  script: 'C:\\path\\to\\app.js',
  env: [
    {
      name: "NODE_ENV",
      value: "production"
    },
    {
      name: "APP_CONFIG_PATH",
      value: "C:\\config\\app.json"
    }
  ]
});

用户权限配置

可以指定服务运行的用户账户：

const svc = new Service({
  name: 'MyNodeApp',
  script: 'C:\\path\\to\\app.js'
});

// 设置域账户
svc.user.domain = 'yourdomain.local';
svc.user.account = 'serviceaccount';
svc.user.password = 'password';

// 或者使用sudo权限
svc.sudo.password = 'adminpassword';

服务管理

卸载服务

当不再需要服务时，可以这样卸载：

const svc = new Service({
  name: 'MyNodeApp',
  script: 'C:\\path\\to\\app.js'
});

svc.on('uninstall', () => {
  console.log('服务卸载完成');
});

svc.uninstall();

服务监控与恢复

node-windows提供了智能的服务监控功能：

const svc = new Service({
  name: 'MyNodeApp',
  script: 'C:\\path\\to\\app.js',
  wait: 1,       // 初始等待时间(秒)
  grow: 0.25,    // 每次重启等待时间增长比例
  maxRetries: 3  // 最大重试次数
});

这种配置意味着：

1. 第一次崩溃后1秒重启
2. 第二次崩溃后1.25秒重启
3. 第三次崩溃后1.56秒重启
4. 超过3次后不再尝试重启

事件日志记录

node-windows还提供了事件日志功能：

const { EventLogger } = require('node-windows');
const log = new EventLogger('MyNodeApp');

// 记录不同级别的日志
log.info('应用程序启动');
log.warn('资源使用接近阈值');
log.error('数据库连接失败');

// 带错误代码和回调的高级用法
log.error('关键错误', 5001, () => {
  console.log('错误已记录');
});

技术原理

node-windows底层使用winsw工具来创建服务，它会为每个Node.js服务生成：

1. 一个专用的.exe可执行文件
2. 对应的XML配置文件
3. 日志文件

这些文件都存储在应用程序目录下的daemon子目录中。服务卸载时会自动清理这些文件。

最佳实践建议

1. 全局安装：建议将node-windows全局安装，避免路径问题
2. 错误处理：在Node.js脚本中添加完善的错误处理
3. 日志监控：充分利用事件日志功能记录关键信息
4. 资源限制：合理配置maxRetries和maxRestarts防止无限重启
5. 测试环境：先在测试环境验证服务配置

常见问题解答

Q: 服务安装需要什么权限？ A: 需要管理员权限，因为修改Windows服务需要提升的权限。

Q: 服务崩溃后会怎样？ A: 默认会尝试重启，重启间隔会逐渐增加以避免系统过载。

Q: 如何查看服务日志？ A: 可以通过Windows事件查看器查看，日志源包括服务名和对应的.exe文件名。

Q: 能否在多台服务器上部署相同的服务？ A: 可以，但需要确保每台服务器上的路径配置正确。

通过node-windows，Node.js开发者可以轻松地将应用程序转换为专业的Windows服务，获得企业级的管理能力和稳定性。

【免费下载链接】node-windows Windows support for Node.JS scripts (daemons, eventlog, UAC, etc). 项目地址: https://gitcode.com/gh_mirrors/no/node-windows