【十四】springboot整合WebSocket

时间:2024-11-15 17:15:52

互相交流入口地址 

整体目录:

【一】springboot整合swagger

【二】springboot整合自定义swagger

【三】springboot整合token

【四】springboot整合mybatis-plus

【五】springboot整合mybatis-plus

【六】springboot整合redis

【七】springboot整合AOP实现日志操作

【八】springboot整合定时任务

【九】springboot整合redis实现启动服务时热点数据保存在全局和缓存

【十】springboot整合quartz实现定时任务优化

【十一】springboot整合异步调用并获取返回值

【十二】springboot整合WebService

【十三】springboot整合WebService关于传参数

【十四】springboot整合WebSocket

【十五】springboot整合WebSocket实现聊天室

【十六】RabbitMQ基础篇(下载安装并基础使用,内含各种坑问题)

【十七】RabbitMQ基础篇(延迟队列和死信队列实战)

【十八】springboot实现自定义全局异常处理

【十九】初学Kafka并实战整合SpringCloudStream进行使用

【二十】springboot整合ElasticSearch实战(万字篇)

【二十一】springboot整合过滤器实战

【二十二】springboot整合拦截器实战并对比过滤器

【二十三】springboot整合activiti7(1)实战演示篇

【二十四】springboot整合spring事务详解以及实战

【二十五】springboot使用EasyExcel和线程池实现多线程导入Excel数据

【二十六】springboot整合jedis和redisson布隆过滤器处理缓存穿透

【二十七】springboot实现多线程事务处理

【二十八】springboot之threadLocal参数解析器实现session一样保存当前登录功能 

【二十九】springboot整合logback实现日志管理

【三十】springboot项目上高并发解决示例

目录

第一步:导入依赖

第二步:编写WebSocketConfig配置类

第三步:编写WebSocket类

第四步:改造控制器

第五步:编写前端代码

第六步:演示

第七步:改造


        介绍:接下来我会把学习阶段学到的框架等知识点进行整合,每一次整合是在前一章的基础上进行的,所以后面的整合不会重复放前面的代码。每次的demo我放在结尾,本次是接着上一章的内容延续的,只增加新增的或者修改的代码。

        最终效果展示:

        在上一章对WebService进行了整合,本章将对WebSocket进行整合,后面会写两个小demo,本章将写一个进度条demo,后面会写一个聊天室demo。

        WebSocket:用我自己的话来描述就是,正常的前后端使用是前端写一个请求,请求接口,每次想要某一个接口的数据,都需要去请求他一次,这是正常的流程,但是使用WebSocket,可以实现一次请求之后,前端跟该接口的连接关系一直都在,后端接口可以主动返回数据到前端。

        下面开始展示一步一步实现这个demo

        还是先展示一下目录结构,如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_17,color_FFFFFF,t_70,g_se,x_16

        框选出来的部分是这章新增的或者修改到的部分。

第一步:导入依赖

<dependency>
     <groupId></groupId>
     <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

        相比前面的章节,新增了websocket的依赖。

编写后端:

第二步:编写WebSocketConfig配置类

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16

第三步:编写WebSocket类

//注册成组件
@Component
//定义websocket服务器端,它的功能主要是将目前的类定义成一个websocket服务器端。注解的值将被用于监听用户连接的终端访问URL地址
@ServerEndpoint("/websocket")
//如果不想每次都写private  final Logger logger = (当前类名.class); 可以用注解@Slf4j;可以直接调用
@Slf4j
public class WebSocket {

    //实例一个session,这个session是websocket的session
    private Session session;

    //存放websocket的集合(本次demo不会用到,聊天室的demo会用到)
    private static CopyOnWriteArraySet<WebSocket> webSocketSet = new CopyOnWriteArraySet<>();

    //前端请求时一个websocket时
    @OnOpen
    public void onOpen(Session session) {
         = session;
        (this);
        ("【websocket消息】有新的连接, 总数:{}", ());
    }

    //前端关闭时一个websocket时
    @OnClose
    public void onClose() {
        (this);
        ("【websocket消息】连接断开, 总数:{}", ());
    }

    //前端向后端发送消息
    @OnMessage
    public void onMessage(String message) {
        ("【websocket消息】收到客户端发来的消息:{}", message);
    }

