Node.JS - 좀 더 나은 폴더구조 설계 방법에 대해

Question

안녕하세요! 항상 궁금한 백엔드 취업 준비생입니다. 이번에 어느 사이드 프로젝트 팀의 백엔드 PL로서 개발을 담당하게 됐는데, 이제 개발 단계에 들어서서 git에 node.js 초기설정 & 설계를 끝마치고 공유를 해야 하는 상황입니다. 이전에 사용하던 구조방식 그대로 가져와서 활용할 수 있지만, 더 좋은 방식은 어떤 게 있을까 하는 마음입니다. 물론 팀원들에게도 물어봤습니다. 그냥 별다른 의견 없이 그대로 따라가려는 느낌이네요. 제가 전공자이기는 하나, 백엔드 분야에서는 전문적으로 배운 경험이 없습니다. 그래서, 저는 최대한 주변 개발 지인분들이 알려주신 거나 다른 깃허브 프로젝트 구조들을 보고서, 설계해나갔습니다. (이런 설계 방식에 대한 분류들을 아키텍처라고 부르기도 하는 것 같은데 이 단어가 맞는 건지 모르겠습니다.) 하지만, 지금 제가 설계하는 이 구조가 올바른 것이지 정확히 모르고, 혼자 객관적인 평가를 할 수 없어, 설계한 구조에 대해 봐주셨으면 하는 간절한 마음에 질문 글을 올립니다. 사실, 다른 깃허브 글에 좋은 설계방식에 대한 정리도 많이 돼있지만, 그전에 제 설계방식에 대한 평가나 조언을 받고 싶은 마음입니다. 기본적으로 전체적인 구조는 이렇습니다. (test.html은 빼고 보시면 됩니다!)한 프로젝트 폴더 안에 앱 구동 역할을 하는 app.js를 더불어 각각 config (설정 파일), logs (로그 모음), src (각각의 개발 관련 소스들)가 있습니다.config - 환경 변수 설정값들이 존재합니다.(DB 연동 환경 변수, server의 기본 포트 & 도메인 값, ...)logs - 에러 레벨을 info, warn, error로 구분하여 30일 단위로 로그를 관리할 수 있게 했습니다.● src - 각각의 개발 관련 소스들이 들어가는 전체적인 구조입니다.routes, controllers - 주소 경로가 크게 routes 폴더부터 시작해 세부적으로 나뉘어 controllers의 기능별 폴더 route로 들어가게 설정했습니다. (이렇게 설계한 이유는 제기준 route를 기능별로 분류해놓으면 가독성이 높았기 때문입니다.)세부적으로는 이런 식으로 작동하게 됩니다.if) 주소창 /auth/login/naver 입력 - (routes/index.js -> routes/auth/route.js)functions - 각종 필요한 함수들이 있습니다.middleware - 미들웨어 함수들이 있습니다.models - sequelize(DB)의 모델들이 정의돼있습니다.passport - 로그인 관련 코드들이 있습니다.utils - DB 연결 관련 코드가 들어있습니다.이런 폴더 구조를 사용하고 있습니다. 제가 설계하는 이 방식은 어떠한 문제점이 있을까요? 또 이게 맞는 걸까요? 아직까진 프로젝트 API 요청/응답하거나 설계하면서 불편한 점을 크게 느껴본 적이 없습니다.

펭귄속 온천 · Answer

저는 첫번째로 깃 이그노어해서 형상 관리시 안보이게 할 수도 있겠지만 폴더에 용량이 많아지는게 싫어서 Log파일들은 별도로 프로젝트 밖에다가 놓을것 같습니다.또한 두번째로는주소 경로가 크게 routes 폴더부터 시작해 세부적으로 나뉘어 controllers의 기능별 폴더 route로 들어가게 설정했습니다.라고 하셨던 부분에서주소 경로와 routes폴더를 분리할것 같습니다.서로 주소로 접근할때 하나의 라우터로 들어 갈 경우도 있고폴더 경로를 접근 URL로 잡으면 레스트풀하게 설계하기 어렵지 않을까 생각합니다.저는 라우터를 아래와 같이별도의 파일로 저장해서 관리했습니다.예를들어 /main으로 Get으로 접근해 온다면 /src/routes/main의 main으로 저도 Node프로젝트을 많이 경험해 보지 못해서더 많은 것을 말씀드리지 못한 것 같아 죄송합니다^^

캐티 · Answer

이 것은 많은 경험을 해보는 수 밖에 없쩌여.가령 여러가지 시도를 해본 적이 있스빈다.MVC 방식으 Model, View, Controller 이렇게 폴더를 나눠서 하기도 했쩌.실시간 작동 로직이 있다면 Main 폴더를 추가로 사용하빈다. 이 것은 중요하빈다. Lib 폴더를 추가로 쓰기도 하는데 이건 자체 모듈을 npm 모듈 기반으로 만들지 않을 때 적절하게 사용 할 수 이쩌여.이 것 외에도 프로그램은 다양한 경우가 있을 것인데 이 것으 정답이 없어서 다양한 시도 끝에 가장 좋은 것을 쓰는 것이 좋아요.

동도인 · Answer

제가 알기론 nodejs 프로젝트는 저런 폴더 구조가 자유롭기 때문에 많이 들 쓰는걸로 알고있습니다. 폴더 구조에 맞고 틀리고는 없다고 보며 다만 추후 서비스 할때 유지보수 의 편의성을 보면 될거 같습니다. 저도 스프링에서 nodejs 로 넘어 갈려고 공부중이며 저같은 경우 스프링 폴더 구조 로 따라 만들고 있습니다.

Node.JS - 좀 더 나은 폴더구조 설계 방법에 대해

3개의 답변

Q&A 목록