fs.readFile ב-Node.js: קריאת קבצים (sync, async, promises)

fs.readFile(path, 'utf8', callback) קורא קובץ שלם ומעביר את התוכן שלו ל-callback כמחרוזת. fs.readFileSync(path, 'utf8') מחזיר את המחרוזת ישירות ומחכה שהקריאה תסתיים, ו-await readFile(path, 'utf8') מתוך fs/promises עושה את אותו הדבר בלי לחסום. אם משמיטים את '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 רק מתחיל את הקריאה, וה-callback רץ כשהתוכן מוכן. מחקו את 'utf8', והריצו שוב: ה-callback מקבל <Buffer 42 75 79 20 6d 69 6c 6b 0a 43 61 6c 6c 20 41 64 61>, הבייטים הגולמיים של הקובץ.

readFile מול readFileSync מול fs/promises

שלושתם קוראים את אותו קובץ. ההבדל הוא איך מקבלים את התוצאה והאם שאר התוכנית מחכה.

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();

השורה הסינכרונית מודפסת ראשונה, כי שום דבר אחר לא רץ עד שהיא חוזרת. שתי האחרות מסתיימות אחרי הקוד הראשי, לפי הסדר שבו הקריאות שלהן מסתיימות.

השתמשו ב-readFileSync כשקוראים קובץ הגדרות בעלייה או בסקריפט קצר. בשרת, קריאה סינכרונית עוצרת כל בקשה אחרת בזמן שהדיסק עובד, אז שם השתמשו בגרסת ה-promise. הדף על fs/promises מכסה את שאר ה-API הזה.

טיפול בקובץ חסר (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'));

הקריאה הראשונה לא מוצאת קובץ וחוזרת ל-default settings; השנייה קוראת dark mode. זריקה מחדש של שאר השגיאות משאירה בעיות אמיתיות גלויות, במקום להשתמש בשקט בברירות מחדל.

fs.existsSync: למה פשוט לנסות לקרוא

fs.existsSync(path) מחזיר true או false, ומפתה לבדוק לפני הקריאה:

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

אלה שני צעדים כשאחד מספיק, והקובץ יכול להימחק ביניהם, כך שהקריאה עדיין יכולה לזרוק. נסו לקרוא וטפלו ב-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') עובד, אבל הוא שומר את התוצאה ב-cache, כך ש-require שני מחזיר את האובייקט הישן גם אחרי שהקובץ השתנה.

קריאת קובץ שורה אחרי שורה

לקובץ שנכנס בזיכרון, קראו אותו כולו ופצלו לפי תו השורה החדשה. סננו את המחרוזת הריקה שתו שורה חדשה בסוף משאיר.

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 פריטים, האחרון ריק, ולכן הלולאה מדפיסה שלוש שורות ממוספרות. קבצים שנכתבו ב-Windows מסיימים שורות ב-\r\n; פצלו לפי /\r?\n/ כדי לטפל בשני המקרים.

לוג של כמה גיגה-בייט לא נכנס בזיכרון. קראו אותו כ-stream, כך שרק שורה אחת מוחזקת בכל פעם:

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();

טעויות נפוצות

שימוש בתוצאה מחוץ ל-callback. const text = fs.readFile(...) הוא undefined. התוכן קיים רק בתוך ה-callback, או אחרי await.

לשכוח את הקידוד. בלי 'utf8' מקבלים Buffer, ו-data.split('\n') זורק data.split is not a function. העבירו את הקידוד בכל פעם שאתם רוצים טקסט.

נתיבים יחסיים לתיקייה הלא נכונה. את 'data.txt' מחפשים במקום שבו node הופעל. השתמשו ב-path.join(__dirname, 'data.txt') לקובץ שמגיע לצד הסקריפט שלכם.