파일 시스템

Node.js에서 파일 시스템을 다루기 위해 기본적으로 fs (File System) 모듈을 사용합니다. 이 모듈은 파일 읽기, 쓰기, 삭제, 이동, 이름 변경 등 다양한 파일 시스템 작업을 수행할 수 있게 해줍니다.

fs

: 파일 시스템 작업을 수행하기 위한 모듈

문법

const fs = require('fs');
JavaScript
복사

fs 모듈 주요 메소드 및 속성

메소드 및 속성	설명
fs.readFile()	파일을 비동기적으로 읽습니다.
fs.writeFile()	파일에 내용을 비동기적으로 씁니다.
fs.unlink()	파일을 비동기적으로 삭제합니다.
fs.mkdir()	디렉토리를 비동기적으로 생성합니다.
fs.readdir()	디렉토리의 파일 목록을 비동기적으로 읽어옵니다.
fs.rename()	파일 또는 디렉토리의 이름을 비동기적으로 변경합니다.

파일 읽기 (fs.readFile)

•

파일의 내용을 비동기적으로 읽어옵니다.

fs.readFile(path, [options], callback);
JavaScript
복사

const fs = require('fs');

fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) {
    console.error('Error reading file:', err);
    return;
  }
  console.log('File content:', data);
});
JavaScript
복사

파일 쓰기 (fs.writeFile)

•

파일에 내용을 비동기적으로 씁니다.

fs.writeFile(path, [options], callback);
JavaScript
복사

const fs = require('fs');

const contentToWrite = 'Hello, Node.js!';

fs.writeFile('newFile.txt', contentToWrite, 'utf8', (err) => {
  if (err) {
    console.error('Error writing file:', err);
    return;
  }
  console.log('File has been written.');
});
JavaScript
복사

파일 삭제 (fs.unlink)

•

파일을 비동기적으로 삭제합니다.

fs.unlink(path, callback);
JavaScript
복사

const fs = require('fs');

fs.unlink('fileToDelete.txt', (err) => {
  if (err) {
    console.error('Error deleting file:', err);
    return;
  }
  console.log('File has been deleted.');
});
JavaScript
복사

디렉토리 생성 (fs.mkdir):

•

디렉토리를 비동기적으로 생성합니다.

fs.mkdir(path, [options], callback);
JavaScript
복사

const fs = require('fs');

fs.mkdir('newDirectory', (err) => {
  if (err) {
    console.error('Error creating directory:', err);
    return;
  }
  console.log('Directory has been created.');
});
JavaScript
복사

디렉토리 읽기 (fs.readdir):

•

디렉토리의 파일 목록을 비동기적으로 읽어옵니다.

fs.readdir(path, [options], callback);
JavaScript
복사

const fs = require('fs');

fs.readdir('directoryToRead', (err, files) => {
  if (err) {
    console.error('Error reading directory:', err);
    return;
  }
  console.log('Files in the directory:', files);
});
JavaScript
복사

파일 이동 또는 이름 변경 (fs.rename):

•

파일 또는 디렉토리의 이름을 비동기적으로 변경합니다.

fs.rename(oldPath, newPath, callback);
JavaScript
복사

const fs = require('fs');

fs.rename('oldName.txt', 'newName.txt', (err) => {
  if (err) {
    console.error('Error renaming file:', err);
    return;
  }
  console.log('File has been renamed.');
});
JavaScript
복사

사용 목적

•

파일의 읽기, 쓰기, 삭제 등의 작업을 수행할 때 사용됩니다.

•

디렉토리의 생성, 읽기, 파일의 이동 또는 이름 변경 등 파일 시스템 관리에 활용됩니다.

동기 메소드와 비동기 메소드

비동기식 파일 입력

const fs = require('fs');

