Layered Pattern

Layered Pattern이란 🙀

백엔드 API를 구현할때 널리 쓰이는 패턴중 레이어드 아키텍처(Layered achitecture) 패턴이 있다. 레이어드 아키텍쳐로 API를 구현할때는 역할에 따라 독립된 모듈로 나누어서 코드를 구현한다.

Route, Controller, Service, Model 각각의 레이어가 하나의 폴더이자 역할을 의미한다.

1. 큰 박스에서 작은 박스로 갈 수록 더 데이터를 다루는 로직(데이터베이스 접근하는 로직)에 근접하게 된다.
2. 또한, 각각의 레이어는 오로지 바로 아래에 있는 레이어에만 의존하게 된다.
   • Route → Controller
   • Controller → Service
   • Service → Model

예를들어, Route 는 Service 로직을 전혀 모르고 아예 관여 조차 하지 않는다. 따라서, Service 로직을 변경해도 Route 와 Controller 의 코드는 바뀔 필요가 없다.

즉 다음과 같은 상황에서 유연하게 대처할 수 있다는 의미이다.

때때로, 서비스를 구현하다가 RDBMS(관계형 데이터 베이스) → NoSQL(ex. mongoDB) 로 이전하는 경우가 있는데, Route와 Controller 의 로직은 전혀 바뀌지 않은채로 데이터를 다루는 Service 와 Model 의 로직만 변경 해 주면 된다.

실습

model

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

const productDetail = async productId => {
  const detail = await prisma.$queryRaw`
    SELECT
      products.id,
      eng_name,
      price,
      is_new,
      is_main,
      quantity,
      sale_rate,
      categories.name as cate_name,
      subcategories.name as subcate_name,
      url,
      images.id as image_id
    FROM
      products
    JOIN
      categories on category_id = categories.id
    JOIN
      images on products.id = images.product_id
    JOIN
      subcategories on subcategories.id = subcategory_id
    WHERE
      products.id = ${productId};
  `;

  return detail;
};

export default { productDetail };

service

import { productDetailDao } from '../models';

const productDetail = async productId => {
  const detail = await productDetailDao.productDetail(productId);

  const tmp = detail[0];

  tmp.url = detail.map((e, i) => {
    return { id: detail[i]['image_id'], image: detail[i].url };
  });

  return detail[0];
};

export default { productDetail };

controller

import { productDetailServices } from '../services';

const productDetail = async (req, res) => {
  try {
    const { productId } = req.params;

    const detail = await productDetailServices.productDetail(productId);

    res.status(200).send(detail);
  } catch (err) {
    console.log(err);
    res.status(500).send(err);
  }
};

export default { productDetail };

처음에는 이런 모듈화를 왜하는지 이해가 되지않았는데

협업을 하는과정에서 이 과정이 왜 필요한가를 아주 깊이 깨달았다.

만약 모듈화를 하지않았다면 팀원들이 작성한 코드를 분석하는데 있어서 상당한 시간이 걸렸을것이다.

다행히 layered pattern을 사용하니 팀원들이 무엇을 생각하며 코드를 짜고

어떤 API를 만들었는지 한눈에 알수있었고

수정 또한 어느부분을 수정해야하는지 바로 알수있었다.