8/31 TIL : File-system(JS, Promise, async/await), Routing w/o framework

KDT/TIL

8/31 TIL : File-system(JS, Promise, async/await), Routing w/o framework

ebulsok 2022. 9. 18. 18:21

🔎 File-system

node의 모듈이기 때문에 CommonJS 방식으로 불러 올 수 있음
const fs = require('fs');

🚩 파일을 읽을 때는 readFile메소드를 사용

파일을 읽는 것은 시간이 필요한 작업이기 때문에 일종의 서버 통신과 비슷함 => 따라서 기본적으로 callback을 사용
fs.readfile('파일위치', '유니코드포맷', callback(err, data) { });
err는 파일 읽기를 실패했을 때 Error 코드를 반환
data는 파일 읽기를 성공했을 때 읽은 data를 반환

const fs = require('fs');
fs.readFile('./readme.txt', 'utf-8', (err, data) => {
  if (err) console.log(err);
  else console.log(data);
});

🚩 파일을 읽을 때는 writeFile 메소드를 사용

fs.writeFile('파일위치', data, '유니코드포맷', callback(err) { } );
data가 없고, 쓰기를 실패했을 때 Error 코드를 반환
파일을 초기화한 후 덮어씌우는 개념

const fs = require('fs');
const str = '파일 쓰기를 성공하면 이 문구가 파일에 들어갑니다.';
fs.writeFile('./readme.txt', str, 'utf-8', (err) => {
  if (err) console.log(err);
  else console.log('writeFile succeed');
});

callback은 가독성 안 좋기 때문에 promise라는 개념이 나왔고 그 이후 syntatic sugar(async, await)

🚩 File-system과 비동기 프로그래밍

readFile 메소드를 동시에 비동기적으로 실행시켜보기

fs.readFile('./readme.txt', 'utf-8', function (err, data) {
  if (err) throw err;
  console.log('1번', data.toString());
});
fs.readFile('./readme.txt', 'utf-8', function (err, data) {
  if (err) throw err;
  console.log('2번', data.toString());
});
fs.readFile('./readme.txt', 'utf-8', function (err, data) {
  if (err) throw err;
  console.log('3번', data.toString());
});
fs.readFile('./readme.txt', 'utf-8', function (err, data) {
  if (err) throw err;
  console.log('4번', data.toString());
});

callback 방식은 사용 및 코드 가독성이 떨어지기 때문에 fs는 promise 방식 기능을 제공
기존의 메소드 명 뒤에 Sync를 붙이면 promise 방식을 사용하여 동기적으로 작동
서버 상에서 작동할 때는 정상적으로 작동하지 않는 경우가 빈번함

let data = fs.readFileSync('./readme.txt');
console.log('1번', data.toString());
data = fs.readFileSync('./readme.txt');
console.log('2번', data.toString());
data = fs.readFileSync('./readme.txt');
console.log('3번', data.toString());
data = fs.readFileSync('./readme.txt');
console.log('4번', data.toString());

따라서 서버 상에서 fs를 쓸 때는 Promise를 써야 함
Promise적으로 작동하는 fs.promises를 호출하여 사용
fs.promises는 스스로 성공 여부를 판단하여 resolve, reject를 반환함

🚩 Promise

일종의 클래스, 따라서 new로 사용
const promise = new Promise(function(resolve, reject) { });
resolve, reject라는 2개의 매개변수를 callback 함수로 받아서 사용, 데이터를 매개변수로 보낼 수 있음
promise가 할당되면 resolve/reject가 callback 될 때까지 무한 대기(pending 상태)
resolve는 then으로, reject는 catch로 받음

const promise = new Promise((resolve, reject) => {
  const name = 'bulsok';
  if (name === 'bulsok') {
    setTimeout(() => {
      resolve('My name is bulsok');
    }, 3000);
  } else {
    reject('My name is not bulsok');
  }
});
promise
  .then((data) => {
    console.log(data);
  })
  .catch((err) => {
    console.log(err);
  });

const fs = require('fs').promises;
fs.readFile('./readme.txt', 'utf-8')
  .then((data) => {
    console.log('1번', data.toString());
    return fs.readFile('./readme.txt', 'utf-8');
  })
  .then((data) => {
    console.log('2번', data.toString());
    return fs.readFile('./readme.txt', 'utf-8');
  })
  .then((data) => {
    console.log('3번', data.toString());
    return fs.readFile('./readme.txt', 'utf-8');
  })
  .then((data) => {
    console.log('4번', data.toString());
  })
  .catch((err) => {
    throw err;
  });

function 앞에 async를 붙이면 항상 Promise를 반환, await 키워드 사용 가능
await는 promise가 결과(resolve, reject)를 가져다 줄 때까지 기다림
함수를 선언만 하고 실행하지 않는 경우를 주의할 것

const fs = require('fs').promises;
async function main() {
  let data = await fs.readFile('./readme.txt', 'utf-8');
  console.log('1번', data);
  data = await fs.readFile('./readme.txt', 'utf-8');
  console.log('2번', data);
  data = await fs.readFile('./readme.txt', 'utf-8');
  console.log('3번', data);
  data = await fs.readFile('./readme.txt', 'utf-8');
  console.log('4번', data);
}
main();

