Node.jsにおけるファイル操作：テキストファイルの読み込みと配列への格納

2024-04-19

Node.js でテキストファイルを配列に読み込む方法

以下、その方法を2通りご紹介します。

fs.readFileSyncを使う方法

この方法は、ファイルを一度にすべて読み込み、配列に格納します。コードは以下のようになります。

const fs = require('fs');

const filePath = 'path/to/your/file.txt';
const fileContent = fs.readFileSync(filePath, 'utf8');
const lines = fileContent.split('\n');

console.log(lines);

このコードは以下の処理を行います。

fsモジュールをrequireします。
読み込むファイルのパスをfilePath変数に格納します。
fs.readFileSyncを使用して、ファイルを同期的に読み込みます。エンコーディングはutf8を指定します。
fileContentを改行('\n')で分割し、配列linesに格納します。
linesの内容をコンソールに出力します。

ポイント

この方法は、ファイルが小さい場合に適しています。
ファイルが大きい場合や、メモリ使用量を抑えたい場合は、次の方法を使用することをおすすめします。

fs.createReadStreamとreadlineを使う方法

const fs = require('fs');
const readline = require('readline');

const filePath = 'path/to/your/file.txt';
const lines = [];

const rl = readline.createInterface({
  input: fs.createReadStream(filePath),
});

rl.on('line', (line) => {
  lines.push(line);
});

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

空の配列linesを作成します。
readline.createInterfaceを使用して、rlという readline インターフェースを作成します。
rl.on('line')イベントリスナーを定義します。このイベントリスナーは、ファイルから1行読み込まれるたびに呼び出されます。
イベントリスナー内で、読み込まれた行をlines配列に追加します。

この方法は、ファイルが大きい場合や、メモリ使用量を抑えたい場合に適しています。
ファイルの読み込みが完了した後に、lines配列に対して処理を行うことができます。

上記のコードは、UTF-8 エンコーディングのテキストファイルを読み込むことを前提としています。
異なるエンコーディングのファイルを読み込む場合は、fs.readFileSyncまたはfs.createReadStreamのオプションでエンコーディングを指定する必要があります。
ファイルが存在しない場合や、読み込みに失敗した場合には、エラー処理を行う必要があります。

Node.js でテキストファイルを配列に読み込むサンプルコード

fs.readFileSyncを使う方法

const fs = require('fs');

const filePath = 'sample.txt';
const fileContent = fs.readFileSync(filePath, 'utf8');
const lines = fileContent.split('\n');

console.log(lines);

fs.createReadStreamとreadlineを使う方法

const fs = require('fs');
const readline = require('readline');

const filePath = 'sample.txt';
const lines = [];

const rl = readline.createInterface({
  input: fs.createReadStream(filePath),
});

rl.on('line', (line) => {
  lines.push(line);
});

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

このコードは、sample.txtというファイルを1行ずつ読み込み、配列linesに格納し、コンソールに出力します。

補足

上記のコードは、Node.js 16.14.0 で動作確認しています。
ファイルパスは、ご自身の環境に合わせて変更してください。
ファイルの内容は、以下のようになっています。

line1
line2
line3

出力は以下のようになります。

[ 'line1', 'line2', 'line3' ]

注意事項

ファイルが大きい場合は、fs.createReadStreamとreadlineを使う方法の方が効率的に読み込むことができます。

Node.js でテキストファイルを配列に読み込むその他の方法

Promise.allとmapを使う方法

この方法は、Promise APIを使用して、ファイルを非同期的に読み込みます。コードは以下のようになります。

const fs = require('fs');
const filePath = 'path/to/your/file.txt';

fs.promises.readFile(filePath, 'utf8')
  .then((fileContent) => {
    const lines = fileContent.split('\n');
    return lines;
  })
  .then((lines) => {
    console.log(lines);
  })
  .catch((err) => {
    console.error(err);
  });

fs.promises.readFileを使用して、ファイルを非同期的に読み込みます。
ファイルの内容をPromiseで返します。
Promiseがresolveされると、thenハンドラーが呼び出されます。
thenハンドラー内で、ファイルの内容を改行で分割し、配列linesに格納します。
catchハンドラー内で、エラーを出力します。

この方法は、非同期処理をわかりやすく記述することができます。
エラー処理を容易に行うことができます。

async/awaitを使う方法

この方法は、非同期処理をより簡潔に記述することができます。コードは以下のようになります。

const fs = require('fs');
const filePath = 'path/to/your/file.txt';

(async () => {
  const fileContent = await fs.promises.readFile(filePath, 'utf8');
  const lines = fileContent.split('\n');
  console.log(lines);
})();