NestJS Interceptor를 이용한 횡단 관심사 분리
🤝 횡단 관심사 란?
비즈니스 로직의 핵심 기능이 아닌, 프로세스 중간에 삽입되는 기능을 말한다.
위 사진처럼 프로세스마다 공통되는 기능을 횡단 관심사라고 부르며, 이러한 관심사들의 분리는 AOP, 즉 관점 지향 프로그래밍에서 모듈성을 증가시키기 위한 패터다임이다.
🗿 AOP의 주요 개념
- Aspect : 위에서 설명한
횡단 관심사를 모듈화 한 것이다. - Target : Aspect를 적용하는 곳이다.
- Advice : 실질적인 부가기능을 담은 구현체이다.
- JointPoint :
Advice가 적용될 위치로 필드에서 값을 꺼내올 때 등 다양한 시점에 적용 가능하다. - PointCut :
JointPoint의 상세한 스펙을 정의한 것으로 Advice가 실행될 지점을 정할 수 있음
👽 NestJS의 Interceptor 란?
NestJS는 AOP(Aspect Oriented Programing)에서 영감을 받은 Interceptor를 다음과 같은 5가지의 예시를 들며 강조하고 있다.
- 메서드 실행 전후에 추가 논리 바인딩
- 함수에서 반환된 결과를 변환
- 함수에서 throw된 예외를 변환
- 기본 기능 동작 확장
- 특정 조건에 따라 함수를 완전히 재정의 (예: 캐싱 목적)
NestJS 요청 - 응답 생명주기를 봤을 때 Controller 로직 전/후로 동작을 수행하는 기능이다.
여기서 위 1번 기능으로 JointPoint를 지정해 관심사 분리를 진행할 예정이다.
🪢 횡단 관심사 분리
예를들어 채팅방을 구현한다 가정을 해보자.
방장이 존재할 것이며, 방장은 mute, ban, invite의 기능을 수행할 수 있다.
유저는 chat, DM, block의 기능을 사용할 수 있다.
그전에 일단 해당 채팅방에 참여하고 있어야 한다.
이를 통해 위 AOP의 Aspect를 정의해 보면 채팅방, 채팅으로 구분할 수 있다.
채팅방에서는 채팅방 존재 여부, 방장 권한, 채팅방 참여 가능 여부로 나눌 수 있고, 채팅에서는 mute 여부, block 여부로 나눌 수 있다.
🕸 관점을 기준으로 분리해 보자
class Client extends Socket {
hasChannel: boolean;
isAdmin: boolean;
isMuted: boolean;
}
// 채팅방 Interceptor
class ChannelAuthInterceptor implements NestInterceptor {
private readonly requiredAdmin: boolean;
constructor(param: boolean) {
this.requiredAdmin = param;
}
async intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<any>> {
// Socket Gateway 기반으로 구현된 사항 입니다.
const client: Client = context.switchToWs().getClient();
// 1. 채팅방에 존재하지 않는 경우 Exception
if (!client.hasChannel)
throw new ForbiddenException();
// 2. 방장 권한이 없는 경우 Exception
if (!client.isAdmin && this.requiredAdmin)
throw new ForbiddenException();
}
}
// 채팅 Interceptor
class ChannelMessageInterceptor implements NestInterceptor {
async intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<any>> {
const client: Client = context.switchToWs().getClient();
// 3. 방장에게 채팅 차단을 당한 경우 Exception
if (client.isMuted)
throw new ForbiddenException();
}
}
위에 예시로 적은 모든 기능들을 코드화 하진 않았지만, 위와 같이 채팅방, 채팅으로 관점을 Interceptor로 분리하고, 세부적인 기능을 조건문으로 조정할 수 있다.
🎯 PointCut
클래스, 메서드 어느 곳이던 위 Interceptor를 적용할 수 있다.
위 예시는 채팅방이니, Gateway의 메서드 하나에 적용해 보도록 하겠다.
import ChannelAuthInterceptor from '@Interceptor/channel';
@WebSocketGateway()
export class SocketGateway implements OnGatewayConnection, OnGatewayDisconnect {
/* ... */
// ⬇️ 이곳이 PointCut이 된다.
@UseInterceptors(new ChannelAuthInterceptor(true))
@SubscribeMessage('muteUser')
muteUser(@ConnectedSocket() client: ClientInstance, @MessageBody('userId') userId: number) {
/* Business Logic */
}
}
위처럼 필요한 메서드에 @UseInterceptors 데코레이터를 사용하여 Interceptor를 적용할 수 있다.
필요에 따라, 여러 관심사들을 Interceptor로 묶어 횡단 관심사 분리를 진행할 수 있다.
이로인해 AOP의 주요 목적인 관심사들의 모듈화를 하게 되어, 유지보수성이 높은 코드를 짤 수 있게 된다.
🧩 Interceptor로 할 수 있는 것들
Interceptor만 잘 이용하면 여러 기능을 구현할 수 있다.
HTTP 통신 라우터라면 throw 컨트롤, 메서드 로깅, 요청값 변경, 유효성 검사 등 여러 기능을 수행할 수 있다.
이외에 Socket Gateway라면 NestJS에서 지원하지 않는 Socket Message Body의 유효성 검사가 가능하다.
이 부분은 ValidationPipe로 진행할 수 있다고 생각할 수 있는데, ValidationPipe는 정상적으로 들어온 인자에 대해 검사를 진행하기 때문에, 애초에 undefined로 들어온 인자는 검사 자체를 안한다.
이는 서버 운영에 치명적인 결과를 낳을 수 있지만 Interceptor만 잘 활용하면 해결 가능한 문제이다.
📚 참고 자료
NestJS Docs
AOP 주요 개념
