Node.js

Node.js의 소개 문서에서 정의하는 Node.js는 "비동기 이벤트 기반의 JavaScript 런타임"이다.

About Node.js
As an asynchronous event-driven JavaScript runtime, Node.js is designed to build scalable network applications.

브라우저에서 사용할 수 있는 비동기(Web APIs)는 setTimeout(), DOM events, XMLHttpRequest()등으로 다소 한정적이지만, Node.js의 경우 많은 API가 비동기로 작성되어 있다.

먼저 Node.js 모듈을 사용하는 방법을 학습하고, 이를 통해 비동기 상황을 연출하고 연습해보자.

---

Node.js 내장 모듈 (Node.js built-in modules)

모듈 : 어떤 기능을 조립할 수 있는 형태로 만든 것
Node.js v16.17.1 documentation (Node.js 내장 모듈 목록)

require()

모든 모듈은 모듈을 사용하기 위해 불러오는 과정이 필요하다.
Node.js에서는 JavaScript 코드 상단에 require() 구문을 이용해 다른 파일을 불러온다.

const fs = require('fs'); // File System 모듈을 불러온다.
const dns = require('dns'); // DNS 모듈을 불러온다.

3rd-party 모듈

: 해당 프로그래밍 언어에서 공식적으로 제공하는 빌트인 모듈이 아닌 모든 외부 모듈
underscore는 Node.js 공식 문서에 없는 모듈이므로 서드 파티 모듈이다.

사용법

1. 서드 파티 모듈을 다운로드하기 위해서는 npm을 사용한다.

npm install underscore # underscore 모듈을 설치한다.

2. 이렇게 node.modules 폴더에 모듈을 다운받은 후, Node.js 내장 모듈을 불러오는 방법을 똑같이 require() 구문을 이용해 불러오면 된다.

const _ = require('underscore'); // underscore 모듈을 불러온다.

---

File system 모듈 (fs 모듈)

: 파일을 읽거나 저장하는 기능을 구현하도록 돕는 모듈
File System 모듈의 메소드 목록을 살펴보면, 파일을 읽을 때 쓸 법한 메소드 이름을 찾을 수 있다.

• readFile() : 파일을 읽을 때 사용할 수 있는 메소드
• writeFile() : 파일을 저장할 때 사용할 수 있는 메소드

fs.readFile()

fs.readFile(path, [options], callback) : 비동기적으로 파일 내용 읽은 후 콜백 함수를 실행하는 메소드

• 이 메소드는 세 개의 전달인자를 받는다. ➡️ path, [options], callback
• 대괄호는 선택적 전달인자를 의미하므로, 대괄호로 감싼 두 번째 전달인자 options는 넣을 수도 있고, 넣지 않을 수도 있다.

fs.readFile() 메소드 사용법 - fs.readFile 공식 API 문서

path

: 파일 이름을 전달인자로 받는다.

• string Buffer URL integer 네 종류의 타입을 전달할 수 있지만, 일반적으로 문자열 타입을 받는다.

fs.readFile('/etc/password');
// /etc/password 파일을 불러온다.

options

: 옵션을 문자열 또는 객체 형태로 받을 수 있다.

• 문자열로 전달할 경우 인코딩을 받는다.

fs.readFile('/etc/password', 'utf8');
// /etc/password 파일을 utf8을 사용해서 읽는다.

• 객체를 전달할 경우 더 구체적인 옵션을 전달할 수 있다.

let options = {
	encoding = 'utf8', // utf8 인코딩 방식으로 연다.
  	flag = 'r'         // 읽기 위해 연다.
}

fs.readFile('/etc/password', options);
// /etc/password 파일을 utf8을 사용해서 읽기 전용으로 읽는다.

callback

callback(err, data) : 파일을 읽고 난 후에 비동기적으로 실행되는 콜백 함수를 전달받는다.
이때, 이 콜백 함수에는 2가지 매개변수가 존재한다.

• err
• data (파일의 내용)

에러가 발생하지 않으면 err는 null이 되고, data에는 문자열이나 Buffer라는 객체가 전달된다.

fs.readFile('test.txt', 'utf8', (err, data) => {
  if(err) {
  	throw err; // 에러를 던진다.
  }
  console.log(data); // data를 콘솔에 출력한다.
})

Buffer 객체

버퍼 형태의 데이터를 원래의 문자로 다시 바꾸려면 toString() 메소드를 이용하면 된다.

data.toString()

예시)

• fs.readFile() 메소드를 이용해 파일의 내용을 불러오는 함수 getDataFromFile()
• 만약 에러가 발생하면, 콜백 함수의 첫 번째 인자에 err, 두 번째 인자에 null을 전달한다.
• 에러가 발생하지 않으면, 콜백 함수의 첫 번째 인자에 null, 두 번째 인자에 data을 전달한다.

const fs = require("fs")

const getDataFromFile = function(filePath, callbackFn) {
	return fs.readFile(filePath, 'utf-8', (err, data) => {
    	if(err) {
        	callback(err, null);
        } else {
        	callback(null, data);
        }
    });
};

getDataFromFile('test.txt', (err, data) => console.log(data));
// 매개변수로 err, data를 받아 콘솔 로그에 data를 출력하는 콜백 함수