💝 SSE + Spring Event의 만남

❓개요

파이널 프로젝트 요구사항으로 알림 기능이 존재하였습니다. 알림 기능을 넣기에 앞서 어떤식으로 사용자에게 알림을 보낼지 기술적으로 선택해야하는 상황이었습니다. FCM과 SSE에 대해 2가지 선택사항이 있었습니다. FCM 같은 경우 서버 리소스를 쓰지 않고 외부 서버를 이용해 알림 기능에 책임을 부여하고 실시간 알림이 가능합니다. 하지만 저희 프로젝트같은 경우 클라이언트가 없기때문에 디바이스 토큰 정보를 받아올 수 없고 테스트 코드만으로는 테스트하기에는 무리가 있다고 판단하여 SSE 를 통해 알림기능을 보내기로 결정하였습니다. 실시간성은 FCM 에 비해 떨어지지만 기존 HTTP 인프라를 그대로 활용할 수 있으며 이벤트 형식으로 책임을 분리할 수 있는 방법이 존재하기에 SSE 방식으로 구현하기로 결정했습니다. 그렇다면 지금 부터 Event + SSE 를 통해 구현방법을 설명하겠습니다.

⚙️ SSE 동작 원리

SSE 구현 방법에 설명하기에 앞서 먼저 SSE 동작 원리에 대해서 짚고 넘어가도록 하겠습니다.

요청 흐름

• 초기 연결
  • 클라이언트가 서버에 GET 요청을 보냅니다.
  • 서버는 text/event-stream 컨텐츠 타입으로 응답하게 됩니다.
  • 초기 연결 시 더미데이터를 보내야 5xx 에러를 피할 수 있습니다.
• 이벤트 스트리밍
  • 초기 연결이 후 서버가 지속적으로 이벤트가 발생하면 클라이언트에게 응답하게됩니다.
  • 각 이벤트는 data 접두사를 사용하게 됩니다.
• 연결 끊김 및 재연결
  • 연결이 끊어질 경우 클라이언트는 자동으로 재연결을 시도하게됩니다.
  • Last-Event-Id를 통해 마지막으로 받은 이벤트부터 다시 받을 수 있게됩니다.
• 스트리밍 지속
  • 명시적으로 종료되기 전까지 연결이 유지되며 계속해서 이벤트를 응답하게 됩니다.

SSE 는 서버에서 클라이언트로 데이터가 전송됩니다. WebSocket과 달리 클라이언트에서 서버로 데이터 전송은 불가능합니다. 또한 브라우저 연결 수 제한으로 인해 동시 연결 수가 제한될 수 있습니다. 하지만 WebSocket에 비해 구현이 간단하며 HTTP를 사용하기에 다른 서버와의 호환성이 좋기 때문에 알림기능, 실시간 로그 모니터링으로 많이 사용하는 방식입니다.

💬 Spring Event 에 대해

구현 코드를 설명하기에 앞서 Spring Event 발행 하고 처리하는 방법을 간단히 알아 보겠습니다.

이벤트를 발행하려면 Event 객체가 필요하며 이 이벤트 객체를 보내줄 ApplicationEventPublisher 가 필요합니다. 또한 이벤트를 처리할 EventListener 를 통해 이벤트를 처리해줄 컴포넌트가 필요합니다.

위 3개만 있다면 간단하게 이벤트를 발행해 이벤트를 처리할 수 있습니다. 간단하게 코드로 확인해보겠습니다.

Event

public class CustomEvent extends ApplicationEvent {
    private String message;
    
    public CustomEvent(Object source, String message) {
        super(source);
        this.message = message;
    }
}

• 이벤트 객체를 정의합니다.
• 해당 이벤트에 어떤 데이터가 담기는지는 Custom하게 구현할 수 있습니다.
• 꼭 ApplicationEvent 상속받아 구현해야하는 것은 아닙니다.

Event Publisher

@Autowired
private ApplicationEventPublisher eventPublisher;

public void publishEvent() {
    CustomEvent event = new CustomEvent(this, "이벤트 발생!");
    eventPublisher.publishEvent(event);
}

• ApplicationEventPublisher 를 사용하여 이벤트를 발행할 수 있습니다.
• publishEvent() 메서드를 이용하여 이벤트객체를 담아 이벤트를 발행합니다.

Event Listener

@EventListener
public void handleCustomEvent(CustomEvent event) {
    // 이벤트 처리 로직
}

• @EventListener 애노테이션을 이용해 Event 를 수신할 수 있습니다.
• 비동기가 필요하다면 @Async 애노테이션을 추가하면 됩니다.

Spring Event 를 이용햔다면 간단하게 이벤트를 발행하여 비즈니스 로직에서의 코드를 분리해낼 수 있습니다. 또한 트랜잭션을 분리하여 알림기능이 실패하더라도 비즈니스로직이 롤백되는 경우를 발생시키지 않도록 할 수 있습니다. 이제 Spring Event + SSE 를 이용하여 구현한 코드에 대해 설명하도록 하겠습니다.

