#6 Nest Gateway

종속성 주입, 데코레이터, 예외 필터, 파이프, 가드, 인터셉터 등 이 문서의 다른 곳에서 설명하는 대부분의 개념은 게이트웨이에도 동일하게 적용됩니다. Nest는 가능한 경우 구현 세부 사항을 추상화하여 동일한 구성 요소가 HTTP 기반 플랫폼, 웹소켓 및 마이크로서비스에서 실행될 수 있도록 합니다.

Nest에서 게이트웨이는 @WebSocketGateway() 데코레이터로 주석을 단 클래스일 뿐입니다. 기술적으로 게이트웨이는 플랫폼에 구애받지 않으므로 어댑터가 생성되면 모든 WebSockets 라이브러리와 호환됩니다. 기본적으로 지원되는 WS 플랫폼은 socket.io와 ws의 두 가지입니다.

게이트웨이는 프로바이더로 취급될 수 있으며, 이는 클래스 생성자를 통해 종속성을 주입할 수 있음을 의미합니다. 또한 게이트웨이는 다른 클래스(프로바이더 및 컨트롤러)에서도 주입할 수 있습니다.

사용하기 위해서는 다음과 같은 패키지를 설치해야합니다. 

@nestjs/websockets @nestjs/platform-socket.io

nest cli 명령어를 통하여  nest g module events, nest g ga events 모듈과 게이트 웨이를 만들어 사용 하면 편리합니다.

@SubcribeMessage 데코레이터를 활용하여 이벤트 핸들러 예시 

@SubscribeMessage('events')
handleEvent(@MessageBody() data: string): string {
  return data;
}

@SubscribeMessage('events')
handleEvent(@MessageBody('id') id: number): number {
  // id === messageBody.id
  return id;
}

@SubscribeMessage('events')
handleEvent(client: Socket, data: string): string {
  return data;
}

@SubscribeMessage('events')
handleEvent(
  @MessageBody() data: string,
  @ConnectedSocket() client: Socket,
): string {
  return data;
}

플랫폼별 서버 인스턴스에 직접 액세스 예시

@WebSocketServer()
server: Server;

or

@WebSocketServer({ namespace: 'my-namespace' })
namespace: Namespace;

Nest JS 공식 사이트에서 제공 하는 예시: https://github.com/nestjs/nest/tree/master/sample/02-gateways

출처:
https://docs.nestjs.com/websockets/gateways