Thực hiện hành động dọn dẹp ngay trước khi thoát Node.js

Tôi muốn nói với Node.js luôn luôn làm một cái gì đó ngay trước khi nó thoát ra, vì bất kỳ lý do gì - Ctrl+ C, một ngoại lệ hoặc bất kỳ lý do nào khác.

Tôi đã thử điều này:

process.on('exit', function (){
    console.log('Goodbye!');
});

Tôi bắt đầu quá trình, giết nó, và không có gì xảy ra. Tôi bắt đầu lại, nhấn Ctrl+ C, và vẫn không có gì xảy ra ...

CẬP NHẬT:

Bạn có thể đăng ký một trình xử lý cho process.on('exit')và trong mọi trường hợp khác ( SIGINThoặc ngoại lệ chưa xử lý) để gọiprocess.exit()

process.stdin.resume();//so the program will not close instantly

function exitHandler(options, exitCode) {
    if (options.cleanup) console.log('clean');
    if (exitCode || exitCode === 0) console.log(exitCode);
    if (options.exit) process.exit();
}

//do something when app is closing
process.on('exit', exitHandler.bind(null,{cleanup:true}));

//catches ctrl+c event
process.on('SIGINT', exitHandler.bind(null, {exit:true}));

// catches "kill pid" (for example: nodemon restart)
process.on('SIGUSR1', exitHandler.bind(null, {exit:true}));
process.on('SIGUSR2', exitHandler.bind(null, {exit:true}));

//catches uncaught exceptions
process.on('uncaughtException', exitHandler.bind(null, {exit:true}));

Kịch bản dưới đây cho phép có một trình xử lý duy nhất cho tất cả các điều kiện thoát. Nó sử dụng chức năng gọi lại dành riêng cho ứng dụng để thực hiện mã dọn dẹp tùy chỉnh.

dọn dẹp.js

// Object to capture process exits and call app specific cleanup function

function noOp() {};

exports.Cleanup = function Cleanup(callback) {

  // attach user callback to the process event emitter
  // if no callback, it will still exit gracefully on Ctrl-C
  callback = callback || noOp;
  process.on('cleanup',callback);

  // do app specific cleaning before exiting
  process.on('exit', function () {
    process.emit('cleanup');
  });

  // catch ctrl+c event and exit normally
  process.on('SIGINT', function () {
    console.log('Ctrl-C...');
    process.exit(2);
  });

  //catch uncaught exceptions, trace, then exit normally
  process.on('uncaughtException', function(e) {
    console.log('Uncaught Exception...');
    console.log(e.stack);
    process.exit(99);
  });
};

Mã này chặn các ngoại lệ chưa được phát hiện, Ctrl+ Cvà các sự kiện thoát bình thường. Sau đó, nó gọi một chức năng gọi lại dọn dẹp tùy chọn của người dùng trước khi thoát, xử lý tất cả các điều kiện thoát với một đối tượng.

Mô-đun chỉ đơn giản là mở rộng đối tượng quá trình thay vì xác định một trình phát sự kiện khác. Nếu không có một cuộc gọi lại cụ thể cho ứng dụng, việc dọn dẹp sẽ mặc định là không có chức năng op. Điều này là đủ cho việc sử dụng của tôi khi các tiến trình con bị bỏ chạy khi thoát bằng Ctrl+ C.

Bạn có thể dễ dàng thêm các sự kiện thoát khác như SIGHUP như mong muốn. Lưu ý: theo hướng dẫn sử dụng NodeJS, SIGKILL không thể có người nghe. Mã kiểm tra bên dưới thể hiện nhiều cách sử dụng Cleanup.js

// test cleanup.js on version 0.10.21

// loads module and registers app specific cleanup callback...
var cleanup = require('./cleanup').Cleanup(myCleanup);
//var cleanup = require('./cleanup').Cleanup(); // will call noOp

// defines app specific callback...
function myCleanup() {
  console.log('App specific cleanup code...');
};

// All of the following code is only needed for test demo

// Prevents the program from closing instantly
process.stdin.resume();

// Emits an uncaught exception when called because module does not exist
function error() {
  console.log('error');
  var x = require('');
};

// Try each of the following one at a time:

// Uncomment the next line to test exiting on an uncaught exception
//setTimeout(error,2000);

// Uncomment the next line to test exiting normally
//setTimeout(function(){process.exit(3)}, 2000);

// Type Ctrl-C to test forced exit 

Điều này nắm bắt mọi sự kiện thoát tôi có thể tìm thấy có thể được xử lý. Có vẻ khá đáng tin cậy và sạch sẽ cho đến nay.

[`exit`, `SIGINT`, `SIGUSR1`, `SIGUSR2`, `uncaughtException`, `SIGTERM`].forEach((eventType) => {
  process.on(eventType, cleanUpServer.bind(null, eventType));
})

