Node.js fs.readFileでファイルを読み込む（同期・非同期）

fs.readFile(path, 'utf8', callback) はファイル全体を読み、その中身を文字列としてコールバックに渡します。fs.readFileSync(path, 'utf8') は読み込みが終わるのを待って文字列を直接返し、fs/promises の await readFile(path, 'utf8') は同じことをブロックせずに行います。'utf8' を省くと、テキストではなく生のバイトのBufferが返ります。

const fs = require('fs');

// Setup: create a file to read
fs.writeFileSync('notes.txt', 'Buy milk\nCall Ada');

fs.readFile('notes.txt', 'utf8', (err, text) => {
    if (err) {
        console.error('Could not read:', err.message);
        return;
    }
    console.log(text);
});

console.log('readFile called');

先に readFile called が表示されます。readFile は読み込みを開始するだけで、中身の準備ができてからコールバックが動くからです。'utf8', を消して実行し直すと、コールバックはファイルの生のバイト、<Buffer 42 75 79 20 6d 69 6c 6b 0a 43 61 6c 6c 20 41 64 61> を受け取ります。

readFile、readFileSync、fs/promisesの違い

3つとも同じファイルを読みます。違うのは、結果の受け取り方と、プログラムのほかの部分が待たされるかどうかです。

const fs = require('fs');
const fsp = require('fs/promises');

// Setup: create a file to read
fs.writeFileSync('greeting.txt', 'Hello from a file');

// 1. Sync: returns the text, blocks until done
const a = fs.readFileSync('greeting.txt', 'utf8');
console.log('sync:', a);

// 2. Callback: the result arrives later
fs.readFile('greeting.txt', 'utf8', (err, b) => {
    console.log('callback:', b);
});

// 3. Promise: await it inside an async function
async function main() {
    const c = await fsp.readFile('greeting.txt', 'utf8');
    console.log('promise:', c);
}
main();

同期版の行が最初に表示されます。それが戻るまでほかには何も実行されないからです。残りの2つはメインのコードの後に、読み込みが終わった順に完了します。

起動時に設定ファイルを読むときや短いスクリプトでは readFileSync を使います。サーバーでは、同期の読み込みはディスクが動いている間ほかのリクエストをすべて止めるので、Promise版を使いましょう。そのAPIの残りはfs/promisesのページで扱っています。

ファイルがないとき（ENOENT）

ファイルが存在しないと、エラーは code: 'ENOENT'（「error, no entry」）を持ちます。err.code を確認すれば、ファイルがないことと、権限の問題のようなほかの失敗とを区別できます。

const fs = require('fs');

function readSettings(file) {
    try {
        return fs.readFileSync(file, 'utf8');
    } catch (err) {
        if (err.code === 'ENOENT') {
            return 'default settings';
        }
        throw err; // anything else is a real problem
    }
}

console.log(readSettings('settings.txt'));

// Setup: now create the file and read again
fs.writeFileSync('settings.txt', 'dark mode');
console.log(readSettings('settings.txt'));

1回目の呼び出しはファイルが見つからず default settings を使い、2回目は dark mode を読みます。ほかのエラーを投げ直しておけば、本当の問題が黙ってデフォルト値に隠れることはありません。

fs.existsSync：読み込みをそのまま試すべき理由

fs.existsSync(path) は true か false を返すので、読む前に確認したくなります。

if (fs.existsSync('data.txt')) {
    const text = fs.readFileSync('data.txt', 'utf8');
}

これでは1回で済むところを2回に分けていて、しかもその間にファイルが消される可能性があるので、読み込みはやはり例外を投げることがあります。上の例のように、読み込みを試して ENOENT を処理しましょう。existsSync が適しているのは、何かがあるかどうかだけを知りたくて開くつもりがないとき、たとえばフォルダを作るかどうかを決めるときです。

JSONファイルを読む

テキストを読んで、JSON.parse でパースします。構文エラーのあるファイルは SyntaxError を投げるので、同じ try の中に入れておきましょう。

const fs = require('fs');

// Setup: write a JSON file
fs.writeFileSync('config.json', '{ "port": 3000, "debug": true }');

const config = JSON.parse(fs.readFileSync('config.json', 'utf8'));
console.log(config.port + 1);
console.log(typeof config.debug);

3001 と boolean が表示されます。パースした後の値はJSONの型を持っています。require('./config.json') でも読めますが、結果がキャッシュされるので、ファイルが変わった後でも2回目の require は古いオブジェクトを返します。

ファイルを1行ずつ読む

メモリに収まるファイルなら、全体を読んで改行文字で分割します。最後の改行が残す空文字列はフィルターで取り除きます。

const fs = require('fs');

// Setup: write a file with three lines
fs.writeFileSync('log.txt', 'start\nwarn: disk 91%\nstop\n');

const lines = fs.readFileSync('log.txt', 'utf8').split('\n');
console.log(lines.length);

lines.filter(Boolean).forEach((line, i) => {
    console.log(i + 1, line);
});

分割すると 4 個の要素になり、最後の1つは空なので、ループは番号付きの3行を表示します。Windowsで書かれたファイルは行末が \r\n なので、両方に対応するには /\r?\n/ で分割します。

数ギガバイトのログはメモリに収まりません。代わりにストリームで読めば、メモリに置くのは一度に1行だけです。

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

async function main() {
    const rl = readline.createInterface({
        input: fs.createReadStream('big.log'),
        crlfDelay: Infinity,
    });
    for await (const line of rl) {
        console.log(line);
    }
}
main();

よくある間違い

コールバックの外で結果を使う。 const text = fs.readFile(...) は undefined です。中身があるのはコールバックの中か、await の後だけです。

エンコーディングを忘れる。 'utf8' がないとBufferが返り、data.split('\n') は data.split is not a function を投げます。テキストが欲しいときは必ずエンコーディングを渡しましょう。

間違ったフォルダからの相対パス。 'data.txt' は node を起動した場所で探されます。スクリプトの隣に置くファイルには path.join(__dirname, 'data.txt') を使います。