服务端(后端)主动通知前端的实现：WebSocket(springboot中使用WebSocket案例)

一、背景

我们都知道 http 协议只能浏览器单方面向服务器发起请求获得响应，服务器不能主动向浏览器推送消息。想要实现浏览器的主动推送有两种主流实现方式：

轮询：缺点很多，但是实现简单
websocket：在浏览器和服务器之间建立 tcp 连接，实现全双工通信

springboot 使用 websocket 有两种方式，一种是实现简单的 websocket，另外一种是实现STOMP协议。这一篇实现简单的 websocket，STOMP 下一篇在讲。
实际需求：​
项目中需要做一个消息提示功能，当有用户处理相关待办信息后，别的用户需要实时更新处理后的待办信息。
解决方案：
​ 1、使用最原始的方法，写个定时器去查询待办信息。但这种方式在大多数情况是不被允许的，它会浪费系统中的许多资源，同时也并不是完全意义上的实时更新。

​ 2、使用WebSocket通信技术去实现一个实时更新，它可以实现广播和私信的模式。当一个用户与WebSocket服务建立连接后，用户可以给它发送一个消息，此时WebSocket服务会接收到这个消息并做出回信（此时可以回信给所有与其建立连接的用户——广播，也可以回信给指定用户——私信）。接下来将从前后端去讲解WebSocket的使用。

二、websocket应用场景

决定手头的工作是否需要使用WebSocket技术的方法很简单：

你的应用提供多个用户相互交流吗？
你的应用是展示服务器端经常变动的数据吗？

以下是一些典型的应用场景：

1. 协同办公 / 编辑
   我们生活在分散式办公的时代，时常需要在不同地点同时编辑同一份文档，比如 腾讯在线office文档、编程文件等。
2. 社交 / 订阅
   比如微信朋友圈的实时更新提醒、点赞或评论的红点通知，比如qq的特别关注人的动态提醒，比如聊天信息的实时同步，比如新闻客户端的订阅通知等等。
3. 多玩家游戏
   对于在线实时的多人游戏，互动效率是非常重要的，你可不想在扣动扳机之后，你的对手却已经在10秒钟之前移动了位置。
4. 股市基金报价
   金融界瞬息万变——几乎是每毫秒都在变化。过时的信息也只能导致损失，我们人类的大脑不能持续以那样的速度处理那么多的数据，需要一些算法来帮我们处理这些事情。当你有一个显示盘来跟踪你感兴趣的公司时，你肯定想要随时知道他们的价值，而不是10秒前的数据。使用WebSocket可以流式更新这些数据变化而不需要等待。
5. 体育实况播放
   在体育播报的体验中，减低时延是最重要的一点。
6. 音视频聊天 / 视频会议 / 在线教育
   用WebSockets getUserMedia API和HTML5音视频元素明显是个不错的选择。WebRTC的出现顺理成章的成为我刚才概括的组合体，它看起来很有希望，但其缺乏目前浏览器的支持。
7. 基于位置的应用
   越来越多的开发者借用移动设备的GPS功能来实现他们基于位置的网络应用。比如共享单车、共享汽车、百度天眼，地图GPS服务、疫情监控目标人的实时运动轨迹、运动员的轨迹分析。借用WebSocket TCP链接可以让数据飞起来。

三、实现

1、依赖引入

要使用 websocket 关键是@ServerEndpoint这个注解，该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中，只需要引入如下 javaee 标准依赖即可：

<dependency>
  <groupId>javaxgroupId>
  <artifactId>javaee-apiartifactId>
  <version>7.0version>
  <scope>providedscope>
dependency>
1
2
3
4
5
6

如使用 springboot 内置容器,无需引入，springboot 已经做了包含。我们只需引入如下依赖即可：

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-websocketartifactId>
    <version>1.5.3.RELEASEversion>
    <type>pomtype>
dependency>
1
2
3
4
5
6

2.配置bean

