server-shutdown

Nodejs server graceful shutdown

用途

程序断开或重启时，已连接的socket连接将会在处理完成后再重启

注意

使用pm2管理应用程序时，需要在启动时加上 --kill-timeout 10000 参数，否则pm2会立刻结束你的任务

1pm2 start index.js --kill-timeout 10000

引入

1const ShutDown = require('http-server-shutdown')

API

方式一： 如果需要使用shutDown的关闭服务，你需要使用以下方式

1  new ShutDown(server, // 传入 server = app.listen(...)
2  {
3    signals: ['SIGINT','SIGTERM'], // 接收的信号参数
4    timeout: 30000, // 超时时间
5    before: function () { // 关机前的处理函数
6      return new Promise((resolve, reject) => {
7        setTimeout(() => {
8          resolve(console.log('before 123'))
9        }, 1000)
10      })
11    },
12    after: function () { // 关机后的处理函数， 仅处理同步方法
13      console.log('after: server gracefull shutted down.....')
14    },
15    errCb: function (e) { // 需要提供出现错误时的error回调，传入Error对象
16      e && console.log(e.message || 'unknown error')
17    }
18  }
19)

方式二： 如果不想使用shutdown关闭服务，而需要处理关闭期间的socket请求，处理并断开所有connection后返回（关闭期间需要自己重定向或停止接收新的请求，否则会有理论上永远处理不完connection的可能）

1let shutdown = new ShutDown(server,
2  {
3    monitor: false  // 控制是否需要开启监控，默认为true
4  }
5)
6shutdown.serverClose()  // 连接全部关闭后将会返回一个promise