    //新增一个方法用于主动向客户端发送消息
    public static void sendMessage(String message) {
        for (WebSocket webSocket: webSocketSet) {
            ("【websocket消息】广播消息, message={}", message);
            try {
                ().sendText(message);
            } catch (Exception e) {
                ();
            }
        }
    }
}

         有关方法和参数的描述代码里有简单写到。

第四步:改造控制器

        编写一个接口方法,调用websocket的sendMessage方法,如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16

        我是写在以前的codeController里面的,先注入websocket,再新增一个接口方法,如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16

        ApiOperation注解是整合的swagger后的注解,没有跟着前面的章节整合不需要加,为了显示效果,我增加了一个线程睡眠0.1秒再累加,返回前端。

        注意:若前面跟着一起整合了token,直接访问该接口不行,要么请求时带上登录接口返回的token,要么放行该接口,为了简单,此处我直接放行的该接口,若未整合token,则不需要管,放行方式如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16

        在该配置类下面的该方法增加如图所示(未整合token不需要管)。

        到此后端完毕,开始编写前端代码。

        编写前端:

第五步:编写前端代码

<!DOCTYPE HTML>
<html>
<head>
    <title>进度条</title>
	<link rel="stylesheet" href="/bootstrap/4.3.1/css/" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
	<script src="/jquery-3.3." integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
	<script src="/ajax/libs//1.14.7/umd/" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
	<script src="/bootstrap/4.3.1/js/" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
	<script src="/jquery-3.1."></script>
</head>
 
<body>
   <div class="progress" style="width: 60%;height: 60px;margin: 0 auto;margin-top: 150px;">
     <div class="progress-bar" role="progressbar" style="width: 25%" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100"></div>
   </div>
   <div ></div>
   <input type="button" name=""  value="开始" />
</body>
 
<script type="text/javascript">
    var websocket = null;
 
    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8089/websocket");
    }else{
        alert('Not support websocket')
    }
 
    //连接发生错误的回调方法
     = function(){
        setMessageInnerHTML("发生错误");
    };
 
    //连接成功建立的回调方法
     = function(event){
        setMessageInnerHTML("建立连接");
    }
 
    //接收到消息的回调方法
     = function(event){
		()
        // setMessageInnerHTML();
		$(".progress-bar").attr("style","width:"++"%")
    }
 
    //连接关闭的回调方法
     = function(){
        setMessageInnerHTML("关闭连接");
    }
 
    //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
     = function(){
		alert("已关闭连接");
        ();
    }
 
    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML){
        ('message').innerHTML += innerHTML + '<br/>';
    }
 
    //关闭连接
    function closeWebSocket(){
		alert("已关闭连接");
        ();
    }
	//开始
	$("#btn").click(function(){
		$.ajax({
			url: "http://localhost:8089/codeController/jinDuTiao",
			type:'post',
			success: function(HTML) {//返回页面内容
				 (HTML);
				}
			});
	})
</script>
</html>

解释:

1、

var websocket = null;
 
    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8089/websocket");
    }else{
        alert('Not support websocket')
    }

首先建立websocket连接。

注意:此处的地址的ws://是固定写法,后面加上你的ip+端口+WebSocket的ServerEndpoint注解配置的路径。

2、

//连接发生错误的回调方法
    = function(){
        setMessageInnerHTML("发生错误");
    };
 
    //连接成功建立的回调方法
    = function(event){
        setMessageInnerHTML("建立连接");
    }
 
    //接收到消息的回调方法
    = function(event){
        ()
        // setMessageInnerHTML();
        $(".progress-bar").attr("style","width:"++"%")
    }
 
    //连接关闭的回调方法
    = function(){
        setMessageInnerHTML("关闭连接");
    }

都是websocket的固定写法,几个回调函数。

3、

//开始
    $("#btn").click(function(){
        $.ajax({
            url: "http://localhost:8089/codeController/jinDuTiao",
            type:'post',
            success: function(HTML) {//返回页面内容
                 (HTML);
                }
            });
    })

开始按钮,开始请求接口。

        注意:此处为了样式好看点,我导入了bootstrap。运行服务,打开网页,会自动建立websocket连接,点击开始。

第六步:演示

第七步:改造

        为了体现后端主动向服务器传数据,新增一个接口,如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16

        将上面那个接口改成新增成一个定时执行的,会发现,不点击前端的开始按钮,也会有效果,说明后端可以主动向客户端发送数据。

到此,整合完毕。

本期整合到此完毕,接下来会继续更新加强整合,尽情期待。

客户端访问地址:http://localhost:8090/或者http://localhost:8090/