console.log('시작');
fs.readFile('./test1.txt', (err, data) => {
  if (err) {
    throw err;
  }
  console.log('1번', data.toString());
});
fs.readFile('./test2.txt', (err, data) => {
  if (err) {
    throw err;
  }
  console.log('2번', data.toString());
});
fs.readFile('./test3.txt', (err, data) => {
  if (err) {
    throw err;
  }
  console.log('3번', data.toString());
});
console.log('끝');
JavaScript
복사

동기식 파일 입력

const fs = require('fs');

console.log('시작');
let data = fs.readFileSync('./test1.txt');
console.log('1번', data.toString());
data = fs.readFileSync('./test2.txt');
console.log('2번', data.toString());
data = fs.readFileSync('./test3.txt');
console.log('3번', data.toString());
console.log('끝');
JavaScript
복사

순서를 유지하기 위한, 콜백 기반 비동기식 파일 입력

const fs = require('fs');

console.log('시작');
fs.readFile('./test1.txt', (err, data) => {
    console.log('1번', data.toString());
    fs.readFile('./test1.txt', (err, data) => {
        console.log('2번', data.toString());
        fs.readFile('./test1.txt', (err, data) => {
            console.log('3번', data.toString());
            fs.readFile('./test1.txt', (err, data) => {
                console.log('4번', data.toString());
                fs.readFile('./test1.txt', (err, data) => {
                    console.log('5번', data.toString());
                    fs.readFile('./test1.txt', (err, data) => {
                        console.log('6번', data.toString());
                        fs.readFile('./test1.txt', (err, data) => {
                            console.log('7번', data.toString());
                            fs.readFile('./test1.txt', (err, data) => {
                                console.log('8번', data.toString());
                                fs.readFile('./test1.txt', (err, data) => {
                                    console.log('9번', data.toString());
                                    fs.readFile('./test1.txt', (err, data) => {
                                        console.log('10번', data.toString());
                                        console.log('끝');
                                    });
                                });
                            });
                        });
                    });
                });
            });
        });
    });
});
JavaScript
복사

콜백지옥

: 콜백함수 기반, 비동기식 요청으로 순서를 유지하려고 할 때, 콜백이 끝나지 않는 지옥이 되어버린다.

순서를 유지하기 위한, Promise 기반 비동기식 파일 입력

const fs = require('fs').promises;

console.log('시작');
fs.readFile('./test1.txt')
  .then((data) => {
    console.log('1번', data.toString());
    return fs.readFile('./test2.txt');
  })
  .then((data) => {
    console.log('2번', data.toString());
    return fs.readFile('./test3.txt');
  })
  .then((data) => {
    console.log('3번', data.toString());
    console.log('끝');
  })
  .catch((err) => {
    console.error(err);
  });
JavaScript
복사

버퍼 (Buffer)

정의

버퍼는 일련의 데이터를 임시로 저장하는 공간으로, 주로 이진 데이터를 다룰 때 사용됩니다. Node.js에서는 Buffer 클래스를 제공하여 이진 데이터를 다루기 위한 메모리 공간을 할당하고 조작할 수 있습니다.

버퍼링 : 데이터 흐름을 조절하기 위해, 데이터 전송에 필요한 최소한의 데이터를 임시 메모리 공간에 저장하는 과정

생각해보기

•

컴퓨터 사양 - RAM 4GB

원본 파일 용량 : 1GB, 버퍼 1GB, 다운로드 동시 요청 가능 사용자 수 : 4명

원본 파일 용량 : 1GB, 버퍼 1MB, 다운로드 동시 요청 사용자 수 : 4000명

주요 특징

고정된 크기: 버퍼는 생성 시 크기가 고정되며, 크기를 변경할 수 없습니다.

시퀀스로 데이터 액세스: 버퍼의 내용은 바이트의 시퀀스로 구성되며, 각 바이트는 인덱스를 통해 접근됩니다.

이진 데이터 다루기: 주로 파일이나 네트워크에서 전송되는 이진 데이터를 다룰 때 사용됩니다.

주요 속성 및 메소드

