Node.js fs.readFile로 파일 읽기 (동기, 비동기, Promise)

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 vs readFileSync vs 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 버전을 쓰세요. 그 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'));

첫 호출은 파일을 찾지 못해 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')도 되지만 결과를 캐시하기 때문에, 파일이 바뀐 뒤에도 두 번째 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개이고 마지막은 비어 있어서, 반복문은 번호 붙은 세 줄을 출력합니다. 윈도우에서 쓴 파일은 줄 끝이 \r\n이니, 둘 다 처리하려면 /\r?\n/로 나누세요.

몇 기가바이트짜리 로그는 메모리에 들어가지 않습니다. 대신 스트림으로 읽으면 한 번에 한 줄만 메모리에 둡니다.

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')를 쓰세요.