🧑‍💻 전체 코드

Event

public record NotificationEvent<T extends Notification>(NotificationType type, T data) {
}

• Event 를 통해 보내줄 데이터를 정해줍니다.
• 엔티티를 이용하여 데이터를 보내기 때문에 Notification 을 상속받은 엔티티에 한해서 Event 를 발생시키도록 하였습니다.

EventPublisherService

@Slf4j
@Service
@RequiredArgsConstructor
public class NotificationPublisherService {
    private final ApplicationEventPublisher applicationEventPublisher;
    private final ChatNotificationRepository chatNotificationRepository;
    private final DonationNotificationRepository donationNotificationRepository;
    private final ExchangeNotificationRepository exchangeNotificationRepository;

    @Transactional(propagation = Propagation.REQUIRES_NEW)
    public void createExchangeNotification(Long userId, String exchangeItemName, String requesterNickname, TradeStatus status) {
        ExchangeNotification exchangeNotification = ExchangeNotification.builder()
                .userId(userId)
                .exchangeItemName(exchangeItemName)
                .requestUserNickname(requesterNickname)
                .tradeStatus(status)
                .build();

        ExchangeNotification savedNotification;

        try {
            savedNotification = exchangeNotificationRepository.save(exchangeNotification);
            applicationEventPublisher.publishEvent(new NotificationEvent<>(NotificationType.EXCHANGE, savedNotification));
        } catch (Exception e) {
            log.warn("알림 발행 실패 : {}", e.getMessage());
        }
    }
}

• NotificationPublisherService 는 이벤트 객체를 만들고 이벤트를 발행하는데에 관심이 있는 컴포넌트입니다.
• propagation을 통해 트랜잭션을 분리했습니다. 이 후 에러가 발생할 수 있는 부분에 에러를 잡아주지 않는다면 트랜잭션을 분리했다고 하더라도 알림 발행 에러가 비즈니스 로직을 롤백시킬 수 있기때문에 발생될 수 있는 에러는 잡아주어야 합니다.

EventListener

@Slf4j
@Component
@RequiredArgsConstructor
public class NotificationEventListener {

    private final Map<Long, SseEmitter> emitters = new ConcurrentHashMap<>();

    public SseEmitter subscribe(Long userId) {
        SseEmitter emitter = new SseEmitter(Duration.ofHours(1).toMillis());

        emitter.onCompletion(() -> emitters.remove(userId));
        emitter.onTimeout(() -> emitters.remove(userId));
        emitter.onError((ex) -> {
            log.info("알림 기능 에러 발생 User Id : {}", userId);
            emitters.remove(userId);
        });

        try {
            emitter.send(SseEmitter.event() // 초기 연결 시 더미데이터 전송 
                    .name("init")
                    .data("connect!!!!!!!"));
        } catch (IOException e) {
            log.info("알람 구독 기능 에러 발생 User Id : {}", userId);
            throw new RuntimeException(e);
        }

        emitters.put(userId, emitter);
        return emitter;
    }

    @Async
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void sendNotification(NotificationEvent<? extends Notification> event) {
        SseEmitter emitter = emitters.get(event.data().getUserId());

        if (emitter != null) {
            try {
                emitter.send(SseEmitter.event() // 알림 전송 
                        .id(event.data().getUserId().toString())
                        .name(event.type().name())
                        .data(event.data())
                        .reconnectTime(Duration.ofHours(1).toMillis()) // 재연결 시간 설절 
                );
            } catch (IOException e) {
                log.info("알림 발송 실패 User Id : {}", event.data().getUserId());
                emitters.remove(event.data().getUserId());
            }
        }
    }
}

• NotificationEventListener 의 가지고 있는 역할은 초기 연결과 알림을 발행하는 역할을 가지고 있습니다.
• SSE에 emitter 를 이용하여 클라이언트에게 응답합니다.
• 초기 연결 시 더미데이터를 보내주어야합니다.
• @EventListener 를 통해 이벤트를 수신하고 비동기적으로 알림을 전송하게 됩니다.

전체적인 흐름도

• Notification이라는 추상 클래스를 통해 알림 기능을 추상화하여 사용하게됩니다.
• NotificationPublisherService 는 알림을 발행하는 관심만 가지고 있습니다.
• NotificationEventListener 는 알림을 클라이언트에게 응답하는데에 관심을 가지고 있습니다.

📖 톺아보기

• Spring Event 를 통해 알림 발행 기능을 비즈니스 로직에서 분리할 수 있었습니다.
• 부가 기능은 트랜잭션을 분리하여 부가 기능이 실패하더라도 비즈니스 로직을 실패하지 않도록 할 수 있었습니다.
• @TransactionalEventListener 를 통해 비즈니스로직이 커밋되고 실행될 수 있도록 함으로써 낮은 결합도를 가지는 코드를 구현할 수 있었습니다.
• SSE 를 통해 알림 발행이 아니더라도 조회 수 카운팅/실시간으로 변하는 페이지를 구현할 수 있다는 것을 깨달았습니다.