Node.js 모노레포 튜토리얼 (with 객체지향 프로그래밍)

안녕하세요, 김명재입니다.

저는 우아한형제들의 웹툰 플랫폼 만화경을 개발하는 3년 6개월동안 자바와 코틀린으로 백엔드 애플리케이션을 만들었습니다. 그중 2년은 Next.js와 Material-UI로 웹 프론트엔드 개발도 함께 했었습니다. 만화경 백엔드는 프로젝트 시작부터 마이크로서비스 형태를 갖추고 있었고, JVM(Java Virtual Machine) 진영의 빌드 툴인 gradle을 사용해서 멀티모듈(≒모노레포)을 구성해 여러 개의 백엔드 서비스를 하나의 저장소에서 관리했습니다.

서비스가 성장하면서 만화경 백오피스 웹 프론트엔드 애플리케이션의 코드량도 많아지고, UI는 비슷하지만 다른 종류의 백오피스 웹 프론트엔드 애플리케이션이 필요하게 되었습니다. 코드를 재사용하기 위해 npm으로 관리하던 백오피스 웹 프론트엔드 저장소도 백엔드 저장소와 유사하게 모노레포를 도입했습니다.

모노레포 도입 시기에 Lerna(러나)와 Rush(러쉬)를 두고 고민했었습니다. Lerna는 사용법이 간단하고 학습량이 적은 대신 사용자가 스크립트를 작성해서 해결해야 하는 부분이 있었던 반면, Rush는 기능이 많고 문서도 많고 학습량도 많지만 초반의 러닝 커브만 잘 뛰어넘는다면 Lerna보다 훨씬 편하게 사용할 수 있어보였습니다.

그러나 Rush의 국내 인지도는 Lerna보다 낮았고 사용 사례도 거의 없었으며, npm trends상에서도 워낙 Lerna가 독보적이라 회사 프로젝트에서는 보수적인 관점에서 Lerna를 선택해서 사용했습니다. 2019년엔 정말 차이가 많이(20배 차이) 났었는데 요새는 Rush도 많이 올라왔습니다(3배 차이).

마침 최근에 새로운 환경에서 모노레포를 구성해야 할 필요가 있어서 지난번에 도전하지 않았던 Rush를 공부해서 예제 프로젝트를 구성해보았고, Lerna보다 만족스러운 부분이 많아서 매우 만족하고 있습니다.

