NestJS Request Lifecycle (1) - Middleware

이전 글

• 2022.12.22 - [Backend/NestJS] - NestJS Request Lifecycle (0) - 개요

---

미들웨어 ( in NestJS )

미들웨어란 NestJS 요청 생명주기에서 클라이언트로부터 들어오는 request가 가장 먼저 처리되는 핸들러이다. 

Node.js의 Express를 다뤄보았다면 이미 익숙한 개념인데, Express 미들웨어에서는 request, response 객체와 더불어 다음 미들웨어나 라우터를 호출하는 next() 함수를 다룰 수 있다.

app.use((req,res,next)=>{
  console.log('Request is received...')
  next() // 스택 상의 다음 미들웨어로 req,res 전달
})

 

미들웨어 작성

NestJS도 기본적으로 Express를 래핑한 프레임워크이기 때문에 위와 동일한 방식으로 작동한다. 

미들웨어를 작성하는 것 또한 위와 동일하게 작성할 수 있으며(함수 미들웨어), 의존성이 필요하거나 다른 모듈에 주입되어야 하는 경우에는 다음과 같이 @Injectable() 데코레이터를 이용한 클래스의 use 메서드의 형태로 작성이 된다.(클래스 미들웨어)

import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  use(req:Request, res:Reponse, next:NextFunction){
    console.log('Request is received...');
    next();
  }
}

이 때문에 함수 미들웨어는 의존성이 필요 없는 간단한 동작일 때 주로 사용하며, 또 사용이 추천된다. 

 

미들웨어 적용

NestJS에서는 미들웨어를 적용하는 방법이 크게 2가지가 존재한다.

1. 전역 범위 미들웨어

해당 방식은 요청이 NestJS 서버에 들어왔을 때 가장 먼저 거치는 생명주기를 생성할 수 있다. 방법은 단순한데, 미들웨어 함수를 만든 뒤 NestJS의 보일러플레이트 시작점(bootstrap() 함수)에 Express에서 사용하는 방식과 동일하게 사용해주면 된다.

// logger.middleware.ts
import { Request, Response, NextFunction } from 'express';

export const logger = (req:Request, res:Response, next:NextFunction) => {
  console.log('Request is received...');
  next();
};

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { logger } from './logger.middleware';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.use(logger);
  await app.listen(3000);
}
bootstrap();

전역 범위 미들웨어는 앞서 언급한대로 요청 생명주기에서 가장 전면에 위치하게 되며, 전역 범위 미들웨어 간 순서는 먼저 먼저 호출된 순서이다. 

이 때 해당 방식으로 이용되는 미들웨어는 의존성 주입이 불가능하다. 따라서 함수 미들웨어가 주로 이용된다. 만약 의존성이 필요한 미들웨어의 전역 설정이 필요하다면, 아래의 모듈 범위 미들웨어를 이용한 전역 설정을 고려해야한다.

2. 모듈 범위 미들웨어

해당 방식은 위의 전역 범위 미들웨어를 거친 뒤 실행되는 미들웨어들을 등록할 수 있다. 모듈 범위 미들웨어들은 최상위 모듈에 바인딩된 미들웨어부터 작동하며, 그 이후에는 imports 배열에 추가되어있는 순서대로 각 모듈의 미들웨어들이 작동한다. 

모듈 범위의 미들웨어는 다음과 같이 등록해준다.

import { Module, NestModule, MiddlewareConsumer, RequestMethod } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { LoggerMiddleware } from './logger.middleware';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule implements NestModule {
  configure(consumer:MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .exclude( // 미들웨어 적용을 제외할 경로, 없다면 exclude 메서드 생략 가능
        {path: 'test2', method: RequestMethod.ALL,},
      )
      .forRoutes( // 미들웨어를 적용할 경로
        {path: 'test', method: RequestMethod.GET,},
      );
  }
}

모듈 범위의 미들웨어에서 와일드카드 문자를 이용하면 전역 미들웨어처럼 작동하도록 설정할 수도 있다.

import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { LoggerMiddleware } from './logger.middleware';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule implements NestModule {
  configure(consumer:MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes('*'); // 모든 경로, 모든 메서드에 대해 미들웨어 적용
  }
}

이를 통해 의존성이 필요한 미들웨어도 전역으로 설정할 수 있다.

 

미들웨어 vs 인터셉터

미들웨어에 대해 정리를 하다보니 이후에 다룰 'NestJS의 인터셉터와 무슨 차이가 있지?' 라는 생각이 들었다.

이에 대해 좀 찾아보니, 스택오버플로우의 다음의 글을 찾을 수 있었다.

https://stackoverflow.com/questions/54863655/whats-the-difference-between-interceptor-vs-middleware-vs-filter-in-nest-js

What's the difference between Interceptor vs Middleware vs Filter in Nest.js?

요약하자면,

1. 인터셉터는 컨트롤러의 전후로 요청, 응답을 조작할 수 있다.
2. 미들웨어는 컨트롤러의 전에만 나타나기 때문에 요청, 응답의 조작이 가능하지만 컨트롤러에서 반환된 응답에 대해서는 조작할 수 없다.

정도가 되는 것 같다.