NestJs middleware

예제 코드는 github에 있습니다:)

Goal

• NestJs의 미들웨어에 대해 알아보기

• 미들웨어를 만들어보고 적용해보기

middleware란?

웹 개발에서 일반적으로 미들웨어라 함은 route handler가 클라이언트 요청을 처리하기 전에 수행되는 컴포넌트를 말한다.

route handler는 웹 프레임워크에서 사용자의 요청을 처리하는 엔드포인트에서 동작을 수행하는 컴포넌트를 말한다.

NestJs에서 미들웨어의 기능은 요청 및 응답 객체애 대한 액세스 권한을 가질 수 있으며 next()라는 함수를 인자로 받아 route handler를 실행시킬 수도 있습니다.

NestJs의 미들웨어는 기본적으로 익스프레스 미들웨어와 동일하다. 익스프레스 공식 문서에 다음과 같은 동작을 수행할 수 있다고 적혀 있다.

• 어떤 형태의 코드라도 수행할 수 있다.

• 요청과 응답에 변형을 가할 수 있다.

• 요청-응답 주기를 끝낼 수 있다.

• 여려 개의 미들웨어를 사용한다면 next()로 호출 스택상 다음 미들웨어에게 제어권을 전달할 수 있다.

미들웨어를 활용하여 다음과 같은 작업들을 수행할 수 있다.

• 쿠키 파싱

• 세션 관리

• 인증/인가 (NestJs는 인가를 구현할 때 Guard사용을 권장하고 있다.)

• 본문 파싱

그 외 원하는 기능이 있다면 커스텀 미들웨어를 작성하여 사용하면 된다.

middleware 만들기

NestJs에서 미들웨어를 만들 때 함수로 작성하거나 NestMiddleware 인터페이스를 구현한 클래스로 작성할 수 있다. (함수로도 구현할 수 있다.)

간단하게 요청이 들어오고 next() 실행 전,후 로 logging을 하는 미들웨어이다.

@Injectable()
export class AppMiddleware implements NestMiddleware {
  private readonly logger = new Logger(AppMiddleware.name)

  use(req: Request, res: Response, next: NextFunction) {
    this.logger.log('request가 들어왔습니다.')
    next();
  }
}

해당 미들웨어를 사용하는 모듈에서 NestModule를 구현하여 NestModule의 configure함수를 통해 미들웨어를 설정할 수 있다.

export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(AppMiddleware)
      .forRoutes(AppController)
  }
}

이 후 AppController의 엔드포인트로 요청을 보내면 아래와 같은 로그가 찍히는 것을 확인할 수 있을 것이다.

[Nest] 2217  - 2022. 04. 16. 오전 11:19:44     LOG [AppMiddleware] request가 들어왔습니다.

MiddlewareConsumer 알아보기

configure의 파라미터로 받는 MiddlewareConsumer 객체를 이용하여 미들웨어를 어디에 적용할 지 관리할 수 있다. MiddlewareConsumer는 아래와 같다.

export interface MiddlewareConsumer {
    apply(...middleware: (Type<any> | Function)[]): MiddlewareConfigProxy;
}

정리하자면 configure의 인자로 MiddlewareConsumer 인터페이스를 구현한 객체가 들어오고 해당 객체의 apply를 통하여 지정을 할 수 있게 된는 것이다.

위의 apply를 보면 배열을 받게되는데 함수 미들웨어 혹은 클래스 미들웨어를 나열해주면 된다. 이 때 나열 된 순서대로 적용이 된다.

이렇게 등록이 끝나면 MiddlewareConfigProxy를 리턴하게 되는데 위에서 사용한 forRoute()는 리턴되는 MiddlewareConfigProxy로 인해 체이닝이 가능한 것이다.

MiddlewareConfigProxy 알아보기

MiddlewareConfigProxy인터페이스는 아래와 같은 메서드를 가지고 있다.

export interface MiddlewareConfigProxy {
    exclude(...routes: (string | RouteInfo)[]): MiddlewareConfigProxy;
    forRoutes(...routes: (string | Type<any> | RouteInfo)[]): MiddlewareConsumer;
}

exclude는 미들웨어를 적용하지 않을 대상을 지정할 수 있으며 forRoutes는 미들웨어를 적용할 대상을 지정할 수 있다.

파라미터 타입으로는 문자열, 타입, RouteInfo를 배열로 받고 있으며 RouteInfo는 아래와 같은 인터페이스 타입이다. 해당 인터페이스와 사용법은 아래와 같다.

export interface RouteInfo {
    path: string;
    method: RequestMethod;
}

//ex
consumer
  .apply(AppMiddleware)
  // /users로 들어오는 엔드포인트의 GET Method에 해당하는 핸들러는 미들웨어 적용 대상에서 제외
  .exclude({path: 'users', method: RequestMethod.GET})
  // 문자열 혹은 RouteInfo로 정의할 수 있지만 대부분 Controller Class를 지정한다.
  .forRoutes(AppController)

전역으로 미들웨어 적용하기

위에서는 하나의 특정 모듈에서만 사용하는 미들웨어를 등록했다면 전역으로 사용하는 미들웨어의 등록은 main.ts에서 할 수 있다.

전역에서 NestFactory.create()의 호출결과로 생긴 INestApplication타입이 가지고 있는 use()를 사용하여 미들웨어를 등록해줄 수 있다.

먼저 여기에 새로운 class 미들웨어의 인스턴스를 생성하여 인자로 넣어주고 애플리케이션을 실행해보면 아래와 같은 결과를 받을 수 있다.

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

//output
[Nest] 1531  - 2022. 04. 17. 오후 12:16:57   ERROR [ExceptionHandler] app.use() requires a middleware function
TypeError: app.use() requires a middleware function

그렇다.. 해당 인자로 클래스 미들웨어 말고 함수형 미들웨어를 넣어주어야 한다. 함수형 미들웨어의 syntax는 아래와 같다.

export function logger(req: Request, res: Response, next: NextFunction) {
  //do something...
}

위의 syntax와 같이 함수를 정의한 후 app.use()에 넣어주면 미들웨어가 전역으로 작동하는 것을 볼 수 있을 것이다.

함수로 만든 미들웨어의 단점은 DI 컨테이너를 사용할 수 없다는 것이며 이 뜻은 프로바이더로 주입을 받아 사용할 수 없다는 것을 의미한다. (미들웨어에서도 의존이 필요한 프로바이더를 주입받아 미들웨어 로직을 짜는데 사용할 수 있다.)

Reference

• https://docs.nestjs.com/middleware

• https://wikidocs.net/158621