Spring服务端框架中SSE的使用实践

之前歪哥写过在Nextjs前端框架中使用SSE，这次我们把前后端分离，看一下SSE在服务端该怎么写，使用的框架是我们的老朋友Spring Framework。

为了照顾没有接触过SSE的小伙伴，我们先简单来了解一下它。

Server-Sent Events（SSE）是一种用于实现服务器向客户端实时推送数据的Web技术。与传统的轮询和长轮询相比，SSE提供了更高效和实时的数据推送机制。

SSE与WebSocket 作用相似，但是WebSocket更强大和灵活。因为WebSocket是全双工通道，可以双向通信；SSE 是单向通道，只能服务器向浏览器发送。

看到这里想必大家都明白了，无需多说。

下面进入正题，首先需要知道的是，Spring框架中已经内置了SSE，所以使用相当方便，无需额外引入依赖。

我们可以先定义一个类来管理SSE，示例如下

@Component
public class SseEmitterManager {
    private Map<String, SseEmitter> sseEmitterMap;

    @PostConstruct
    public void init() {
        if (sseEmitterMap == null) {
            sseEmitterMap = new ConcurrentHashMap<>();
        }
    }

    public SseEmitter sseEmitter(String clientId) {
        return sseEmitterMap.getOrDefault(clientId, null);
    }

    public SseEmitter registerSseEmitter(String clientId, SseEmitter sseEmitter) {
        return this.sseEmitterMap.putIfAbsent(clientId, sseEmitter);
    }

    public void removeSseEmitter(String clientId) {
        if (sseEmitterMap.containsKey(clientId)) {
            sseEmitterMap.get(clientId).complete();
            sseEmitterMap.remove(clientId);
        }
    }
}

我们在这里维护一个Map来区分不同客户端的推送通道。

下一步就是定义对外的接口，如下

@GetMapping("/push")
public SseEmitter push(HttpServletResponse response) {
    sseEmitterManager.registerSseEmitter("warn-info-emitter", new SseEmitter(0L));
    return sseEmitterManager.sseEmitter("warn-info-emitter");
}

在这个接口里面，我们监听clientId为warn-info-emitter的SSE通道，接口的返回是一种数据流，会保持连接，每有一条新消息过来，就会向调用方吐出。我们可以使用浏览器或者postman等工具方便的调试。

最后我们在所需的业务逻辑处发送消息就行了，示例如下

public void execute(WarningAction warningAction, String warningMessage) {
    SseEmitter emitter = sseEmitterManager.sseEmitter("warn-info-emitter");

    if (emitter == null) {
        return;
    }

    emitter.onCompletion(() -> log.info("connect completion"));
    emitter.onError((throwable) -> log.error("connect error {}", throwable.getMessage()));
    emitter.onTimeout(() -> log.error("connect timeout"));

    try {
        emitter.send(warningMessage);
    } catch (IOException e) {
        log.error("message push abnormal! please check your connection");
    }
}

注意使用相同的clientId。

以上就是SSE服务端的使用，是不是特别简单呢！