Node.jsでspawnモジュールを使って子プロセスを生成し、端末出力をリアルタイムで取得する方法

2024-06-17

Node.jsで子プロセスを生成し、端末出力をリアルタイムで取得する方法

spawnモジュールのインポート

まず、spawnモジュールをプロジェクトにインポートする必要があります。

const { spawn } = require('child_process');

子プロセスの生成

spawn関数を使用して、子プロセスを生成します。引数として、実行するコマンドとオプションを指定します。

const childProcess = spawn('ls', ['-l']);

この例では、lsコマンドを実行し、詳細な一覧表示 (-l) をオプションとして指定しています。

出力の取得

子プロセスから出力を読み取るには、stdoutイベントリスナーを使用します。

childProcess.stdout.on('data', (data) => {
  console.log(data.toString());
});

このコードは、子プロセスから生成されるすべてのデータを出力コンソールに表示します。

エラー処理

子プロセスからエラーが発生した場合は、stderrイベントリスナーを使用して処理できます。

childProcess.stderr.on('data', (data) => {
  console.error(data.toString());
});

子プロセスが終了したら、exitイベントが発行されます。このイベントを使用して、クリーンアップ処理を実行できます。

childProcess.on('exit', (statusCode) => {
  if (statusCode !== 0) {
    console.error(`子プロセスが終了しました。終了ステータス: ${statusCode}`);
  }
});

このコードは、子プロセスの終了ステータスをチェックし、エラーが発生した場合はエラーメッセージを出力します。

例

以下の例は、lsコマンドを実行し、その出力をリアルタイムで表示する Node.js スクリプトです。

const { spawn } = require('child_process');

const childProcess = spawn('ls', ['-l']);

childProcess.stdout.on('data', (data) => {
  console.log(data.toString());
});

childProcess.stderr.on('data', (data) => {
  console.error(data.toString());
});

childProcess.on('exit', (statusCode) => {
  if (statusCode !== 0) {
    console.error(`子プロセスが終了しました。終了ステータス: ${statusCode}`);
  }
});

このスクリプトを実行すると、現在のディレクトリにあるすべてのファイルとディレクトリの詳細な一覧が表示されます。

補足

spawnモジュールは、シェルコマンドだけでなく、Node.js スクリプトも実行するために使用できます。
子プロセスの入力を制御するには、stdinプロパティを使用します。
子プロセスとの通信をより詳細に制御するには、execまたはexecFile関数を使用することもできます。

サンプルコード：Node.jsで子プロセスを生成し、端末出力をリアルタイムで取得する

const { spawn } = require('child_process');

const childProcess = spawn('ls', ['-l']);

childProcess.stdout.on('data', (data) => {
  console.log(data.toString());
});

childProcess.stderr.on('data', (data) => {
  console.error(data.toString());
});

childProcess.on('exit', (statusCode) => {
  if (statusCode !== 0) {
    console.error(`子プロセスが終了しました。終了ステータス: ${statusCode}`);
  }
});

このコードの説明:

const { spawn } = require('child_process');: spawnモジュールをインポートします。
const childProcess = spawn('ls', ['-l']);: spawn関数を使用して、lsコマンドを実行し、詳細な一覧表示 (-l) をオプションとして指定して、子プロセスを生成します。
childProcess.stdout.on('data', (data) => { ... });: 子プロセスの標準出力からデータが受信されたときに呼び出されるイベントリスナーを設定します。このリスナーは、受信されたデータをコンソールに出力します。
childProcess.on('exit', (statusCode) => { ... });: 子プロセスが終了したときに呼び出されるイベントリスナーを設定します。このリスナーは、子プロセスの終了ステータスをチェックし、エラーが発生した場合はエラーメッセージを出力します。

このコードを実行する方法:

このコードを .js ファイル（例：child-process-example.js）に保存します。
ターミナルで、次のコマンドを実行してスクリプトを実行します。

node child-process-example.js

出力例:

drwxr-xr-x   2 user  group        4096 Jun 17 10:12 .
-rw-r--r--   1 user  group        819 Jun 17 10:12 child-process-example.js

このコードは、基本的な例です。より複雑な処理を行う場合は、spawnモジュールのドキュメントを参照してください。

Node.jsで子プロセスを生成し、端末出力をリアルタイムで取得するその他の方法

execモジュールは、シェルコマンドを実行し、その出力を文字列として返します。リアルタイム出力を取得するには、child_process.exec関数のオプションとしてstdioオプションを使用する必要があります。

const { exec } = require('child_process');

exec('ls -l', { stdio: ['pipe', 'pipe', 'ignore'] }, (error, stdout, stderr) => {
  if (error) {
    console.error(error);
    return;
  }

  console.log(stdout);
});

このコードは、lsコマンドを実行し、その出力をコンソールに出力します。

execFileモジュールは、実行可能ファイルを実行し、その出力を文字列として返します。execモジュールと同様に、stdioオプションを使用してリアルタイム出力を取得できます。

const { execFile } = require('child_process');

execFile('ls', ['-l'], { stdio: ['pipe', 'pipe', 'ignore'] }, (error, stdout, stderr) => {
  if (error) {
    console.error(error);
    return;
  }

  console.log(stdout);
});

readlineモジュールを使用して、子プロセスの標準入力と標準出力からデータを逐次読み取ることができます。

const { spawn, createInterface } = require('child_process');
const readline = require('readline');

const childProcess = spawn('ls', ['-l']);

const rl = readline.createInterface({
  input: childProcess.stdout,
  output: process.stdout,
});

rl.on('line', (line) => {
  console.log(line);
});

childProcess.on('exit', (statusCode) => {
  if (statusCode !== 0) {
    console.error(`子プロセスが終了しました。終了ステータス: ${statusCode}`);
  }

  rl.close();
});