🔎 Routing: 네트워크 상에서 데이터를 보낼 때 최적의 경로를 선택하는 과정

route.js

// @ts-check
const fs = require('fs').promises;

async function getPosts() {
  const jsonPosts = await fs.readFile('database.json', 'utf-8');
  return JSON.parse(jsonPosts).posts;
}

async function savePosts(posts) {
  const content = {
    posts,
  };
  return fs.writeFile('database.json', JSON.stringify(content), 'utf-8');
}

const routes = [
  // 블로그 목록을 가져오는 API
  {
    url: '/posts',
    id: 'undefined',
    method: 'GET',
    callback: async () => {
      const posts = await getPosts();

      return {
        statusCode: 200,
        body: {
          posts,
          totalCount: posts.length,
        },
      };
    },
  },

  // 특정 ID의 블로그 글을 가져오는 API
  {
    url: '/posts',
    id: 'number',
    method: 'GET',
    callback: async (id) => {
      const posts = await getPosts();

      if (!id) {
        return {
          statusCode: 404,
          body: 'NOT FOUND',
        };
      }

      const result = posts.find((post) => post.id === id);
      if (!result) {
        return {
          statusCode: 404,
          body: 'ID NOT FOUND',
        };
      }

      return {
        statusCode: 200,
        body: result,
      };
    },
  },

  // 새로운 글을 올리는 API
  {
    url: '/posts',
    id: 'undefined',
    method: 'POST',
    callback: async (id, newPost) => {
      const posts = await getPosts();

      posts.push({
        id: posts[posts.length - 1].id + 1,
        title: newPost.title,
        content: newPost.content,
      });

      savePosts(posts);

      return {
        statusCode: 200,
        body: '새로운 글이 등록되었습니다.',
      };
    },
  },

  // 특정 ID의 글을 수정하는 API
  {
    url: '/posts',
    id: 'number',
    method: 'PUT',
    callback: async (id, modiPost) => {
      const posts = await getPosts();

      if (!id) {
        return {
          statusCode: 404,
          body: 'NOT FOUND',
        };
      }

      const result = posts.find((post) => post.id === id);
      if (!result) {
        return {
          statusCode: 404,
          body: 'ID NOT FOUND',
        };
      }

      posts[id - 1].title = modiPost.title;
      posts[id - 1].content = modiPost.content;

      savePosts(posts);

      return {
        statusCode: 200,
        body: '글이 수정되었습니다.',
      };
    },
  },

  // 특정 ID의 글을 삭제하는 API
  {
    url: '/posts',
    id: 'number',
    method: 'DELETE',
    callback: async (id) => {
      const posts = await getPosts();

      if (!id) {
        return {
          statusCode: 404,
          body: 'NOT FOUND',
        };
      }

      const result = posts.find((post) => post.id === id);
      if (!result) {
        return {
          statusCode: 404,
          body: 'ID NOT FOUND',
        };
      }

      posts.splice(id - 1, 1);
      savePosts(posts);

      return {
        statusCode: 200,
        body: '글이 삭제되었습니다.',
      };
    },
  },
];

module.exports = {
  routes,
};

main.js

// @ts-check
const http = require('http');
const { routes } = require('./route.js');

// 서버 정의
const server = http.createServer((req, res) => {
  res.setHeader('Content-Type', 'application/json; charset=utf-8');

  const urlArr = req.url ? req.url.split('/') : [];
  let id;
  if (urlArr.length > 2) id = parseInt(urlArr[2], 10);
  else id = undefined;

  async function main() {
    const route = routes.find(
      (_route) =>
        req.url &&
        req.method &&
        '/' + urlArr[1] === _route.url &&
        // req.url.search(_route.url) !== -1 &&
        _route.method === req.method &&
        typeof id === _route.id
    );

    if (!route) {
      console.log('해당 API를 찾을 수 없습니다.');
      res.statusCode = 404;
      res.end('NOT FOUND');
    } else {
      let newPost;
      if (req.method === 'POST' || req.method === 'PUT') {
        newPost = await new Promise((resolve, reject) => {
          req.setEncoding('utf-8');
          req.on('data', (data) => {
            if (data !== undefined) {
              resolve(JSON.parse(data));
            } else {
              reject();
            }
          });
        });
      }

      const result = await route.callback(id, newPost);

      console.log(result.body);
      res.statusCode = result.statusCode;
      res.end(JSON.stringify(result.body));
    }
  }

  main();
});

// 서버 실행
const PORT = 4000;
server.listen(PORT, () => {
  console.log(`해당 서버는 ${PORT}번 포트에서 작동 중입니다.`); // 서버 콘솔
});

database.json

{"posts":[{"content":"hello, back-end","id":1,"title":"first"},{"content":"hello, back-end","id":2,"title":"second"},{"content":"hello, back-end","id":3,"title":"third"}]}

저작자표시 비영리 변경금지