Web端即时通讯之SSE

Sse可以视为轻量级的webSocket，基于HTTP协议，以流的形式实现服务端到客户端单向消息推送。

模型：

它的原理是在客户端构造一个eventSource对象，同时eventSource对象会保持与服务器的长连接，断开后会自动重连，如果要强制关闭可以调用它的close方法。可以它的监听onmessage事件，服务端遵循SSE数据传输的格式给客户端，客户端在onmessage事件触发时就能够接收到数据，从而进行某种处理.

网页端代码如下：

<script type="text/javascript">

    if (window.EventSource) {
        const userId = new Date().getTime(); //模拟用户id
        var source = new EventSource('http://localhost:8888/ssev2/connect/' + userId); //建立连接


        source.onopen = function () {
            // console.log("state :" + source.readyState);
            page.innerHTML += "<p>Connection open.</p>";
        };

        source.onerror = function () {
            page.innerHTML += "<p>Connection close.</p>";
        };

        //对应服务端不定义消息类型写法
        source.onmessage = function (event) {
            page.innerHTML += "<p>" + event.data + "</p>";
        };
        
        //对应服务端定义消息类型写法
        //source.addEventListener("messageType", function (event) {
        //    page.innerHTML += "<p>" + "messageType:" + event.data + "</p>";
        //})
        
    } else {
        console.log("当前浏览器不支持SSE");
    }

</script>

服务端代码如下：

public class SseEmitterServer {
	private static final Logger log = LoggerFactory.getLogger(SseEmitterServer.class);

    /**
     * 当前连接数
     */
    private static AtomicInteger count = new AtomicInteger(0);

    /**
     * 使用map对象，便于根据userId来获取对应的SseEmitter，或者放redis里面
     * 当前数据结构不支持多点登录，多点需要根据自身登录逻辑修改sseEmitterMap数据结构
     */
    private static Map<String, SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();

    /**
     * 创建用户连接并返回 SseEmitter
     */
    public static SseEmitter connect(String userId) {
        // 设置超时时间，0表示不过期。默认30秒，超过时间未完成会抛出异常：AsyncRequestTimeoutException
        SseEmitter sseEmitter = new SseEmitter(0L);
        // 注册回调，错误、超时、完成时调用指定方法
        sseEmitter.onCompletion(completionCallBack(userId));
        sseEmitter.onError(errorCallBack(userId));
        sseEmitter.onTimeout(timeoutCallBack(userId));
        sseEmitterMap.put(userId, sseEmitter);
        // 数量+1
        count.getAndIncrement();
        log.info("创建新的sse连接，当前用户：{}", userId);
        return sseEmitter;
    }
    

    /**
     * 群发所有在线用户
     */
    public static void batchSendMessage(String wsInfo) {
        sseEmitterMap.forEach((k, v) -> {
            try {
                //写法一：不定义消息类型，网页使用 source.onmessage即可全部接收
                v.send(wsInfo, MediaType.APPLICATION_JSON);
                
                //写法二：定义消息类型"messageType",网页需要使用 source.addEventListener接收指定消息类型
                /*SseEmitter.SseEventBuilder sseEventBuilder = SseEmitter.event()
                        .id(UUID.randomUUID().toString())
                        .name("messageType")
                        .data(wsInfo);
                o.send(sseEventBuilder);*/
            } catch (IOException e) {
                log.error("用户[{}]推送异常:{}", k, e.getMessage());
                removeUser(k);
            }
        });
    }
    
    
    /**
     * 群发消息
     */
    public static void batchSendMessage(String wsInfo, List<String> ids) {
        ids.forEach(userId -> sendMessage(wsInfo, userId));
    }
    
    
    /**
     * 指定用户发送信息
     */
    public static void sendMessage(String userId, String message) {
        if (sseEmitterMap.containsKey(userId)) {
            try {
                sseEmitterMap.get(userId).send(message, MediaType.APPLICATION_JSON);
            } catch (IOException e) {
                log.error("用户[{}]推送异常:{}", userId, e.getMessage());
                removeUser(userId);
            }
        }
    }

    /**
     * 移除用户连接
     */
    public static void removeUser(String userId) {
        sseEmitterMap.remove(userId);
        count.getAndDecrement();// 数量-1
        log.info("移除用户：{}", userId);
    }

    /**
     * 获取当前连接信息
     */
    public static List<String> getIds() {
        return new ArrayList<>(sseEmitterMap.keySet());
    }

    /**
     * 获取当前连接数量
     */
    public static int getUserCount() {
        return count.intValue();
    }

    private static Runnable completionCallBack(String userId) {
        return () -> {
            log.info("结束连接：{}", userId);
            removeUser(userId);
        };
    }

    private static Runnable timeoutCallBack(String userId) {
        return () -> {
            log.info("连接超时：{}", userId);
            removeUser(userId);
        };
    }

    private static Consumer<Throwable> errorCallBack(String userId) {
        return throwable -> {
            log.info("连接异常：{}", userId);
            removeUser(userId);
        };
    }
}