[Node.js] NestJS 구조 이해하기

NestJS는 간단하게 이 세가지를 기억하면 된다.

 

Controller → 요청 받기
Service → 로직 처리
Module → Controller + Service 관리

 

이 세가지를 기억하면서 프로젝트를 생성부터 해보겠다.

1. NestJS 프로젝트 생성  🎈

NestJS는 CLI를 사용하면 프로젝트를 쉽게 생성할 수 있다.

npm i -g @nestjs/cli

nest new my-project

 

프로젝트를 생성하면 기본적으로 다음과 비슷한 구조가 만들어진다.

my-project/
├── src/                  # 실제 애플리케이션 코드
│   ├── app.controller.ts # 요청(URL)을 받아서 응답
│   ├── app.service.ts    # 실제 비즈니스 로직
│   ├── app.module.ts     # Controller, Service 등을 묶어서 관리
│   └── main.ts           # 서버 실행 시작점
├── test/                 # 테스트 코드
├── package.json          # 설치된 패키지와 실행 명령어 관리
└── tsconfig.json         # TypeScript 설정

 

처음 보면 파일이 여러 개라서 Express보다 복잡해 보일 수 있다.

하지만 각각의 역할을 나눠서 보면 이해하기 쉽다.

main.ts
- 애플리케이션 시작
AppModule
- 애플리케이션의 전체 구성
Controller
- HTTP 요청을 받음
Service
- 실제 비즈니스 로직을 처리

 

 

2. Controller란? 🕹️

NestJS에서 Controller는 클라이언트의 HTTP 요청을 받는 역할을 한다.

예를 들어 다음과 같은 API를 만든다고 해보자.

GET /users

 

NestJS에서는 다음과 같이 작성할 수 있다.

import { Controller, Get } from '@nestjs/common';

@Controller('users')
export class UserController {

    @Get()
    getUsers() {
        return [
            {
                id: 1,
                name: '홍길동'
            }
        ];
    }
}

 

이 코드를 하나씩 살펴보겠다.

@Controller('users')

 

@Controller가 /users 경로를 담당한다는 의미다.

@Get()

 

@Get()은 HTTP GET 요청을 처리한다는 의미이다.

따라서 get요청이 들어오면,

GET /users

 

getUsers() 메서드가 실행된다.

 

같은 기능을 Express로 작성하면 다음과 같다.

Express

app.get('/users', (req, res) => {
    res.json([
        {
            id: 1,
            name: '홍길동'
        }
    ]);
});

NestJS

@Controller('users')
export class UserController {

    @Get()
    getUsers() {
        return [
            {
                id: 1,
                name: '홍길동'
            }
        ];
    }
}

 

둘 다 결국 같은 역할을 한다.

GET /users
      ↓
사용자 목록 반환

 

차이점은 NestJS에서는 Decorator를 이용해서 라우팅과 Controller의 역할을 구조적으로 표현한다는 것이다.

 

여기서 Decorator를 간단하게 설명하자면 클래스, 메서드, 변수 등에 특별한 기능이나 정보를 붙여주는 문법이다.

@Controller('users')
export class UserController {

    @Get()
    getUsers() {
        return [
            {
                id: 1,
                name: '홍길동'
            }
        ];
    }
}

 

 

위의 코드로 예시를 들었을때

 

@Controller('users') : 이 클래스가 Controller임을 지정

@Get() : 이 메서드가 GET 요청을 처리하도록 지정

 

즉, @로 시작하는 것이 Decorator이고,
NestJS에게 "이 코드가 어떤 역할을 하는지" 알려주는 역할이라고 생각하면 된다.

 

3. Service란?

Nest.js를 사용하는 실제 프로젝트에서는 Controller가 너무 많은 일을 담당하지 않도록 하는 것이 좋다.

예를 들어 사용자 목록을 DB에서 가져오는 기능이 있다고 가정하겠다..

Controller
    ↓
DB 조회
    ↓
데이터 가공
    ↓
응답

위처럼 Controller가 DB조회를 하고, 그 데이터를 가공하고, 가공한 데이터를 다시 또 응답을 하는

모든 일을 담당하게 되면 코드는 점점 복잡해진다.

그래서 NestJS에서는 이런 비즈니스 로직을 Service로 분리한다.

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {

    getUsers() {
        return [
            {
                id: 1,
                name: '홍길동'
            }
        ];
    }
}

 

그리고 Controller에서는 Service를 사용한다.

import { Controller, Get } from '@nestjs/common';
import { UserService } from './user.service';

@Controller('users')
export class UserController {

    constructor(
        private readonly userService: UserService,
    ) {}

    @Get()
    getUsers() {
        return this.userService.getUsers();
    }
}

 

이렇게 하면 역할이 분리된다.

Controller
→ HTTP 요청을 받는다.

Service
→ 실제 비즈니스 로직을 처리한다.

 

이러한 구조는 프로젝트가 커질수록 큰 장점이 된다.

 

 

그리고

 

위 코드에서 처음 NestJS를 접하면 다음 부분이 조금 낯설 수 있다.

constructor(
    private readonly userService: UserService,
) {}

 

개발자가 직접 다음과 같이 객체를 생성하지 않았다.

const userService = new UserService();

 

이것이 NestJS의 중요한 개념 중 하나인 Dependency Injection(DI)​이다.

NestJS가 필요한 객체를 관리하고 Controller에 주입해준다.

쉽게 말하면,

Controller
    ↓
"UserService가 필요해"
    ↓
NestJS
    ↓
UserService를 만들어서 전달

 

개발자가 객체 생성과 의존성 관리를 직접 하지 않아도 되는 아주 큰 장점이 있다.

 

4. Module이란?

Module은 쉽게 말해서 관련된 기능을 하나의 단위로 묶어 관리하는 역할을 한다.

User
├── UserController
├── UserService
└── UserModule

 

예를 들어 사용자 기능이 있다면 위처럼 구성할 수 있다.

import { Module } from '@nestjs/common';
import { UserController } from './user.controller';
import { UserService } from './user.service';

@Module({
    controllers: [UserController],
    providers: [UserService],
})
export class UserModule {}

 

그리고 전체 애플리케이션에서는 이 Module을 가져온다.

AppModule
│
├── UserModule
├── AuthModule
├── DocumentModule
└── ...

 

프로젝트가 커질수록 기능별로 Module을 나눌 수 있기 때문에 코드의 책임을 분리하기 쉽다.

 

5. NestJS의 전체적인 구조

지금까지 설명한 내용을 하나로 연결하면 다음과 같다.

Client
   │
   │ HTTP Request
   ▼
Controller
   │
   │ 요청 처리
   ▼
Service
   │
   │ 비즈니스 로직
   ▼
Repository / Model
   │
   ▼
Database

 

그리고 이러한 기능들을 Module이 묶어준다.

AppModule
│
├── AuthModule
│   ├── AuthController
│   └── AuthService
│
├── UserModule
│   ├── UserController
│   └── UserService
│
└── DocumentModule
    ├── DocumentController
    └── DocumentService

 

이 구조를 이해하면 NestJS의 기본적인 형태는 대부분 이해했다고 볼 수 있다.