[TIL] Day25 #Node.js #fs module

[TIL] Day25
[SEB FE] Day25

☑️ Node.js

비동기 이벤트 기반 JS 런타임

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

• fs.readFile: 로컬에 존재하는 파일의 내용 전체를 비동기적으로 읽어옴
  • 전달인자 3개를 받음 (path[, options], callback)
    • path: 파일 이름 (4가지 타입 가능 - <string> | <Buffer> | <URL> | <integer>

      fs.readFile('/etc/passwd', ..., ...)

    • options: 넣을 수도, 넣지 않을 수도 있음 (문자열 | 객체 형태 가능)
      • 문자열로 전달할 경우 인코딩을 받음

        let options ={
        	encoding: 'utf-8',  // utf-8 인코딩 방식으로
        	flag: 'r' // 읽기
        }
        
        fs.readFile('/etc/passwd', options, ...)

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

        • err: 에러가 발생하지 않으면 err = null

        • data: 파일 내용 (문자열 | Buffer 객체가 전달)

          fs.readFile('test.txt', 'utf8', (err, data) => {
          	if (err) {
          		throw err;
          	}
          	console.log(data);
          });

• fs.writeFile: 파일 저장할 때

  const fs = require('fs');  // file system module(fs) 불러오기

• 3rd-party module(서드 파티 모듈): 해당 프로그래밍 언어에서 공식적으로 제공하는 built-in 모듈이 아닌 모든 외부 모듈

  // 3rd-party module download
  npm install underscore
  
  // 모듈 사용
  const _ = require('underscore');

---

☑️ [Pair] Timer API

callback, Promise, async/await 구현 방법을 이해하는 페어 활동

➰ new Promise()를 통해 생성한 Promise 인스턴스에 존재하는 메서드

• .then(): 프로미스 이행시 콜백 반환
• .catch(): 프로미스 거부시 콜백 반환
• .finally(): 프로미스의 이행/거부 여부에 상관없이 처리될 경우 항상 호출

➰ 프로미스 3가지 상태

1. Pending(대기): 이행하지도, 거부하지도 않은 초기 상태

   new Promise();

2. Fulfilled(이행): 연산이 성공적으로 완료된 상태

   new Promise(function(resolve, reject) {
   	resolve();
   });

3. Rejected(거부): 연산이 실패한 상태

   new Promise(function(resolve, reject) {
   	reject();
   });

➰ await 키워드 다음에 등장하는 함수 실행은 Promise 타입을 리턴한 경우에만 의미가 있음

---

☑️ [Pair] fs module

callback, Promise, async/await를 활용하여 fs module을 사용해보는 페어 활동

1. fs module을 callback을 통해 파일 정보 읽어오기

   // fs module 불어오기
   const fs = require('fs');
   
   const getDataFromFile = function (filePath, callback) {
   	// 'utf8' encoding 하지 않으면 한글 깨짐 현상 발생
     fs.readFile(filePath, "utf8", (err, data) => {
       if (err) {  // 에러난 경우
         callback(err, null); // 에러 불러옴
       } else {    // 에러나지 않은 일반적인 경우
         callback(null, data);  // 파일 정보 읽어오기
       }
     });
   };
   
   module.exports = {
     getDataFromFile,
   };

2. fs module을 Promise을 통해 파일 정보 읽어오기

   const fs = require("fs");
   
   const getDataFromFilePromise = (filePath) => {
     return new Promise((resolve, reject) => {
       fs.readFile(filePath, "utf8", (err, data) => {
         if (err) {
           reject(err);
         } else {  // 에러가 나지 않은 경우 resolve 메소드 실행 -> 파일 정보 읽어옴
           resolve(data);
         }
       });
     });
   };

3. 2개의 json 파일을 불러온 후, 합쳐서 두 객체가 담긴 배열 출력

   const path = require("path");
   const { getDataFromFilePromise } = require("./02_promiseConstructor");
   
   const user1Path = path.join(__dirname, "files/user1.json");
   const user2Path = path.join(__dirname, "files/user2.json");
   
   const readAllUsersChaining = () => {
     let result = [];  // 빈 배열 선언
   
     return getDataFromFilePromise(user1Path)  // 첫번째 파일 정보 가져와서
       .then((data) => {
         let data1 = JSON.parse(data);  // json 형태로 변환
         result.push(data1);  // 빈 배별에 첫번째 파일 객체 넣어줌
         return getDataFromFilePromise(user2Path);  // 두번째 파일 정보 가져와서
       })
       .then((data) => {
         let data2 = JSON.parse(data);  // json 형태로 변환
         result.push(data2);  // 첫번째 파일 객체가 들어간 배열에 두번째 파일 객체 넣어줌
         return result;  // 첫번째, 두번째 파일 객체가 들어간 배열 반환
       });
   };
   
   // JSON.parse() 전의 파일 정보에는 key&value 모두 문자열 형태로 저장되어 있음
   // JSON.parse() 후의 파일 객체엔 key를 감싸고 있는 ""이 제거된 형태로 변환해줌

4. Promise.all() 메서드를 사용하여 3번째 출력 결과와 같도록 구현

   const readAllUsers = () => {
     return Promise.all([ // 전달인자를 배열 형태로 받음
       getDataFromFilePromise(user1Path),
       getDataFromFilePromise(user2Path),
     ]).then((data) => data.map((el) => JSON.parse(el)));
   };

   ➰ Promise.all()

   • 주어진 모든 프로미스를 이행하거나, 한 프로미스가 거부될 때까지 대기하는 새로운 프로미스를 반환
   • 동시에 2개 이상의 Promise 요청을 한꺼번에 실행하는 함수
   • Promise.all의 전달인자는 배열 형태
   • Promise.all의 전달인자에 배열이 전달된다면, 요소 순서는 Promise.all의 Promise 순서와 상응
   • Promise.all에 전달되는 Promise는 하나라도 거부되는 순간 모든 요청이 거부됨
     👉 모든 Promise 요청이 거부되면서 .catch를 따라감.

5. async/await 사용하여 위와 같은 출력 결과가 나오도록 구현

   const readAllUsersAsyncAwait = async () => {
     let result = [];
     let user1 = await getDataFromFilePromise(user1Path);
     let user2 = await getDataFromFilePromise(user2Path);
     let data1 = JSON.parse(user1);
     let data2 = JSON.parse(user2);
     result.push(data1, data2);
     return result;
   };