如何在退出时执行异步操作

Question

我一直在尝试在我的进程终止之前执行异步操作。

说“终止”是指终止的所有可能性：

• ctrl+c
• 未捕获的异常
• 崩溃
• 代码结束
• 任何东西..

据我所知，exit 事件可以做到这一点，但用于同步操作。

阅读 Nodejs 文档后，我发现 beforeExit 事件用于异步操作，但是：

对于导致显式终止的条件，例如调用 process.exit() 或未捕获的异常，不会发出 'beforeExit' 事件。

'beforeExit' 不应用作 'exit' 事件的替代品，除非打算安排额外的工作。

有什么建议吗？

Answer 1

您可以在退出前捕获信号并执行异步任务。这样的东西会在退出之前调用 terminator() 函数（甚至代码中的 javascript 错误）：

process.on('exit', function () {
    // Do some cleanup such as close db
    if (db) {
        db.close();
    }
});

// catching signals and do something before exit
['SIGHUP', 'SIGINT', 'SIGQUIT', 'SIGILL', 'SIGTRAP', 'SIGABRT',
    'SIGBUS', 'SIGFPE', 'SIGUSR1', 'SIGSEGV', 'SIGUSR2', 'SIGTERM'
].forEach(function (sig) {
    process.on(sig, function () {
        terminator(sig);
        console.log('signal: ' + sig);
    });
});

function terminator(sig) {
    if (typeof sig === "string") {
        // call your async task here and then call process.exit() after async task is done
        myAsyncTaskBeforeExit(function() {
            console.log('Received %s - terminating server app ...', sig);
            process.exit(1);
        });
    }
    console.log('Node server stopped.');
}

在评论中添加要求的详细信息：

• 来自节点documentation 的信号解释，此链接参考标准POSIX signal names
• 信号应该是字符串。但是，我已经看到其他人已经完成了检查，因此可能还有其他一些我不知道的意外信号。只是想在调用 process.exit() 之前确定一下。我认为无论如何检查都不会花费太多时间。
• 对于 db.close()，我想这取决于您使用的驱动程序。无论是异步同步。即使它是异步的，并且您在 db 关闭后不需要做任何事情，那么它应该没问题，因为 async db.close() 只是发出关闭事件，并且无论您的服务器是否退出，事件循环都会继续处理它。

Answer 2

使用 beforeExit 钩子

'beforeExit' 事件在 Node.js 清空其事件循环并且没有其他工作要安排时发出。通常情况下，Node.js 进程会在没有安排工作时退出，但是注册在 'beforeExit' 事件上的监听器可以进行异步调用，从而导致 Node.js 进程继续运行。

process.on('beforeExit', async () => {
    await something()
    process.exit(0) // if you don't close yourself this will run forever
});

Answer 3

这是我对此的看法。在这里作为代码 sn-p 发布有点长，所以分享一个 Github 要点。

https://gist.github.com/nfantone/1eaa803772025df69d07f4dbf5df7e58

这很简单。你可以这样使用它：

'use strict';
const beforeShutdown = require('./before-shutdown');

// Register shutdown callbacks: they will be executed in the order they were provided
beforeShutdown(() => db.close());
beforeShutdown(() => server.close());
beforeShutdown(/* Do any async cleanup */);

上面将监听一组特定的系统信号（SIGINT，又名 Ctrl + C，默认情况下是 SIGTERM）并调用每个处理程序在关闭整个过程之前订购。

它也是，

• 支持async 回调（或返回Promise）。
• 警告关闭处理程序失败，但防止错误/拒绝冒泡。
• 如果处理程序在一段时间后未返回（默认为 15 秒），则强制关闭。
• 可以从代码库中的任何模块注册回调。

Answer 4

结合答案+处理未捕获的异常和承诺拒绝

async function exitHandler(evtOrExitCodeOrError: number | string | Error) {
  try {
    // await async code here
    // Optionally: Handle evtOrExitCodeOrError here
  } catch (e) {
    console.error('EXIT HANDLER ERROR', e);
  }

  process.exit(isNaN(+evtOrExitCodeOrError) ? 1 : +evtOrExitCodeOrError);
}

[
  'beforeExit', 'uncaughtException', 'unhandledRejection', 
  'SIGHUP', 'SIGINT', 'SIGQUIT', 'SIGILL', 'SIGTRAP', 
  'SIGABRT','SIGBUS', 'SIGFPE', 'SIGUSR1', 'SIGSEGV', 
  'SIGUSR2', 'SIGTERM', 
].forEach(evt => process.on(evt, exitHandler));