正文

springboot-websocket实现及原理

有营养的yyl  2022-04-06  371

关键词：

本文章包括websocket面试相关问题以及spring boot如何整合webSocket。

参考文档 https://blog.csdn.net/prayallforyou/article/details/53737901 、https://www.cnblogs.com/bianzy/p/5822426.html

　　webSocket是HTML5的一种新协议，它实现了服务端与客户端的全双工通信，建立在传输层，tcp协议之上，即浏览器与服务端需要先建立tcp协议，再发送webSocket连接建立请求。

　　webSocket的连接：客户端发送请求信息，服务端接受到请求并返回相应的信息。连接建立。客户端发送http请求时，通过 Upgrade:webSocket Connection:Upgrade 告知服务器需要建立的是webSocket连接，并且还会传递webSocket版本号，协议的字版本号，原始地址，主机地址等等。

　　webSocket相互通信的Header很小，大概只有2Bytes。

　　以下是基于spring boot及支持webScoket的高版本浏览器的配置过程。

一、pom.xml中引入webSocket组件

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

二、后台引入webSocket

　　要想让一个类处理webScoket的请求，需要两个东西：

　　① 类名上加webScoket请求拦截注释@ServerEndpoint(value="/***")

　　② 类需要继承org.springframework.web.socket.server.standard.ServerEndpointExporter，重写交互过程中各种情况下调用的方法（建立时、断开时、出错时、接收消息、发送消息）

　　针对②，一方面根据spring的IOC特性，需要反向代理，另一方面因为webSocket是一个功能而不仅仅是属于某个业务，所以应当在配置文件中声明。配置文件可以是xml文件，也可以是注释了@Configuration的类文件，根据个人喜好使用~，这里使用的是@Configuration。

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

　　使用@ServerEndpoint(value="/***") 时会自动注入返回类型为ServerEndpointExporter的bean。等同于继承了ServerEndpointExporter类。继承类后再重写onOpen、onClose、onMessage、onError方法，因为不是直接使用继承，所以方法的重写也需要使用注释，代码如下

package com.example.SpringBootTry.controller.webSocket;

import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

import org.springframework.stereotype.Component;

/**
 * 双工通信websocket工具类
 * @author wwl
 *
 */
@ServerEndpoint(value="/webSocket")
@Component
public class WebSocketUtil{
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;

    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<WebSocketUtil> webSocketSet = new CopyOnWriteArraySet<WebSocketUtil>();

    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;

    /**
     * 连接建立成功调用的方法*/
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //在线数加1
        System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
        try {
            sendMessage("您是第" + getOnlineCount() + "个双工通信的用户！");
        } catch (IOException e) {
            System.out.println("IO异常");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
        //发送消息
        try {
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 发生错误时调用
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("发生错误");
        error.printStackTrace();
    }

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


    /**
     * 群发自定义消息
     * */
    public static void sendInfo(String message) throws IOException {
        for (WebSocketUtil item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                continue;
            }
        }
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketUtil.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketUtil.onlineCount--;
    }
}

三、前端引入webSocket

　　使用 var websocket = new WebSocket("ws://localhost:8081/***") 建立webSocket连接，定义websocket的onerror、onopen、onmessage、onclose的属性，跟后台的四个方法相对应，完成合理的webSocket交互。

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
    <title>websocket测试页面</title>    
    <meta http-equiv="keywords" content="websocket,例子">
    <meta http-equiv="description" content="测试websocket">
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 
    <!--<link rel="stylesheet" type="text/css" href="./styles.css">-->
</head>
<body>
    Welcome<br/>
    <input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>
    <div id="message">
    </div>    
