springboot 微信消息推送 springboot sse推送

一、springboot 微信消息推送 springboot sse推送

1、在 Spring 框架中实现

2、传统的 Servlet 中实现

一、springboot 微信消息推送 springboot sse推送

关于 SSE
SSE 全程 Server Send Event，是 HTTP 协议中的一种，Content-Type 为 text/event-stream，是服务端主动向前端推送数据。类似于 WebSocket。

SSE 优势我们可以划分为两个：

长链接
服务端能主动向客户端推送数据

这里我们用 sse 与 websocket 对比下：

sse	websocket
centered 文本居中	right-aligned 文本居右
http 协议独立的	websocket 协议轻量，使用简单相对复杂
默认支持断线重连	需要本身实现断线重连
文本传输	二进制传输
支持自定义发送的消息类型	-

另外在响应式流里面，可以多次返回数据（其实和响应式没有关系），使用的技术就是H5的SSE。

返回的数据有固定的要求格式。

sse 规范

在 html5 的定义中，服务端 sse，通常须要遵循如下要求

请求头

开启长链接 + 流方式传递

Content-Type: text/event-stream;charset=UTF-8
Cache-Control: no-cache
Connection: keep-alive

数据格式

服务端发送的消息，由 message 组成，其格式以下:

field:value\n\n

其中 field 有五种可能

空：即以 : 开头，表示注释，能够理解为服务端向客户端发送的心跳，确保链接不中断
data：数据
event：事件，默认值
id：数据标识符用 id 字段表示，至关于每一条数据的编号
retry：重连时间

1、在 Spring 框架中实现

