pm2部署不同环境下nodejs服务

pm2在当前阶段当然是部署node服务首选的工具,那么如何根据不同发布环境执行不同的配置呢?

需要解决的问题:

不同环境的数据库配置
由于项目使用了 socket.io，那么前端必然是不能写死io连接的地址，需要后端返回连接的url
部署时项目端口可能与旧有端口出现冲突，不可能直接更改项目默认端口，需要端口可更改

安装 pm2

npm install pm2 -g

注: 目前演示处于本地环境,最后调试完毕在服务器安装pm2执行部署命令即可

新建pm2部署文件

pm2相关文档我们可以在文档中看到pm2支持几种类型的配置分别是 .yml .json .js ...

我们使用.js文件，注意:使用Javascript配置文件需要以.config.js结尾

在根目录下新建一个 ecosystem.config.js 文件
我们增加 3 种环境，当然根据公司情况来，也许你的公司并不需要那么多环境

// ecosystem.config.js
module.exports = {
    apps: [{
        // 生产环境
        name: "prod-implant",
        // 项目启动入口文件
        script: "./app.js",
        // 项目环境变量
        env: {
            "NODE_ENV": "production",
            "PORT": 3555
        }
    }, {
        // 测试环境
        name: "test-implant",
        script: "./app.js",
        env: {
            "NODE_ENV": "test",
            "PORT": 3555
        }
    },{
        // 预发布环境
            name: "release-implant",
            script: "./app.js",
            env: {
                "NODE_ENV": "release",
                "PORT": 3555
            }
        }
    ]
}

在这里我们并没有配置本地环境，因为本地开发时我们并不需要使用pm2

package.json增加命令

我们增加4个环境的配置

  "scripts": {
    "dev": "cross-env NODE_ENV=development PORT=3555 nodemon app.js",
    "tes": "pm2 start ecosystem.config.js --only test-implant --watch",
    "release": "pm2 start ecosystem.config.js --only release-implant --watch",
    "prod": "pm2 start ecosystem.config.js --only prod-implant --watch"
  }

npm run dev
开启本地开发环境(需要安装nodemon) 端口为3555 process.env.NODE_ENV 为 development
坑点如果直接使用NODE_ENV=development PORT=3555 nodemon app.js 在window下会报错，我用mac开发则没有这个问题,具体参考使用cross-env解决跨平台设置NODE_ENV的问题
解决
安装cross-env: npm install cross-env --save-dev
在NODE_ENV=development 前加上 cross-env
npm run tes
意思是我们只执行 ecosystem.config.js 里面 name 值为 test-implant的配置, 其他命令相同,这样我们就有不同环境对应的端口以及环境变量

创建一个config.js文件

这个文件用于存取端口等等公共信息

// config.js
let config = {
    // 这是我们通过环境变量设置的
    port: process.env.PORT || 3555,
    // ...
}

module.exports = config

解决socket.io连接url问题

 const {port} = require('config')
 // 我们先拿到当前部署的服务ip
 const ip = req.headers['x-real-ip'] ? req.headers['x-real-ip'] : req.ip.replace(/::ffff:/, '');
 // 再加上config的端口号返回给前端
 cosnt socket_url = `http://${ip}:port`

解决数据库问题

我们在db/dbconfig.js 中设置数据库配置可参考我的另外一篇文章nodejs使用async/await同步操作mysql

const mysql = require('mysql')

let config = null
// 不同环境设置不同配置
switch (process.env.NODE_ENV) {
    case 'test':
        console.log('测试环境')
        config = {
            // ...
        }
        break;
    case 'prod':
        console.log('生产环境')
        break;
    case 'release':
        console.log('预发布环境')
        break;
    // 本地
    default:
        config = {
            host: 'xxx',
            user: 'xxxx',
            password: 'xxxx',
            database: 'xxxx'
        }
}
// 创建数据池
const pool = mysql.createPool(config)
module.exports = pool

最终我们交付给运维部署即可
源码地址 koa-gachat