【Node.js24.x】Object::readFile()メソッドの使い方
readFileメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
readFileメソッドは、Node.jsのファイルシステム(fs)モジュールの一部として、指定されたファイルのコンテンツを非同期的に読み込む処理を実行するメソッドです。このメソッドは、プログラムの他の処理を停止させることなく、バックグラウンドでファイルの読み込みを行います。これにより、読み込み処理中にアプリケーションが応答不能になったり、サーバーが他のリリクエストを処理できなくなったりするのを防ぎます。
具体的には、readFileメソッドは読み込みたいファイルのパスと、読み込み完了後やエラー発生時に実行されるコールバック関数を引数に取ります。コールバック関数は、通常、エラーオブジェクトとファイルの内容を示すデータを引数として受け取ります。ファイルのエンコーディング(例: 'utf8')を指定することで、ファイルの内容をそのまま文字列として取得できます。エンコーディングを指定しない場合、ファイルの内容はBufferオブジェクトとして渡されます。
このメソッドは、設定ファイルの読み込み、テキストデータファイルの処理、あるいはWebサーバーで静的ファイルを配信するといった多岐にわたる用途で利用されます。ファイルが存在しない場合や、読み取り権限がない場合など、エラーが発生する可能性もあるため、コールバック関数内でエラーハンドリングを行うことが重要です。Node.jsのfs/promisesモジュールにあるreadFileも利用可能で、よりモダンな非同期処理の記述が可能です。
構文(syntax)
1const fs = require('node:fs'); 2 3fs.readFile('ファイルへのパス.txt', 'utf8', (err, data) => { 4 if (err) { 5 // ファイル読み込み中にエラーが発生した場合の処理 6 return; 7 } 8 // ファイルの内容が正常に読み込まれた場合の処理 9 // `data`変数にファイルの内容(文字列)が含まれます 10});
引数(parameters)
path, options, callback
- path: string: 読み込むファイルのパス
- options: object: ファイルの読み込みオプション
- callback: function: ファイル読み込み完了後に実行されるコールバック関数
戻り値(return)
戻り値なし
戻り値はありません