Node.js readline モジュール

Java FileNode.js 組み込みモジュール


Node.js のreadlineモジュールは、読み取り可能なストリーム(例:process.stdin)から行単位でデータを読み取るためのインターフェースです。コマンドライン入力を処理する簡単な方法を提供し、インタラクティブなコマンドラインアプリケーションの作成に最適です。


基本的な使い方

readline モジュールの導入

を使用するにはreadlineモジュールを最初に導入する必要があります:

const readline = require('readline');

readline インターフェースの作成

作成readline.Interfaceインスタンスがこのモジュールを使用する上での核心です:

例

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

ここでは、標準入力(キーボード)からデータを読み取り、標準出力(コンソール)に出力を書き込むインターフェースを作成しています。


主要なメソッドとイベント

行単位での入力読み取り

を使用してquestion()メソッドでユーザーに質問し、回答を待つことができます:

例

rl.question(「お名前は?」, (answer) => {
  console.log(`こんにちは、${answer}!`);
  rl.close();
});

line イベントの監視

ユーザーが1行入力してEnterキーを押すと、lineイベントが発生します:

例

rl.on('line', (input) => {
  console.log(`受信:${input}`);
  if (input === 'exit') {
    rl.close();
  }
});

インターフェースのクローズ

を使用してclose()メソッドでインターフェースを閉じ、リソースを解放します:

例

rl.close();

インターフェースが閉じられると、closeイベントが発生します:

例

rl.on('close', () => {
  console.log(「さようなら!」);
  process.exit(0);
});

高度な機能

履歴

readlineモジュールはコマンド履歴機能をサポートしています:

例

rl.history = ['コマンド1', 'コマンド2'];  // 履歴を設定

ユーザーは上下矢印キーを使用して履歴コマンドを参照できます。

カスタム補完

カスタムの Tab 補完機能を実装できます:

例

rl.on('completer', (line) => {
  const completions = ['help', 'exit', 'show'];
  const hits = completions.filter((c) => c.startsWith(line));
  return [hits.length ? hits : completions, line];
});

カーソル制御

readlineカーソルを制御するためのいくつかのメソッドを提供します:

例

readline.cursorTo(process.stdout, 10, 5);  // カーソルを10列5行目に移動
readline.clearLine(process.stdout, 0);     // 現在の行をクリア
readline.clearScreenDown(process.stdout);  // カーソルより下の内容をクリア

実際の応用例

簡単なコマンドラインQ&Aプログラムを作成する

例

const readline = require('readline');

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

const questions = [
  「お名前は?」,
  「今年は何歳ですか?」,
  「一番好きなプログラミング言語は何ですか?」
];

const answers = [];

function askQuestion(i = 0) {
  if (i >= questions.length) {
    console.log(「回答ありがとう:」, answers);
    return rl.close();
  }

  rl.question(questions[i], (answer) => {
    answers.push(answer);
    askQuestion(i + 1);
  });
}

askQuestion();

簡単なコマンドライン計算機を作成する

例

const readline = require('readline');

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

function calculator() {
  rl.question('式を入力してください (例: 2 + 3 または exit で終了): ', (input) => {
    if (input === 'exit') {
      return rl.close();
    }

    try {
      const result = eval(input);  // 注意:実際のアプリケーションではevalを直接使用するのは避けるべきです
      console.log(`結果: ${result}`);
    } catch (e) {
      console.log('無効な式');
    }

    calculator();  // 再帰呼び出しで次の計算を続行
  });
}

calculator();

セキュリティに関する注意事項

  1. eval() の使用を避ける:上記の計算機の例ではeval()を使用しましたが、これは入力されたあらゆるJavaScriptコードを実行するため、本番環境では安全ではありません。実際のアプリケーションでは専用の式パーサーを使用すべきです。

  2. 入力検証:常にユーザー入力を検証し、インジェクション攻撃やその他のセキュリティ問題を防止してください。

  3. エラーハンドリング:すべての非同期操作に適切なエラーハンドリングを追加してください。


まとめ

Node.js のreadlineモジュールは、インタラクティブなコマンドラインツールを構築するための強力なツールです。これを使用することで、以下のことが可能になります:

  • ユーザー入力を簡単に取得する
  • Q&A形式のインタラクティブインターフェースを作成する
  • コマンド履歴を実装する
  • Tab補完機能を追加する
  • ターミナルのカーソルと出力を制御する

を習得するreadlineモジュールはNode.jsコマンドラインツールを開発する上で重要な一歩です。この記事がこのモジュールの理解と使用に役立つことを願っています。

Java FileNode.js 組み込みモジュール

その他の拡張