PM2的Watching功能：自动重启Node.js应用及配置详解

pm2 是一个流行的 Node.js 进程管理工具，它可以帮助你管理和监控 Node.js 应用的运行状态。pm2 的 watching 功能是其核心特性之一，它允许你在文件发生变化时自动重启应用。这对于开发环境非常有用，因为它可以显著提高开发效率。

1. 启用 Watching 功能

默认情况下，pm2 的 watching 功能是关闭的。你可以通过以下方式启用它：

1.1 通过命令行启用

在启动应用时，可以通过 --watch 参数启用 watching 功能：

pm2 start app.js --watch

1.2 通过配置文件启用

你也可以通过 ecosystem.config.js 配置文件来启用 watching 功能：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: 'app.js',
      watch: true,
    },
  ],
};

然后使用以下命令启动应用：

pm2 start ecosystem.config.js

2. Watching 的工作原理

当 watching 功能启用后，pm2 会监控指定目录下的文件变化。默认情况下，pm2 会监控应用根目录下的所有文件（包括子目录）。当检测到文件变化时，pm2 会自动重启应用。

3. 配置 Watching 行为

你可以通过配置文件或命令行参数来定制 watching 的行为。

3.1 指定监控的目录

默认情况下，pm2 会监控应用根目录下的所有文件。你可以通过 watch 选项指定要监控的目录：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: 'app.js',
      watch: ['src', 'config'],
    },
  ],
};

在这个例子中，pm2 只会监控 src 和 config 目录下的文件变化。

3.2 忽略特定文件或目录

你可以通过 ignore_watch 选项来忽略特定的文件或目录：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: 'app.js',
      watch: true,
      ignore_watch: ['node_modules', 'logs'],
    },
  ],
};

在这个例子中，pm2 会忽略 node_modules 和 logs 目录下的文件变化。

3.3 设置监控间隔

你可以通过 watch_options 选项来设置监控的间隔时间（单位为毫秒）：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: 'app.js',
      watch: true,
      watch_options: {
        interval: 1000, // 1秒
      },
    },
  ],
};

在这个例子中，pm2 会每隔 1 秒检查一次文件变化。

4. 手动触发重启

如果你不想等待 pm2 自动检测文件变化，你可以手动触发应用重启：

pm2 restart app_name

5. 禁用 Watching 功能

如果你在开发过程中不再需要 watching 功能，可以通过以下方式禁用它：

5.1 通过命令行禁用

在启动应用时，去掉 --watch 参数即可：

pm2 start app.js

5.2 通过配置文件禁用

在配置文件中将 watch 选项设置为 false：

module.exports = {
  apps: [
    {
      name: 'my-app',
      script: 'app.js',
      watch: false,
    },
  ],
};

6. 注意事项

• 性能影响：watching 功能会占用一定的系统资源，尤其是在监控大量文件时。在生产环境中，建议禁用 watching 功能。
• 文件系统限制：pm2 的 watching 功能依赖于操作系统的文件系统通知机制（如 inotify 在 Linux 上）。在某些文件系统或网络文件系统（如 NFS）上，watching 功能可能无法正常工作。

7. 总结

pm2 的 watching 功能是一个非常强大的工具，特别适合在开发环境中使用。通过合理配置，你可以显著提高开发效率，减少手动重启应用的次数。然而，在生产环境中，建议谨慎使用或禁用该功能，以避免不必要的性能开销。