메소드/속성	설명
Buffer.from()	주어진 데이터로 새로운 버퍼를 생성합니다.
toString()	버퍼의 내용을 문자열로 변환합니다.
concat()	여러 버퍼를 하나로 합칩니다.
Buffer.alloc()	지정된 크기의 새로운 버퍼를 생성하고 초기화합니다.

Buffer.from()

// 문자열을 버퍼로 변환
const bufferFromStr = Buffer.from('Hello, Buffer!', 'utf8');

// 배열을 버퍼로 변환
const bufferFromArray = Buffer.from([1, 2, 3, 4, 5]);

// 버퍼를 복사하여 새로운 버퍼 생성
const bufferCopy = Buffer.from(bufferFromStr);
JavaScript
복사

Buffer.toString()

const buffer = Buffer.from('Hello, Buffer!', 'utf8');

// 버퍼를 문자열로 변환
const bufferToString = buffer.toString('utf8');
console.log(bufferToString); // 'Hello, Buffer!'
JavaScript
복사

Buffer.concat()

const buffer1 = Buffer.from('Hello, ');
const buffer2 = Buffer.from('Buffer!');
const concatenatedBuffer = Buffer.concat([buffer1, buffer2]);

console.log(concatenatedBuffer.toString()); // 'Hello, Buffer!'
JavaScript
복사

Buffer.alloc()

// 10바이트 크기의 초기화된 버퍼 생성
const initializedBuffer = Buffer.alloc(10);

// 10바이트 크기의 미리 지정된 값으로 초기화된 버퍼 생성
const filledBuffer = Buffer.alloc(10, 1); // 각 바이트에는 1이 채워짐
JavaScript
복사

스트림 (Stream)

정의

Node.js의 Stream 모듈은 데이터의 흐름을 처리하는데 사용되는 모듈로, 대용량의 데이터를 효율적으로 처리하기 위한 API를 제공합니다. 스트림은 데이터를 작은 조각으로 나누어 처리하므로 메모리 사용이 효율적이며, 네트워크나 파일과 같은 입출력 작업에 특히 유용합니다

문법

스트림은 stream 모듈을 통해 사용할 수 있습니다.

const stream = require('stream');
JavaScript
복사

주요 속성 및 메소드

Readable Stream (읽기 스트림)

속성 또는 메소드	설명
data	이벤트 핸들러, 데이터가 도착할 때 발생하는 이벤트.
end	이벤트 핸들러, 스트림의 끝에 도달할 때 발생하는 이벤트.
read(size)	스트림에서 지정된 크기만큼 데이터를 읽습니다.

Writable Stream (쓰기 스트림)

속성 또는 메소드	설명
write(chunk, encoding, callback)	스트림에 데이터를 씁니다.
end([chunk, encoding, callback])	스트림의 끝을 나타내며, 데이터를 쓰고 스트림을 종료합니다.

Duplex Stream (양방향 스트림):

Readable과 Writable을 결합한 스트림.

예시코드

const { Readable, Writable } = require('stream');

// Readable Stream 예제
const readableStream = new Readable({
  read(size) {
    this.push('Hello, ');
    this.push('world!');
    this.push(null); // 더 이상 데이터가 없음을 알림
  }
});

// Writable Stream 예제
const writableStream = new Writable({
  write(chunk, encoding, callback) {
    console.log(chunk.toString());
    callback();
  }
});

readableStream.pipe(writableStream); // Readable 스트림에서 데이터를 Writable 스트림으로 전송
JavaScript
복사

사용 목적

•

대용량 데이터 처리: 파일이나 네트워크에서 데이터를 효율적으로 처리할 때 유용합니다.

•

실시간 데이터 전송: 실시간으로 데이터를 생성하고 다른 시스템에 전송할 때 사용합니다.

•

비동기적으로 데이터 처리: 스트림은 비동기적으로 데이터를 처리하므로 작업을 중단하지 않고 계속 데이터를 읽거나 쓸 수 있습니다.