2021년 8월에 정성대님이 작성한 ‘Rush로 프론트엔드 모노레포 도입기’에 ‘Lerna + Yarn workspace는 어플리케이션 개발보다는 오픈소스에 더 유용하다’고 말씀하신 부분이 있습니다. 저도 여기에 동감하는 바이고, Rush는 마이크로소프트 Share Point 팀에서 수백 개의 NPM 패키지를 관리하면서(Rush was created by the platform team for Microsoft SharePoint. We build hundreds of production NPM packages every day, https://rushjs.io/pages/intro/welcome/) 탄생한 도구이기 때문에 예제 프로젝트를 만들어보면서 충분히 학습한다면 실제 업무 환경에 도입하기에는 문제 없어 보입니다.

‘Node.js 객체지향 모노레포 튜토리얼’에서는 ‘읽기, 쓰기만 가능한 게시판’이라는 간단한 도메인가진 명령줄 인터페이스(Command Line Interface, CLI) 애플리케이션을 만들게 됩니다. 객체지향의 원칙을들을 지키며 클래스 기반으로 애플리케이션을 구성하고, 객체지향 프로그래밍을 하다보면 자연스럽게 만나게 되는 클래스간의 의존성 관리 문제를 제어의 역전 컨테이너인 InversifyJS로 해결합니다. 그리고 더 큰 규모로 애플리케이션을 확장하기 위해 Rush와 Heft를 사용해서 모노레포 환경을 구성합니다.

모노레포 이야기를 많이 말씀드렸지만, 튜토리얼에는 모노레포 뿐만 아니라 지난 3년 6개월동안 일하면서 공부하고 경험해서 얻은 지식들도 많이 적어놨습니다. 커리어의 시작이 JVM을 사용하는 백엔드 개발자라 객체지향 프로그래밍을 공부하게 되면 자연스럽게 만나는 지식들이 대부분이지만, ‘읽기, 쓰기만 가능한 게시판’이라는 도메인을 중심에 두고 하나의 흐름을 유지해가며 지식들을 정리했다는 것에 저는 의미를 두고 있습니다.

이 지식들은 Next.js와 Material-UI로 프론트엔드 애플리케이션을 만들면서도 잘 써먹었습니다. JVM이든 Node.js든 결국 ‘비즈니스 요구사항에 빠르게 대응할 수 있는 유연한 프로그램’이라는 이상향을 추구한다면 비슷한 아키텍처를 가질 수 밖에 없겠다고 생각하는 편이고, 로버트 마틴도 그의 책 『클린 아키텍처』에서 같은 이야기를 합니다.

모노레포 구성을 고민하고 계실 정도면 이미 어느정도 프로그래밍을 잘 하실 테니 기초적인 내용은 적지 않았습니다. 객체지향 프로그래밍을 이해하고 타입스크립트를 사용하실 수 있다면 튜토리얼을 무리없이 이해하실 수 있을 거라고 생각합니다.

도움이 됐으면 좋겠습니다. 감사합니다.

다루는 주제와 기술

• 객체의 책임과 역할
• 의존성 관리
• 도메인이란?
• 제어의 역전
• 의존성 주입
• CQRS
• 환형 의존(Circular Dependency) 피하기
• TypeScript
• InversifyJS
• Jest
• ESLint와 Prettier
• Rush와 Heft

Prerequisite

• 객체지향 프로그래밍 패러다임에 대한 이해
• 타입스크립트

Repository

• https://github.com/myeongjae-kim/nodejs-tutorial
• 질문은 이슈로 올려주시면 좋습니다.
• 작동하는 코드: https://github.com/myeongjae-kim/nodejs-tutorial-example

참고자료

• 로버트 C. 마틴, 송준의. 클린 아키텍처. 서울: 인사이트, 2019
• 조영호. 오브젝트. 파주: 위키북스, 2019
• 앨리스테어 코어번, 육각형 아키텍처, 2005
• 톰 홈버그, 박소은. 만들면서 배우는 클린 아키텍처. 파주: 위키북스, 2021
• 멀티모듈 설계 이야기 with Spring, Gradle - 권용근 | 우아한형제들 기술블로그
• jest.mock 보다 ts-mockito 사용하기 (feat. Node.js) - 기억보단 기록을
• Konuklar, Tugce. “Hexagonal (Ports & Adapters) Architecture”. Idealo Tech Blog (blog), 2021년 4월 20일.
• Nilsson, Martin, and Nazife Korkmaz. “Practitioners’ View on Command Query Responsibility Segregation”, 2014.
• (기록) 한 개의 메소드만 갖는 계층형 컨트롤러/서비스 패키지 스타일 - 기계인간 John Grib
• Cahill, Michael J., Uwe Röhm and Alan D. Fekete. “Serializable isolation for snapshot databases”. ACM Transactions on Database Systems 34, 호 4 (2009년 12월 14일): 20:1-20:42.
• “Serializable Transactions | CockroachDB Docs”. 2022년 3월 18일에 접근함.
• Martin Fowler, “P of EAA: Data Transfer Object”. 2022년 3월 19일에 접근함.
• Martin Fowler, “Inversion of Control Containers and the Dependency Injection pattern”. 2022년 3월 19일에 접근함.
• 카일 심슨, 이일웅. You Don’t Know JS: this와 객체 프로토타입, 비동기와 성능. 서울: 한빛미디어, 2017.
• 창시자 앨런 케이가 말하는, 객체 지향 프로그래밍의 본질
• DTO 대신 Data Carrier - 이일민(토비)
• 현실 세상의 TDD - 이규원
• 에릭 에반스, 이대엽. 도메인 주도 설계. 파주: 위키북스, 2011
• ‘Rush로 프론트엔드 모노레포 도입기’ - 정성대 | 밀당 팀블로그
• Phantom dependencies | Rush
• Should you Pin your JavaScript Dependencies? | Renovate Docs

License

Jekyll

This work is open sourced under the Apache License, Version 2.0.

Copyright 2022 Myeongjae Kim.

콘텐츠