"exit" là một sự kiện được kích hoạt khi nút hoàn thành vòng lặp sự kiện bên trong, nó không được kích hoạt khi bạn chấm dứt quá trình bên ngoài.

Những gì bạn đang tìm kiếm là thực hiện một cái gì đó trên SIGINT.

Các tài liệu tại http://nodejs.org/api/ process.html # process_signal_events đưa ra một ví dụ:

Ví dụ về nghe cho SIGINT:

// Start reading from stdin so we don't exit.
process.stdin.resume();

process.on('SIGINT', function () {
  console.log('Got SIGINT.  Press Control-D to exit.');
});

Lưu ý: điều này dường như làm gián đoạn sigint và bạn sẽ cần gọi process.exit () khi bạn hoàn thành với mã của mình.

function fnAsyncTest(callback) {
    require('fs').writeFile('async.txt', 'bye!', callback);
}

function fnSyncTest() {
    for (var i = 0; i < 10; i++) {}
}

function killProcess() {

    if (process.exitTimeoutId) {
        return;
    }

    process.exitTimeoutId = setTimeout(() => process.exit, 5000);
    console.log('process will exit in 5 seconds');

    fnAsyncTest(function() {
        console.log('async op. done', arguments);
    });

    if (!fnSyncTest()) {
        console.log('sync op. done');
    }
}

// https://nodejs.org/api/process.html#process_signal_events
process.on('SIGTERM', killProcess);
process.on('SIGINT', killProcess);

process.on('uncaughtException', function(e) {

    console.log('[uncaughtException] app will be terminated: ', e.stack);

    killProcess();
    /**
     * @https://nodejs.org/api/process.html#process_event_uncaughtexception
     *  
     * 'uncaughtException' should be used to perform synchronous cleanup before shutting down the process. 
     * It is not safe to resume normal operation after 'uncaughtException'. 
     * If you do use it, restart your application after every unhandled exception!
     * 
     * You have been warned.
     */
});

console.log('App is running...');
console.log('Try to press CTRL+C or SIGNAL the process with PID: ', process.pid);

process.stdin.resume();
// just for testing

Chỉ muốn đề cập đến deathgói ở đây: https://github.com/jprichardson/node-death

Thí dụ:

var ON_DEATH = require('death')({uncaughtException: true}); //this is intentionally ugly

ON_DEATH(function(signal, err) {
  //clean up code here
})

io.js có một exitvà một beforeExitsự kiện, làm những gì bạn muốn.

Đây là một bản hack hay cho windows

process.on('exit', async () => {
    require('fs').writeFileSync('./tmp.js', 'crash', 'utf-8')
});

Sau khi chơi xung quanh với câu trả lời khác, đây là giải pháp của tôi cho nhiệm vụ này. Thực hiện theo cách này giúp tôi tập trung dọn dẹp ở một nơi, ngăn chặn việc xử lý gấp đôi việc dọn dẹp.

1. Tôi muốn định tuyến tất cả các mã thoát khác đến mã 'thoát'.

const others = [`SIGINT`, `SIGUSR1`, `SIGUSR2`, `uncaughtException`, `SIGTERM`]
others.forEach((eventType) => {
    process.on(eventType, exitRouter.bind(null, { exit: true }));
})

2. Những gì exitRouter làm là gọi process.exit ()

function exitRouter(options, exitCode) {
   if (exitCode || exitCode === 0) console.log(`ExitCode ${exitCode}`);
   if (options.exit) process.exit();
}

3. Trên 'exit', xử lý dọn dẹp với một chức năng mới

function exitHandler(exitCode) {
  console.log(`ExitCode ${exitCode}`);
  console.log('Exiting finally...')
}

process.on('exit', exitHandler)

Đối với mục đích demo, đây là liên kết đến ý chính của tôi. Trong tệp, tôi thêm một setTimeout để giả mạo quá trình đang chạy.

Nếu bạn chạy node node-exit-demo.jsvà không làm gì thì sau 2 giây, bạn sẽ thấy nhật ký:

The service is finish after a while.
ExitCode 0
Exiting finally...

Khác nếu trước khi dịch vụ kết thúc, bạn chấm dứt bởi ctrl+C, bạn sẽ thấy:

^CExitCode SIGINT
ExitCode 0
Exiting finally...

Điều đã xảy ra là quá trình Node ban đầu được thoát với mã SIGINT, sau đó nó định tuyến đến process.exit () và cuối cùng đã thoát với mã thoát 0.

Trong trường hợp quy trình được sinh ra bởi một quy trình nút khác, như:

var child = spawn('gulp', ['watch'], {
    stdio: 'inherit',
});

Và bạn cố gắng giết nó sau, thông qua:

child.kill();

Đây là cách bạn xử lý sự kiện [trên đứa trẻ]:

process.on('SIGTERM', function() {
    console.log('Goodbye!');
});