该 Bean 会自动注册使用@ServerEndpoint 注解申明的 websocket endpoint。

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}
1
2
3
4
5
6
7

3.声明endpoint

建立MyWebSocket.java类，在该类中处理 websocket 逻辑

@ServerEndpoint(value = "/websocket") //接受websocket请求路径
@Component  //注册到spring容器中
public class MyWebSocket {


    //保存所有在线socket连接
    private static Map<String,MyWebSocket> webSocketMap = new LinkedHashMap<>();

    //记录当前在线数目
    private static int count=0;

    //当前连接（每个websocket连入都会创建一个MyWebSocket实例
    private Session session;

    private Logger log = LoggerFactory.getLogger(this.getClass());
    //处理连接建立
    @OnOpen
    public void onOpen(Session session){
        this.session=session;
        webSocketMap.put(session.getId(),this);
        addCount();
        log.info("新的连接加入：{}",session.getId());
    }

    //接受消息
    @OnMessage
    public void onMessage(String message,Session session){
        log.info("收到客户端{}消息：{}",session.getId(),message);
        try{
            this.sendMessage("收到消息："+message);
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    //处理错误
    @OnError
    public void onError(Throwable error,Session session){
        log.info("发生错误{},{}",session.getId(),error.getMessage());
    }

    //处理连接关闭
    @OnClose
    public void onClose(){
        webSocketMap.remove(this.session.getId());
        reduceCount();
        log.info("连接关闭:{}",this.session.getId());
    }

    //群发消息

    //发送消息
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    //广播消息
    public static void broadcast(){
        MyWebSocket.webSocketMap.forEach((k,v)->{
            try{
                v.sendMessage("这是一条测试广播");
            }catch (Exception e){
            }
        });
    }

    //获取在线连接数目
    public static int getCount(){
        return count;
    }

    //操作count，使用synchronized确保线程安全
    public static synchronized void addCount(){
        MyWebSocket.count++;
    }

    public static synchronized void reduceCount(){
        MyWebSocket.count--;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

4.客户端的实现

客户端使用 h5 原生 websocket，部分浏览器可能不支持。代码如下：

 <html>
  <head>
    <title>websocket测试title>
    <meta charset="utf-8" />
  head>

  <body>
    <button onclick="sendMessage()">测试button>
    <script>
      let socket = new WebSocket("ws://localhost:8080/websocket");
      socket.onerror = err => {
        console.log(err);
      };
      socket.onopen = event => {
        console.log(event);
      };
      socket.onmessage = mess => {
        console.log(mess);
      };
      socket.onclose = () => {
        console.log("连接关闭");
      };

      function sendMessage() {
        if (socket.readyState === 1) socket.send("这是一个测试数据");
        else alert("尚未建立websocket连接");
      }
    script>
  body>
html>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

5.测试

@RestController
public class HomeController {

    @GetMapping("/broadcast")
    public void broadcast(){
        MyWebSocket.broadcast();
    }
}
1
2
3
4
5
6
7
8

然后打开上面的 html，可以看到浏览器和服务器都输出连接成功的信息：

浏览器：
Event {isTrusted: true, type: "open", target: WebSocket, currentTarget: WebSocket, eventPhase: 2, …}

服务端：
2022-09-01 16:14:22.669  INFO 32460 --- [nio-8080-exec-3] c.e.WebSocketDemo.service.MyWebSocket    : 新的连接加入：0
1
2
3
4
5

点击测试按钮，可在服务端看到如下输出

2022-09-01 16:14:46.599  INFO 32460 --- [nio-8080-exec-6] c.e.WebSocketDemo.service.MyWebSocket    : 收到客户端0消息：这是一个测试数据
1

再次打开 html 页面，这样就有两个 websocket 客户端，然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息：

MessageEvent {isTrusted: true, data: "这是一条测试广播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}
1

其他案例实现：
https://juejin.cn/post/7119744808217903135
https://juejin.cn/post/7041181976635637790