使用SpringMVC内置SseEmitter类实现消息推送

SpringMVC内置SseEmitter类内置了几个方法，可以令我相当方便地使用服务器推送事件（Server Sent Event）。

在使用前有几个关于sse的前端知识需要了解：
1 sse机制不同于传统的“请求-响应”模型，在前端必须使用新建的EventSource对象请求一个sse，然后监听此对象的message事件以接收后端推送的值

    const source = new EventSource('http://localhost/sse');
    source.addEventListener('message', (message: any) => {
      console.log(message.data);
    });

使用Rxjs可以构造一个流

    fromEvent(new EventSource('http://localhost/sse'), 'message').subscribe((x: any) => {
      console.log(x);
    });

2 在前端请求一个sse时，在后端未主动关闭和事件未超时前服务器都不会对此请求做出响应以实现“连接”的效果，一旦后端响应这个请求（后端主动或“连接”自动超时）则代表“连接”结束

3 前端一旦接收到响应则EventSource对象会立刻自动重新连接以保证连接的有效性，所以这里必须小心对待建立的“连接”，SPA在跳转页面后若没有手动关闭这个连接则原有的EventSource对象在后台会不断地在sse请求响应时自动“重连”，如果后端以某种方式对每个用户限制一个sse，那么这个旧的、未关闭的EventSource对象建立的sse会取代新的，用户期望使用sse，造成非期望的行为，所以在页面生命周期结束时应手动使用EventSource对象的close()方法关闭“连接”（关闭了连接的对象无法再次打开连接，需要重新创建）

使用SseEmitter的步骤：
1 直接创建SseEmitter对象即可，创建时可设置一个超时时间（默认为30000毫秒），当达到此时间则立刻对请求响应（连接失效）。其他配置在创建好对象后进行

    SseEmitter sse() throws IOException {

        SseEmitter event = new SseEmitter(10000L);

        // 添加一些额外配置
        event.send(
                SseEmitter.event()
                        .reconnectTime(1000L)
                        .id("123")
        );

        concurrentHashMap.put(1, event);
        return event;
    }

2 发送事件可以调用创建好的对象的send方法，发送的数据即为在前端的接收到的message事件中的data属性值

3 发送的数据默认被识别为字符串，如果发送Map则在前端需要用JSON对象解析才能得到json数据
，如果需要规范化数据格式，可以以下方式推送事件：

        event.send(
                SseEmitter.event()
                        .data("值")
                        // 更改原来的“message”事件名称
                        .name("event")
        );

4 当使用已失效的“连接”（不论是超时还是手动响应请求）推送数据时，方法将抛出异常：

java.lang.IllegalStateException: ResponseBodyEmitter is already set complete

当使用对应EventSource已经关闭（不论是手动关闭还是整个对象被摧毁）的SseEmitter对象推送数据时，方法将抛出异常：

java.io.IOException: 你的主机中的软件中止了一个已建立的连接。

可以使用这两个异常被动地判断连接是否还有效。

最后编辑于：2019.05.08 16:26:15

使用SpringMVC内置SseEmitter类 实现消息推送

使用SpringMVC内置SseEmitter类实现消息推送