Spring SSE(Server-Sent Events)

1. 개요

SSE(Server-Sent-Events)는 웹 애플리케이션이 단방향 이벤트 스트림을 처리하고 서버가 데이터를 내보낼 때마다 업데이트를 받을 수 있도록 하는 HTTP 표준이다.

2. SSE 구현

2.1. 컨트롤러 구현

SSE 스트리밍 엔드포인트를 생성하려면 MIME type을 text/event-stream 으로 지정해야 하지만, 응답을 ServerSentEvent 타입으로 매핑할 경우 MIME type을 지정하지 않아도 된다.

@RestController
class NotificationRouter {

    @GetMapping("/notification")
    suspend fun streamNotification(): Flow<ServerSentEvent<String>> =
        Flux.interval(Duration.ofSeconds(1))
            .map { sequence ->
                ServerSentEvent
                    .builder<String>()
                    .id(sequence.toString())
                    .event("periodic-event")
                    .data("\\"SSE\\" : \\"${LocalDate.now()}\\"")
                    .build()
            }
            .asFlow()
}

재연결 시간을 지정하는 comment 속성과 retry 값을 추가할 수도 있다.

data는 JSON 형식이 아닐 경우 에러가 발생하므로 주의해야 한다.

JSON으로 구성하지 않을 경우 다음과 같은 에러 발생

Unrecognized token 'SSE': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')
 at [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 1, column: 5]
com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'SSE': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')
 at [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 1, column: 5]

2.2. 테스트 구현

WebTestClient를 사용하여 요청을 보내보고 응답이 정상적으로 오는지 확인

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
internal class NotificationRouterTest @Autowired constructor(
    private val webTestClient: WebTestClient,
) {

    @Test
    fun `알림을 받을 수 있다`(): Unit = runBlocking {
        val result = webTestClient
            .get()
            .uri("/notification")
            .accept(MediaType.TEXT_EVENT_STREAM)
            .exchange()
            .expectStatus().isOk
            .returnResult(ServerSentEvent::class.java)

        val eventStream = result.responseBody.blockFirst()!!
        assertThat(eventStream.event()).isEqualTo("periodic-event")
    }
}

3. SSE 이해

SSE는 단방향 스트리밍 이벤트를 활용하기 위해 대부분의 브라우저에서 채택한 사양이다. 이벤트는 UTF-8로 인코딩된 텍스트 데이터 스트림이다. 이벤트의 형식은 줄바꿈으로 구분된 일련의 키-값 요소(id, retry, data, event, name, comment)로 구성된다.

스트리밍 기능을 사용할 때 고려할 점은 SSE 스트리밍과 WebSocket 사용의 차이점이다. WebSocket은 서버와 클라이언트 간의 양방향 통신을 제공하는 반면 SSE는 단방향 통신을 사용한다. 또한 WebSocket은 HTTP 프로토콜이 아니며 SSE와 달리 오류 처리 표준을 제공하지 않는다. 이러한 내용들을 참고하여 서비스에 적합한 통신 방식을 선택하여 사용해야 한다.

4. 예제 코드

5. 참고

PreviousSpring Events NextCoroutines

Last updated 5 months ago