Spring message ChannelInterceptor 메서드 특징

🙄 배경

프로젝트에서 Websocket + STOMP를 활용하여 접속자 여러 명이 동시에 작업하는 기능을 추가해야 하는 과정이 있었다. 메시징을 전송하기 전과 후에 특정 처리를 해야하는 과정이 있었는데, 그때 ChannelInterceptor 인터페이스에 대해 알게 되었다.

ChannelInterceptor

해당 인터페이스를 구현하고 등록하여, 메시지가 송/수신되기 전 메시지의 데이터 검증 및 변환을 할 수 있다.

해당 인터페이스는 총 6개의 메서드를 가지고 있으며 기능은 다음과 같은 특징을 가지고 있다.

1. preSend()

- 모든 유형의 채널에 대해 호출된다.

- 메시지가 실제로 채널로 전송되기 전에 호출된다.

- 메시지(Message)와 MessageChannel에 대한 참조는 인터셉터 메서드의 매개변수로 사용할 수 있다.

- 해당 시점을 활용해서 특정 처리만 하는 경우(메시지 수정 X), 매개변수로 전달된 동일한 메시지를 반환해야 한다.

-  null을 반환하여 메시지 preSend()의 전송을 막을 수도 있다.

2. postSend()

- 모든 유형의 채널에 대해 호출된다.

- MessageChannel.send() 호출 직후에 호출된다.

- sent 매개변수(boolean)는 메시지 시도가 성공했는지 여부를 나타낸다.

3. preReceive()

- 폴링 가능한 채널(PollableChannel)에 대해서만 호출된다.

- PollableChannel.receive() 메서드에 의해 메시지가 반환되기 전에 호출된다.

- false를 반환하면 메시지 전달이 차단된다.

4. postReceive()

- 폴링 가능한 채널(PollableChannel)에 대해서만 호출된다.

-  PollableChannel.receive() 메서드가 전달된 메시지를 반환 값으로 사용하며, 수신 메서드로 반환하기 직전에 호출된다.

-  해당 시점을 활용해서 특정 처리만 하는 경우(메시지 수정 X), 매개변수로 전달된 동일한 메시지를 반환해야 한다.

5. afterSendCompletion()

- 예외 발생 여부에 관계없이 수신 완료 후 호출된다.

- 적절한 리소스 정리가 가능하다.

- preSend()가 메시지(Message)를 반환하는 경우에만 호출된다.

- preSend()가 null을 반환하는 경우 호출되지 않는다.

6. afterReceiveCompletion()

- 예외 발생 여부에 관계없이 수신 완료 후 호출된다.

- 적절한 리소스 정리가 가능하다.

- preReceive()가 true를 반환하는 경우에만 호출된다.

REFERENCE

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/messaging/support/ChannelInterceptor.html