这里需要允许跨域

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.Locale;
import java.util.concurrent.TimeUnit;/*** @author wuq* @Time 2022-12-19 15:02* @Description*/
@CrossOrigin(origins = "*", maxAge = 3600)
@Controller
public class SSEController {@RequestMapping(value = "/", method = RequestMethod.GET)public String home(Locale locale, Model model) {return "sse";}@RequestMapping(value = "push")public void push(HttpServletResponse response) throws IOException {response.setContentType("text/event-stream");response.setCharacterEncoding("utf-8");for (int i = 0; i < 5; i++) {// 指定事件标识  event: 这个为固定格式response.getWriter().write("event:me\n");// 格式：data: + 数据 + 2个回车response.getWriter().write("data:" + i + "\n\n");response.getWriter().flush();try {TimeUnit.SECONDS.sleep(1);} catch (InterruptedException e) {e.printStackTrace();}}}
}

前端测试

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<div><div id="message"></div>
</div>
<script type="text/javascript">// 初始化，参数为url// 依赖H5var sse = new EventSource("http://localhost:8080/push")// 监听消息并打印sse.onmessage = function (evt) {console.log("message", evt.data, evt)}// 如果指定了事件标识需要用这种方式来进行监听事件流sse.addEventListener("me", function (evt) {console.log("me event", evt.data)// 事件流如果不关闭会自动刷新请求，所以我们需要根据条件手动关闭if (evt.data == 3) {sse.close();    // 注释掉这个可以看到自动重连的效果}setMessageInnerHTML(evt.data);})// 将消息显示在网页上function setMessageInnerHTML(innerHTML) {document.getElementById('message').innerHTML += innerHTML + '<br/>';}
</script>
</body>
</html>

一起来看下效果

2、传统的 Servlet 中实现

至于为什么要关注与传统的 Servlet 实现，是因为这样子的，之前看过一篇文章，文章上面说离开了 Spring 几乎都不会写代码了，的确是有这样子的感觉，现在离开了 Spring 连传统的 Servlet 都快忘记完了。感觉还是有必要了解下原始的写法，不过下面的工程还是基于 Spring 的工程来的，这样子搭建最简单。

需要在启动类中增加 @ServletComponentScan

@SpringBootApplication
@ServletComponentScan    //  需要增加这个
public class SSEApplication {public static void main(String[] args) {SpringApplication.run(SSEApplication.class, args);}
}

对应的后端代码

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.concurrent.TimeUnit;@WebServlet(name = "SSE", urlPatterns = "/SSE")
public class SSE extends HttpServlet {protected void doPost(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {doGet(request, response);}protected void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {response.setContentType("text/event-stream");  // 这里可以了解到是使用的 `text/event-stream` 作为响应的 ContentTyperesponse.setCharacterEncoding("utf-8");for (int i = 0; i < 5; i++) {// 指定事件标识response.getWriter().write("event:me\n");// 格式：data: + 数据 + 2个回车response.getWriter().write("data:" + i + "\n\n");response.getWriter().flush();try {TimeUnit.SECONDS.sleep(1);} catch (InterruptedException e) {e.printStackTrace();}}}
}

使用场景：服务器向客户端推送数据，例如聊天室

3、封装工具类实现

SpringMVC封装的SSE实现，Controller 中直接返回 SseEmitter，不调用 complete() 方法，即可保持长链接。

创建一个工具类 SseEmitterUtil

package com.demo.test.sse.controller;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;@Slf4j
public class SseEmitterUtil {/*** 当前连接数*/private static AtomicInteger count = new AtomicInteger(0);/*** 使用 map 对象，便于根据 userId 来获取对应的 SseEmitter，或者放 redis 里面*/private static Map<String, SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();/*** 创建用户连接并返回 SseEmitter** @param userId 用户ID* @return SseEmitter*/public static SseEmitter connect(String userId) {// 设置超时时间，0表示不过期。默认30秒，超过时间未完成会抛出异常：AsyncRequestTimeoutExceptionSseEmitter sseEmitter = new SseEmitter();// 注册回调sseEmitter.onCompletion(completionCallBack(userId));sseEmitter.onError(errorCallBack(userId));sseEmitter.onTimeout(timeoutCallBack(userId));// 缓存sseEmitterMap.put(userId, sseEmitter);// 数量+1count.getAndIncrement();log.info("创建新的sse连接，当前用户：{}", userId);return sseEmitter;}/*** 给指定用户发送信息*/public static void sendMessage(String userId, String message) {if (!sseEmitterMap.containsKey(userId)) return;try {// sseEmitterMap.get(userId).send(message, MediaType.APPLICATION_JSON);sseEmitterMap.get(userId).send(message);} catch (IOException e) {log.error("用户[{}]推送异常:{}", userId, e.getMessage());removeUser(userId);}}/*** 群发消息*/public static void batchSendMessage(String wsInfo, List<String> ids) {ids.forEach(userId -> sendMessage(wsInfo, userId));}/*** 群发所有人*/public static void batchSendMessage(String wsInfo) {sseEmitterMap.forEach((k, v) -> {try {v.send(wsInfo, MediaType.APPLICATION_JSON);} catch (IOException e) {log.error("用户[{}]推送异常:{}", k, e.getMessage());removeUser(k);}});}/*** 移除用户连接*/public static void removeUser(String userId) {sseEmitterMap.remove(userId);// 数量-1count.getAndDecrement();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);};}
}

controller 中的写法

package com.demo.test.sse.controller;import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;@CrossOrigin(origins = "*", maxAge = 3600)
@RestController
@RequestMapping("sse")
public class SseRestController {/*** 用于创建连接*/@GetMapping("/connect/{userId}")public SseEmitter connect(@PathVariable String userId) {return SseEmitterUtil.connect(userId);}/*** 推送给所有人** @param message* @return*/@GetMapping("/push/{message}")public String push(@PathVariable(name = "message") String message) {//获取连接人数int userCount = SseEmitterUtil.getUserCount();//如果无在线人数，返回if(userCount<1){return "无人在线！";}SseEmitterUtil.batchSendMessage(message);return "发送成功！";}/*** 发送给单个人** @param message* @param userid* @return*/@GetMapping("/push_one/{messsage}/{userid}")public String pushOne(@PathVariable(name = "message") String message, @PathVariable(name = "userid") String userid) {SseEmitterUtil.sendMessage(userid, message);return "推送消息给" + userid;}/*** 关闭连接*/@GetMapping("/close/{userid}")public String close(@PathVariable("userid") String userid) {SseEmitterUtil.removeUser(userid);return "连接关闭";}
}

前端测试

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>消息推送</title>
</head>
<body><div><button onclick="closeSse()">关闭连接</button><div id="message"></div></div>
</body><script>let source = null;// 用时间戳模拟登录用户const userId = new Date().getTime();if (window.EventSource) {// 建立连接source = new EventSource('http://localhost:8080/sse/connect/' + userId);/*** 连接一旦建立，就会触发open事件* 另一种写法：source.onopen = function (event) {}*/source.addEventListener('open', function (e) {setMessageInnerHTML("建立连接。。。");}, false);/*** 客户端收到服务器发来的数据* 另一种写法：source.onmessage = function (event) {}*/source.addEventListener('message', function (e) {setMessageInnerHTML(e.data);});/*** 如果发生通信错误（比如连接中断），就会触发error事件* 或者：* 另一种写法：source.onerror = function (event) {}*/source.addEventListener('error', function (e) {if (e.readyState === EventSource.CLOSED) {setMessageInnerHTML("连接关闭");} else {console.log(e);}}, false);} else {setMessageInnerHTML("你的浏览器不支持SSE");}// 监听窗口关闭事件，主动去关闭sse连接，如果服务端设置永不过期，浏览器关闭后手动清理服务端数据window.onbeforeunload = function () {closeSse();};// 关闭Sse连接function closeSse() {source.close();const httpRequest = new XMLHttpRequest();httpRequest.open('GET', 'http://localhost:8080/sse/close/' + userId, true);httpRequest.send();console.log("close");}// 将消息显示在网页上function setMessageInnerHTML(innerHTML) {document.getElementById('message').innerHTML += innerHTML + '<br/>';}
</script>
</html>

注意
客户端关闭了连接，不管是调用了event.target.close() 还是关闭了网页，服务端不会触发任何回调。直到服务端调用 send 后才会触发onError和onCompletion回调。

服务端触发了onCompletion回调后，连接就断开了。

参考链接

https://www.zhangbj.com/p/1262.html
http://www.javashuo.com/article/p-uelldoqc-ds.html