</body>
<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8081/webSocket");
    }else{
        alert('Not support 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>

以上为spring boot 整合webSocket的一些入门知识。有错误欢迎指正。

demo地址：https://github.com/ttjsndx/someDemo/blob/master/SpringBootTryDemo.rar

https原理及实现//tobecontinued

目录1.Https原理及过程2.Https服务端3.Https客户端1.Https原理及过程...2.Https服务端3.Https客户端3.1客户端请求的java实现查看详情

concurrenthashmap实现原理及源码分析

　　ConcurrentHashMap实现原理　　ConcurrentHashMap源码分析　　总结　　ConcurrentHashMap是Java并发包中提供的一个线程安全且高效的HashMap实现（若对HashMap的实现原理还不甚了解，可参考我的另一篇文章HashMap实现原理及源码分析），Concu... 查看详情

验证码的原理作用及实现

验证码的原理、作用及实现验证码原理分析及实现一、前言最近学习实现了验证码，首先附图效果如下：(简单说明：分别提交正确、错误的验证码及对应效果本文是图文结合说明) 二、验证码的作用验证码是目前大多网站所... 查看详情

dhcp服务实现原理及搭建

查看详情

javahashset工作原理及实现

1.概述ThisclassimplementstheSetinterface,backedbyahashtable(actuallyaHashMapinstance).Itmakesnoguaranteesastotheiterationorderoftheset;inparticular,itdoesnotguaranteethattheorderwillremainconstantoverti 查看详情

flume原理及代码实现

...aljason/p/6240122.html 最近想玩一下流计算，先看了flume的实现原理及源码源码可以去apache官网下载下面整理下flume的原理及代码实现：flume是一个实时数据收集工具，hadoop的生态圈之一，主要用来在分布式环境下各服务器节点做... 查看详情

promise原理及实现(代码片段)

Promise原理及实现1Promise核心逻辑实现2加入异步逻辑3then方法添加多次调用逻辑4链式调用then方法5Promise错误捕获6then方法参数设置为可选7实现Promise.all8实现Promise.resolve9实现Promise.race10实现finally方法11实现catch方法12全部代码展示1Pro... 查看详情

promise原理及实现(代码片段)

springmvc工作原理及源码解析dispatcherservlet实现原理及源码解析

1、DispatcherServlet处理流程从上一篇文章中SpringMVC原理图中我们可以看出：DispatcherServlet在SpringMVC框架中处于核心位置，它负责协调和组织不同组件完成请求处理并返回响应的工作。在分析DispatcherServlet源码之前，我们先来看一下... 查看详情

copyonwritearraylist实现原理及源码分析

...作无锁的ArrayList，写操作则通过创建底层数组的新副本来实现，是一种读写分离的并发策略，我们也可以称这种容器为"写时复制器"，Java并发包中类似的容器还有CopyOnWriteSet。本文会对CopyOnWriteArrayList的实现原理及源码进行分析... 查看详情

音频均衡器原理及实现(代码片段)

音频均衡器原理及实现文章目录音频均衡器原理及实现1.实现原理2.方案确定3.使用FIR滤波器4.使用IIR滤波器4.1IIR滤波器程序实现4.2EQ均衡器实现4.3主函数调用5.防溢出处理6.数据类型选择7.代码1.实现原理之前在数字信号处理系列的... 查看详情

音频均衡器原理及实现(代码片段)

unityshader------uv动画原理及简易实现(代码片段)

...ityShader】（三）------光照模型原理及漫反射和高光反射的实现【UnityShader】（四）------纹理之法线纹理、单张纹理及遮罩纹理的实现【UnityShader】（五）------透明效果之半透明效果的实现及原理【Unit 查看详情

排序算法原理及实现

算法一：直接插入排序算法实现原理：就是计算一个新元素是应该放在哪里？每次进来一个都会进行和原来顺序进行重新组合。代码实现：Javapublicint[]testInsertionSort(int[]data){//thismethordisveryeasy.for(inti=1;i<data.length;i++){inttemp=data[i];... 查看详情

springmvc工作原理及源码解析handlermapping和handleradapter实现原理及源码解析

1、HandlerMapping实现原理及源码解析在前面讲解SpringMVC工作流程的时候我们说过，前端控制器收到请求后会调⽤处理器映射器（HandlerMapping），处理器映射器根据请求Url找到具体的处理器（Handler），生成处理器对象及处理器拦截器... 查看详情

javahashmap工作原理及实现

...原理吗？equals()和hashCode()的都有什么作用？你知道hash的实现吗？为什么要这样实现？如果HashMap的大小超过了负载因子(loadfactor)定义的容量，怎么办？当我们执行下面的操作时：123456789101112HashMap<Strin 查看详情

javahashmap工作原理及实现

...原理吗？equals()和hashCode()的都有什么作用？你知道hash的实现吗？为什么要这样实现？如果HashMap的大小超过了负载因子(loadfactor)定义的容量，怎么办？当我们执行下面的操作时：HashMap<String,Integer>map= 查看详情

一致性hash算法原理，java实现，及用途

学习记录：一致性Hash算法原理及java实现：https://blog.csdn.net/suifeng629/article/details/81567777一致性Hash算法介绍，原理，及使用场景：https://blog.csdn.net/cbmljs/article/details/88021598纯转载，侵删查看详情