미들웨어

미들웨어는 라우트 핸들러 앞에 호출되는 함수다.

미들웨어 함수는 애플리케이션의 요청-응답 주기에서 request 및 response 객체와 next() 미들웨어 함수에 액세스할 수 있다. next 미들웨어 함수는 일반적으로 next 라는 변수로 표시된다.

Nest 미들웨어는 기본적으로 Express 미들웨어와 동일하다. Express 공식 문서에서는 미들웨어를 다음과 같이 설명한다.

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

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

의존성 주입

Nest 미들웨어는 의존성 주입을 완벽하게 지원한다.

프로바이더 및 컨트롤러와 마찬가지로 모듈 내에서 사용할 수 있는 종속성을 주입할 수 있으며 늘 그렇듯이 contructor 를 통해 수행된다.

미들웨어 적용하기

@Module() 데코레이터에는 미들웨어를 위한 자리가 없다. 대신 모듈 클래스의 configure() 메서드를 사용하여 설정한다. 미들웨어를 포함하는 모듈은 NestModule 인터페이스를 구현해야 한다.

AppModule 수준에서 LoggerMiddleware 를 설정해 보자.

// app.module.ts
import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { LoggerMiddleware } from './common/middleware/logger.middleware';
import { CatsModule } from './cats/cats.module';

@Module({
  imports: [CatsModule],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer.apply(LoggerMiddleware).forRoutes('cats');
  }
}

위의 예제에서는 이전에 CatsController 내부에 정의된 /cats 라우트 핸들러에 LoggerMiddleware 를 설정했다. 또한 미들웨어를 구성할 때 라우트 경로와 요청 메서드가 포함된 객체를 forRoutes() 메서드에 전달하여 미들웨어를 특정 요청 메서드로 제한할 수도 있다.

아래 예제에서는 원하는 요청 메서드 유형을 참조하기 위해 RequestMethod 열거형(enum)을 가져온 것을 볼 수 있다.

// app.module.ts
import {
  Module,
  NestModule,
  RequestMethod,
  MiddlewareConsumer,
} from '@nestjs/common';
import { LoggerMiddleware } from './common/middleware/logger.middleware';
import { CatsModule } from './cats/cats.module';

@Module({
  imports: [CatsModule],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes({ path: 'cats', method: RequestMethod.GET });
  }
}

라우트 와일드카드

미들웨어에는 패턴 기반 라우트도 지원된다.

예를 들어 별표(asterisk)는 와일드카드로 사용되며 어떤 문자 조합과도 일치한다:

forRoutes({ path: 'ab*cd', method: RequestMethod.ALL });

'ab*cd' 라우트 경로는 abcd , ab_cd , abecd 등과 일치한다.

문자 ? , + , * 및 () 는 라우트 경로에 사용할 수 있으며 정규식 대응 문자의 하위 집합이다.

하이픈( - )과 점( . )은 문자열 기반 경로에서 문자 그대로 해석된다.

미들웨어 소비자

MiddlewareConsumer 는 헬퍼 클래스다.

미들웨어를 관리하기 위한 몇 가지 내장 메서드를 제공한다. 이 모든 메서드는 fluent style로 간단히 연결할 수 있다.

forRoutes() 메서드는 단일 문자열, 다중 문자열, RouteInfo 객체, 컨트롤러 클래스, 컨트롤러 리스트를 받을 수 있다. 대부분의 경우 쉼표로 구분된 컨트롤러 리스트을 전달할 것이다.

아래는 단일 컨트롤러를 사용한 예제다:

// app.module.ts
import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { LoggerMiddleware } from './common/middleware/logger.middleware';
import { CatsModule } from './cats/cats.module';
import { CatsController } from './cats/cats.controller';

@Module({
  imports: [CatsModule],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer.apply(LoggerMiddleware).forRoutes(CatsController);
  }
}

라우트 제외하기

특정 라우트를 미들웨어 적용 대상에서 제외하고 싶을 때가 있다.

exclude() 메서드를 사용하면 특정 라우트를 쉽게 제외할 수 있다. 이 메서드는 아래와 같이 제외할 경로를 식별하는 단일 문자열, 다중 문자열 또는 RouteInfo 객체를 받을 수 있다:

consumer
  .apply(LoggerMiddleware)
  .exclude(
    { path: 'cats', method: RequestMethod.GET },
    { path: 'cats', method: RequestMethod.POST },
    'cats/(.*)',
  )
  .forRoutes(CatsController);

위의 예제에서 LoggerMiddleware 는 exclude() 메서드에 전달된 세 개의 라우트를 제외한 CatsController 내부에 정의된 모든 라우트에 바인딩된다.

함수형 미들웨어

우리가 사용한 LoggerMiddleware 클래스는 매우 간단하다. 멤버도 없고, 추가 메서드도 없으며, 종속성도 없다. 미들웨어를 클래스 대신 간단한 함수로 정의할 수 없는 이유는 무엇일까? 사실 가능하다. 이러한 유형의 미들웨어를 함수형 미들웨어라고 한다. 차이점을 설명하기 위해 LoggerMiddleware를 클래스 기반에서 함수형 미들웨어로 변환해 보자:

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

export function logger(req: Request, res: Response, next: NextFunction) {
  console.log(`Request...`);
  next();
}

그리고 AppModule 내에서 사용한다:

// app.module.ts
consumer.apply(logger).forRoutes(CatsController);

다중 미들웨어

위에서 언급했듯이 순차적으로 실행되는 여러 미들웨어를 바인딩하려면 apply() 메서드 안에 쉼표로 구분된 리스트를 제공하면 된다:

consumer.apply(cors(), helmet(), logger).forRoutes(CatsController);

전역 미들웨어

등록된 모든 라우트에 미들웨어를 한 번에 바인딩하려면 INestApplication 인스턴스에서 제공하는 use() 메서드를 사용할 수 있다:

// main.ts
const app = await NestFactory.create(AppModule);
app.use(logger);
await app.listen(3000);