SpringBoot之WebSocket和SSE

时间:2022-06-26
本文章向大家介绍SpringBoot之WebSocket和SSE,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

前言: 传统的网页都是浏览器向服务器“查询”数据,但是很多场合,最有效的方式是服务器向浏览器“发送”数据。比如,每当收到新的电子邮件,服务器就向浏览器发送一个“通知”,这要比浏览器按时向服务器查询(polling)更有效率。

WebSocket protocol 是HTML5一种新的协议。它实现了浏览器与服务器全双工通信(full-duplex)。一开始的握手需要借助HTTP请求完成。浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。在此WebSocket 协议中,为我们实现即时服务带来了两大好处。

服务器发送事件(Server-Sent Events,简称SSE)就是为了解决这个问题,而提出的一种新API,部署在EventSource对象上。目前,除了IE,其他主流浏览器都支持。

简单说,所谓SSE,就是浏览器向服务器发送一个HTTP请求,然后服务器不断单向地向浏览器推送“信息”(message)。这种信息在格式上很简单,就是“信息”加上前缀“data: ”,然后以“nn”结尾。

1.导入相关jar包

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2.注册webSocket的Bean

package com.example;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter (){
        return new ServerEndpointExporter();
    }
}

3.编写webSocket服务端代码

package com.example;

import org.springframework.stereotype.Component;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

@ServerEndpoint("/sendMessage")
@Component
public class SendMessage {

    private static int onlineCount = 0;

    //当我们往一个容器添加元素的时候,不直接往当前容器添加,而是先将当前容器进行Copy,复制出一个新的容器,
    //然后新的容器里添加元素,添加完元素之后,再将原容器的引用指向新的容器. 实现读写分离
    private static CopyOnWriteArraySet<SendMessage> webSocketSet = new CopyOnWriteArraySet<>();

    private Session session;

    /**
     * 创建一个socket会话时调用的方法
     * @param session
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this);
        System.out.println("Socket当前链接数" + webSocketSet.size());
    }

    /**
     * 关闭一个socket会话时调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);
        System.out.println("Socket当前链接数" + webSocketSet.size());
    }

    /**
     * socket通讯方法
     * @param message
     * @param session
     * @throws IOException
     */
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("来自客户端的消息:" + message);
        //循环set里的当前链接的socket发送信息
        for (SendMessage item : webSocketSet) {
            item.sendMessage(message);
        }
        System.out.println(session.getRequestURI());

    }

    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

}

4.编写html的js连接websocket

<!DOCTYPE HTML>  
<html>  
<head>  
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>socket案例</title>  
</head>  
  
<body>  
Welcome<br/>  
<input id="text" type="text"/>  
<button onclick="send()">发送信息</button>  
<button onclick="closeWebSocket()">断开</button>  
<div id="message">  
</div>  
</body>  
  
<script type="text/javascript">  
    var websocket = null;  
  
    //判断当前浏览器是否支持WebSocket  
    if ('WebSocket' in window) {  
        websocket = new WebSocket("ws://localhost:8080/sendMessage");  
    }  
    else {  
        alert('当前浏览器支持webSocket,请更新最新的浏览器')  
    }  
  
    //连接发生错误的回调方法  
    websocket.onerror = function () {  
        setMessageInnerHTML("error");  
    };  
  
    //连接成功建立的回调方法  
    websocket.onopen = function (event) {  
        setMessageInnerHTML("open");  
    }  
  
    //接收到消息的回调方法  
    websocket.onmessage = function (event) {  
        setMessageInnerHTML(event.data);  
    }  
  
    //连接关闭的回调方法  
    websocket.onclose = function () {  
        setMessageInnerHTML("close");  
    }  
  
    //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。  
    window.onbeforeunload = function () {  
        websocket.close();  
    }  
  
    //将消息显示在网页上  
    function setMessageInnerHTML(innerHTML) {  
        document.getElementById('message').innerHTML += innerHTML + '<br/>';  
    }  
  
    //关闭连接  
    function closeWebSocket() {  
        websocket.close();  
    }  
  
    //发送消息  
    function send() {  
        var message = document.getElementById('text').value;  
        websocket.send(message);  
    }  
</script>  
</html>  

5.创建使用SSE后台服务

  @RequestMapping(value = "/abc", produces = "text/event-stream")
  @ResponseBody
    public String test() throws InterruptedException {
        Thread.sleep(1000);
        return "data: "+new Date().toLocaleString()+"nn";
    }

6.HTML5网页使用

 if (!!window.EventSource) {
         var source=new EventSource('http://localhost:8080/abc');
         source.addEventListener('message',function(e){
         	setMessageInnerHTML(e.data); 
         });
         source.addEventListener('open',function(e){
         	//setMessageInnerHTML("连接被打开");
         },false);
    };