プログラミング

Node.jsでのファイル操作ガイド

最終更新： 10/03/2025
1 分の読み

Node.js でのファイル操作は、サーバーサイドでの効率的なアプリケーション開発において非常に重要な要素です。ファイルシステムを操作することで、データの保存、読み込み、更新、削除などの基本的な操作を行うことができます。このガイドでは、Node.js でファイルを扱う方法について完全かつ包括的に説明します。

1. Node.js でファイル操作を行うための基本モジュール

Node.js にはファイルシステムを操作するための組み込みモジュール fs（File System）が提供されています。このモジュールは、非同期と同期の両方でファイルを操作するための多くのメソッドを提供しています。まずは、fs モジュールをインポートする方法から始めましょう。

関連記事
javascript
const fs = require('fs');

これで、fs モジュールを使用してファイルの操作が可能になります。

2. 非同期ファイル操作

Node.js の fs モジュールは、非同期操作がデフォルトです。非同期メソッドは、処理が完了する前に次のコードを実行できるため、パフォーマンスの向上が期待できます。以下に、よく使用される非同期メソッドを紹介します。

2.1 ファイルの読み込み

ファイルを非同期で読み込むには fs.readFile メソッドを使用します。このメソッドは、読み込んだデータをコールバック関数で処理します。

javascript
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('ファイルの読み込みに失敗しました:', err);
    return;
  }
  console.log('ファイルの内容:', data);
});

上記の例では、example.txt というファイルを UTF-8 エンコーディングで読み込み、その内容をコンソールに出力します。

2.2 ファイルへの書き込み

非同期でファイルにデータを書き込むには、fs.writeFile メソッドを使用します。

javascript
const content = 'これは新しいコンテンツです。';
fs.writeFile('output.txt', content, (err) => {
  if (err) {
    console.error('ファイルの書き込みに失敗しました:', err);
    return;
  }
  console.log('ファイルの書き込みが完了しました');
});

このコードは、output.txt というファイルに指定したコンテンツを書き込みます。

2.3 ファイルの削除

非同期でファイルを削除するには、fs.unlink メソッドを使用します。

javascript
fs.unlink('example.txt', (err) => {
  if (err) {
    console.error('ファイルの削除に失敗しました:', err);
    return;
  }
  console.log('ファイルが削除されました');
});

example.txt ファイルが削除されます。削除の前にファイルが存在しない場合、エラーが発生します。

3. 同期ファイル操作

同期メソッドは、操作が完了するまで次のコードを実行しないため、処理の順序が保証されます。ファイル操作が完了するまで待機したい場合に有効です。以下に、同期メソッドの例を紹介します。

3.1 ファイルの読み込み

同期的にファイルを読み込むには fs.readFileSync メソッドを使用します。

javascript
try {
  const data = fs.readFileSync('example.txt', 'utf8');
  console.log('ファイルの内容:', data);
} catch (err) {
  console.error('ファイルの読み込みに失敗しました:', err);
}

このコードはファイルの内容を同期的に読み込み、エラーが発生した場合はキャッチします。

3.2 ファイルへの書き込み

同期的にファイルにデータを書き込むには fs.writeFileSync メソッドを使用します。

javascript
const content = '同期的に書き込みました。';
try {
  fs.writeFileSync('output.txt', content);
  console.log('ファイルの書き込みが完了しました');
} catch (err) {
  console.error('ファイルの書き込みに失敗しました:', err);
}

このコードは指定されたファイルに内容を同期的に書き込みます。

3.3 ファイルの削除

同期的にファイルを削除するには、fs.unlinkSync メソッドを使用します。

javascript
try {
  fs.unlinkSync('example.txt');
  console.log('ファイルが削除されました');
} catch (err) {
  console.error('ファイルの削除に失敗しました:', err);
}

同期的にファイルを削除し、エラーが発生した場合はキャッチします。

4. ディレクトリ操作

ファイルだけでなく、ディレクトリの操作も可能です。以下は、ディレクトリを操作するための主要なメソッドです。

4.1 ディレクトリの作成

fs.mkdir を使用して、新しいディレクトリを作成できます。

javascript
fs.mkdir('new_directory', (err) => {
  if (err) {
    console.error('ディレクトリの作成に失敗しました:', err);
    return;
  }
  console.log('ディレクトリが作成されました');
});

4.2 ディレクトリ内のファイルのリスト取得

ディレクトリ内のファイルをリストとして取得するには、fs.readdir メソッドを使用します。

javascript
fs.readdir('some_directory', (err, files) => {
  if (err) {
    console.error('ディレクトリの読み込みに失敗しました:', err);
    return;
  }
  console.log('ディレクトリ内のファイル:', files);
});

4.3 ディレクトリの削除

空のディレクトリを削除するには、fs.rmdir メソッドを使用します。

javascript
fs.rmdir('empty_directory', (err) => {
  if (err) {
    console.error('ディレクトリの削除に失敗しました:', err);
    return;
  }
  console.log('ディレクトリが削除されました');
});

5. ストリームを使用したファイル操作

Node.js のファイル操作は、ストリームを使用することで効率的にデータを処理することができます。ストリームは、大きなファイルを読み書きする際にメモリの使用量を抑えるため、非常に重要です。

5.1 ファイルの読み込み（ストリーム）

fs.createReadStream メソッドを使用してファイルをストリームとして読み込むことができます。

javascript
const readStream = fs.createReadStream('large_file.txt', 'utf8');
readStream.on('data', (chunk) => {
  console.log('読み込んだデータ:', chunk);
});
readStream.on('end', () => {
  console.log('ファイルの読み込みが完了しました');
});

5.2 ファイルへの書き込み（ストリーム）

fs.createWriteStream メソッドを使用して、ストリームでファイルにデータを書き込むことができます。

javascript
const writeStream = fs.createWriteStream('output.txt');
writeStream.write('新しいデータを書き込みました\n');
writeStream.end(() => {
  console.log('ファイルの書き込みが完了しました');
});

6. エラーハンドリング

ファイル操作を行う際、エラーが発生する可能性があります。エラーを適切に処理することは非常に重要です。エラーをキャッチして適切にログ出力や再試行を行うことが、安定したアプリケーションの実現に繋がります。

javascript
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('エラー発生:', err);
    return;
  }
  console.log('ファイル内容:', data);
});

結論

Node.js でファイルを操作する方法について説明しました。非同期と同期のメソッドを使い分けることで、効率的にファイルを扱うことができます。また、ストリームを使用することで、大きなファイルの読み書きをメモリ効率よく行うことができます。これらの基本的な操作をマスターすることで、Node.js を使用したサーバーサイドのアプリケーション開発において、ファイル操作を効果的に利用することができるようになります。

最終更新： 10/03/2025
1 分の読み
Back to top button