PM2 进程启动时出现 “Error: Cannot find module” 错误的解决方案

背景

在前端开发中，我们通常使用 PM2 工具来进行进程管理。它可以帮助我们快速启动、停止、重启、监视进程等。但有时在启动进程时会出现 “Error: Cannot find module” 的错误，这给我们的开发带来了不必要的麻烦。

原因分析

出现这个错误的原因是因为 PM2 在启动进程时，会从当前的工作目录中寻找依赖的模块，如果找不到就会报错。而有时我们的工作目录可能并不是项目根目录，这就导致 PM2 找不到需要的模块，从而出现错误。

比如，我们在项目中使用了一个自定义的模块，代码如下：

// myModule.js
module.exports = function() {
  console.log('My module!');
}

而我们在启动进程时，可能会这样写：

pm2 start app.js

但是 app.js 中使用到了 myModule.js，这时候 PM2 是无法找到这个模块的，就会报错。

解决方案

解决这个问题的方法很简单，就是告诉 PM2 模块的位置就行了。有以下两种方法：

方法一：使用 APP_PATH

我们可以在启动进程时设置 APP_PATH 环境变量，让 PM2 在启动进程时先进入我们的项目根目录，然后再启动进程，这样就可以解决找不到模块的问题了。

APP_PATH=/path/to/project pm2 start app.js

方法二：使用 PM2 的 ecosystem.config.js 配置文件

我们可以使用 PM2 的 ecosystem.config.js 配置文件来告诉 PM2 模块的位置。

创建一个 ecosystem.config.js 文件，内容如下：

module.exports = {
  apps: [{
    name: 'app',
    script: './app.js',
    cwd: '/path/to/project'
  }]
}

这个文件中，我们可以指定项目的根目录，script 指定启动脚本，在 cwd 中指定项目的根目录。

启动进程时使用以下命令：

pm2 start ecosystem.config.js --env production

这样，PM2 就可以找到 myModule.js 了。

结论

在前端开发中，使用 PM2 进行进程管理是非常常见的。但是在启动进程时，经常会遇到找不到模块的错误。我们可以使用上述方法来解决这个问题：设置 APP_PATH 环境变量或使用 PM2 的 ecosystem.config.js 配置文件。这两种方法都可以解决 PM2 找不到模块的问题，让我们的开发工作更加顺利。

参考代码

app.js

const myModule = require('./myModule.js')

myModule()

ecosystem.config.js

module.exports = {
  apps: [{
    name: 'app',
    script: './app.js',
    cwd: '/path/to/project'
  }]
}

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67076b9ad91dce0dc868405a