devbox
Monodyee
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Spring Boot 使用WebSocket、SockJS、STOMP实现消息功能（二）

作者：Monodyee | 2024-03-02 02:59:10

赞

踩

Spring Boot 使用WebSocket、SockJS、STOMP实现消息功能（二）

一、介绍

在我学习websocket期间，有两种实现手段。第一种是用原生的代码来实现websocket消息推送，第二种就是基于SocketJS+Stomp来实现的。这里主要讲一下第一种的实现：

（一）WebSocket简介
  WebSocket是一种通讯协议，通过单个TCP连接提供完全多工通讯管道。大白话就是：WebSocket协议相对于Http协议来说，它能在一段时间内一直保持连接，而Http协议是三次握手后就断开连接。WebSocket经常用于聊天室这种实时通讯场景。

  WebSocket协议地址相对于Http协议地址来说，Schema部分变了：Http地址：http://host:port/… ，而WebSocke地址：ws://host:port/…

（二）WebSocke API
  相关术语：

  • 端点（Endpoint）
  • 连接（Connection）
  • 对点（Peer）
  • 会话（Session）
  • 客户端端点、服务器端点

（三）端点生命周期

  • 打开连接

  Endpoint#onOpen(Session,EndpointConfig) ------编程
  @OnOpen ------注解

  • 关闭连接

  Endpoint#onClose(Session,CloseReason)
  @OnClose

  • 错误

  Endpoint#onError(Session,Throwable)
  @OnError

  • 发送消息

  @OnMessage（PS：无对应编程方法）

（四）会话（Sessions）

  • API：javax.websocket.Session
  • 接收消息：javax.websocket.MessageHandler
  • 发送消息：javax.websocket.RemoteEndpoint.Basic

（五）配置（Configuration）

  • 服务端配置（javax.websocket.ServerEndpointConfig）
  1. URI 映射
  2. 子协议协商
  3. 扩展点修改
  4. Origin检测
  5. 握手修改
  6. 自定义端点创建
  • 客户端配置（javax.websocket.ClientEndpointConfig）
  1. 子协议
  2. 扩展点
  3. 客户端配置修改

该demo主要用来学习用可以体验这种方式实现的简单功能，能更好的了解websocket的底层实现。

二、环境要求和关键技术

三、maven依赖

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.  
  7.     <groupId>web</groupId>
  8.     <artifactId>socket-demo</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.  
  11.     <parent>
  12.         <groupId>org.springframework.boot</groupId>
  13.         <artifactId>spring-boot-starter-parent</artifactId>
  14.         <version>2.0.2.RELEASE</version>
  15.         <relativePath/>
  16.     </parent>
  17.  
  18.     <dependencyManagement>
  19.         <dependencies>
  20.             <dependency>
  21.                 <groupId>org.springframework.cloud</groupId>
  22.                 <artifactId>spring-cloud-dependencies</artifactId>
  23.                 <version>Finchley.RC2</version>
  24.                 <type>pom</type>
  25.                 <scope>import</scope>
  26.             </dependency>
  27.         </dependencies>
  28.     </dependencyManagement>
  29.     <properties>
  30.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  31.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  32.         <java.version>1.8</java.version>
  33.         <spring.cloud.version>Finchley.RC2</spring.cloud.version>
  34.         <fastjson.version>1.2.47</fastjson.version>
  35.         <commons-lang.version>2.6</commons-lang.version>
  36.         <mybatis.version>1.3.2</mybatis.version>
  37.         <mysql.version>5.1.46</mysql.version>
  38.         <druid.version>1.1.10</druid.version>
  39.         <lombok.version>1.16.20</lombok.version>
  40.         <spring.security.version>4.1.0.RELEASE</spring.security.version>
  41.         <log4j.version>1.2.16</log4j.version>
  42.     </properties>
  43.  
  44.     <dependencies>
  45.  
  46.         <dependency>
  47.             <groupId>org.springframework.boot</groupId>
  48.             <artifactId>spring-boot-starter-web</artifactId>
  49.         </dependency>
  50.         <dependency>
  51.             <groupId>org.springframework.boot</groupId>
  52.             <artifactId>spring-boot-starter-test</artifactId>
  53.             <scope>test</scope>
  54.         </dependency>
  55.         <dependency>
  56.             <groupId>com.alibaba</groupId>
  57.             <artifactId>fastjson</artifactId>
  58.             <version>${fastjson.version}</version>
  59.         </dependency>
  60.         <dependency>
  61.             <groupId>commons-lang</groupId>
  62.             <artifactId>commons-lang</artifactId>
  63.             <version>${commons-lang.version}</version>
  64.         </dependency>
  65.  
  66.         <dependency>
  67.             <groupId>mysql</groupId>
  68.             <artifactId>mysql-connector-java</artifactId>
  69.             <version>${mysql.version}</version>
  70.         </dependency>
  71.         <dependency>
  72.             <groupId>com.alibaba</groupId>
  73.             <artifactId>druid</artifactId>
  74.             <version>${druid.version}</version>
  75.         </dependency>
  76.         <dependency>
  77.             <groupId>org.projectlombok</groupId>
  78.             <artifactId>lombok</artifactId>
  79.             <version>${lombok.version}</version>
  80.             <scope>provided</scope>
  81.         </dependency>
  82.  
  83.         <dependency>
  84.             <groupId>log4j</groupId>
  85.             <artifactId>log4j</artifactId>
  86.             <version>${log4j.version}</version>
  87.             <scope>compile</scope>
  88.         </dependency>
  89.  
  90.         <dependency>
  91.             <groupId>org.springframework.boot</groupId>
  92.             <artifactId>spring-boot-starter-websocket</artifactId>
  93.         </dependency>
  94.  
  95.         <dependency>
  96.             <groupId>org.springframework.boot</groupId>
  97.             <artifactId>spring-boot-starter-thymeleaf</artifactId>
  98.         </dependency>
  99.  
  100.  
  101.     </dependencies>
  102.     <build>
  103.         <plugins>
  104.             <plugin>
  105.                 <groupId>org.springframework.boot</groupId>
  106.                 <artifactId>spring-boot-maven-plugin</artifactId>
  107.             </plugin>
  108.         </plugins>
  109.     </build>
  110.     <repositories>
  111.         <repository>
  112.             <id>spring-milestones</id>
  113.             <name>Spring Milestones</name>
  114.             <url>https://repo.spring.io/libs-milestone</url>
  115.             <snapshots>
  116.                 <enabled>false</enabled>
  117.             </snapshots>
  118.         </repository>
  119.     </repositories>
  120. </project>

启动类SockerApplication.java

  1. package com.wyc;
  2.  
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5.  
  6. @SpringBootApplication
  7. public class SockerApplication {
  8.  
  9.     public static void main(String[] args) {
  10.         SpringApplication.run(SockerApplication.class,args);
  11.     }
  12. }

 端点配置WebSocketConfig.java

  1. package com.wyc.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
  6. import org.springframework.web.socket.server.standard.ServerEndpointExporter;
  7.  
  8. @Configuration
  9. public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
  10.  
  11.     @Bean
  12.     public ServerEndpointExporter serverEndpointExporter(){
  13.         return new ServerEndpointExporter();
  14.     }
  15. }

CheckCenterController.java 

  1. package com.wyc.controller;
  2.  
  3.  
  4. import com.wyc.util.WebSocketServer;
  5. import org.springframework.scheduling.annotation.Scheduled;
  6. import org.springframework.stereotype.Controller;
  7. import org.springframework.web.bind.annotation.*;
  8. import org.springframework.web.servlet.ModelAndView;
  9.  
  10. import java.io.IOException;
  11.  
  12. /**
  13.  * 消息推送
  14.  *
  15.  * @author :WYC
  16.  * @create 2018-07-11 14:12
  17.  **/
  18. @Controller
  19. @RequestMapping("/checkcenter")
  20. public class CheckCenterController {
  21.  
  22.     @RequestMapping("/fllindex")
  23.     public String getIndex(){
  24.         System.out.println("主页面");
  25.         return "socket";
  26.     }
  27.     //页面请求
  28.     @GetMapping("/socket/{cid}")
  29.     public ModelAndView socket(@PathVariable String cid) {
  30.         ModelAndView mav=new ModelAndView("/socket");
  31.         mav.addObject("cid", cid);
  32.         return mav;
  33.     }
  34.     //推送数据接口
  35.     @ResponseBody
  36.     @RequestMapping("/socket/push/{cid}")
  37.     public String pushToWeb(@PathVariable String cid,String message) {
  38.         try {
  39.             WebSocketServer.sendInfo(message,cid);
  40.         } catch (IOException e) {
  41.             e.printStackTrace();
  42.             return cid+"#"+e.getMessage();
  43.         }
  44.         return cid;
  45.     }
  46. }

WebSocketServer.java 

  1. package com.wyc.util;
  2.  
  3. import org.apache.juli.logging.Log;
  4. import org.apache.juli.logging.LogFactory;
  5. import org.springframework.stereotype.Component;
  6.  
  7. import javax.websocket.*;
  8. import javax.websocket.server.PathParam;
  9. import javax.websocket.server.ServerEndpoint;
  10. import java.io.IOException;
  11. import java.util.concurrent.CopyOnWriteArraySet;
  12.  
  13. /**
  14.  * WebSocket服务类
  15.  *
  16.  * @author :WYC
  17.  * @create 2018-07-11 13:54
  18.  **/
  19. @ServerEndpoint("/websocket/{sid}")
  20. @Component
  21. public class WebSocketServer {
  22.     static Log log=LogFactory.getLog(WebSocketServer.class);
  23.     //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
  24.     private static int onlineCount = 0;
  25.     //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
  26.     private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
  27.  
  28.     //与某个客户端的连接会话，需要通过它来给客户端发送数据
  29.     private Session session;
  30.  
  31.     //接收sid
  32.     private String sid="";
  33.     /**
  34.      * 连接建立成功调用的方法*/
  35.     @OnOpen
  36.     public void onOpen(Session session,@PathParam("sid") String sid) {
  37.         this.session = session;
  38.         webSocketSet.add(this); //加入set中
  39.         addOnlineCount(); //在线数加1
  40.         log.info("有新窗口开始监听:"+sid+",当前在线人数为" + getOnlineCount());
  41.         this.sid=sid;
  42.         try {
  43.             sendMessage("连接成功");
  44.         } catch (IOException e) {
  45.             log.error("websocket IO异常");
  46.         }
  47.     }
  48.  
  49.     /**
  50.      * 连接关闭调用的方法
  51.      */
  52.     @OnClose
  53.     public void onClose() {
  54.         webSocketSet.remove(this); //从set中删除
  55.         subOnlineCount(); //在线数减1
  56.         log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
  57.     }
  58.  
  59.     /**
  60.      * 收到客户端消息后调用的方法
  61.      *
  62.      * @param message 客户端发送过来的消息*/
  63.     @OnMessage
  64.     public void onMessage(String message, Session session) {
  65.         log.info("收到来自窗口"+sid+"的信息:"+message);
  66. //群发消息
  67.         for (WebSocketServer item : webSocketSet) {
  68.             try {
  69.                 while (true){
  70.                     item.sendMessage(message);
  71.                 }
  72.  
  73.             } catch (IOException e) {
  74.                 e.printStackTrace();
  75.             }
  76.         }
  77.     }
  78.  
  79.     /**
  80.      *
  81.      * @param session
  82.      * @param error
  83.      */
  84.     @OnError
  85.     public void onError(Session session, Throwable error) {
  86.         log.error("发生错误");
  87.         error.printStackTrace();
  88.     }
  89.     /**
  90.      * 实现服务器主动推送
  91.      */
  92.     public void sendMessage(String message) throws IOException {
  93.         this.session.getBasicRemote().sendText(message);
  94.     }
  95.  
  96.  
  97.     /**
  98.      * 群发自定义消息
  99.      * */
  100.     public static void sendInfo(String message,@PathParam("sid") String sid) throws IOException {
  101.         log.info("推送消息到窗口"+sid+"，推送内容:"+message);
  102.         for (WebSocketServer item : webSocketSet) {
  103.             try {
  104. //这里可以设定只推送给这个sid的，为null则全部推送
  105.                 if(sid==null) {
  106.                     item.sendMessage(message);
  107.                 }else if(item.sid.equals(sid)){
  108.                     item.sendMessage(message);
  109.                 }
  110.             } catch (IOException e) {
  111.                 continue;
  112.             }
  113.         }
  114.     }
  115.  
  116.     public static synchronized int getOnlineCount() {
  117.         return onlineCount;
  118.     }
  119.  
  120.     public static synchronized void addOnlineCount() {
  121.         WebSocketServer.onlineCount++;
  122.     }
  123.  
  124.     public static synchronized void subOnlineCount() {
  125.         WebSocketServer.onlineCount--;
  126.     }
  127. }

前端页面socket.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.     <base href="<%=basePath%>">
  5.  
  6.     <meta charset="UTF-8">
  7.     <meta name="viewport"
  8.           content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  9.     <title>弹窗</title>
  10.     <script src="https://cdn.bootcss.com/jquery/3.4.1/jquery.min.js"></script>
  11.   <!--  <script type="text/javascript" src="../js/FileSaver.js"></script>-->
  12. </head>
  13.  
  14. <body>
  15. <h2>33</h2>
  16. <input id="start">
  17. <input id="message">
  18. <iframe id="my_iframe" style="display:none;"></iframe>
  19. <script type="application/javascript">
  20.     var socket;
  21.     if(typeof(WebSocket) == "undefined") {
  22.         console.log("您的浏览器不支持WebSocket");
  23.     }else{
  24.         console.log("您的浏览器支持WebSocket");
  25. //实现化WebSocket对象，指定要连接的服务器地址与端口 建立连接
  26. //等同于socket = new WebSocket("ws://localhost:8083/checkcentersys/websocket/20");
  27. //socket = new WebSocket("http://localhost:8080/websocket/${cid}".replace("http","ws"));
  28.         socket = new WebSocket("ws://localhost:8080/websocket/33");
  29. //打开事件
  30.         socket.onopen = function() {
  31.             console.log("Socket 已打开");
  32.             $("#start").val("Socket 已打开")
  33. //socket.send("这是来自客户端的消息" + location.href + new Date());
  34.         };
  35. //获得消息事件
  36.         socket.onmessage = function(msg) {
  37.             console.log(msg.data);
  38.             $("#message").val(msg.data)
  39. //发现消息进入 开始处理前端触发逻辑
  40.         };
  41. //关闭事件
  42.         socket.onclose = function() {
  43.             console.log("Socket已关闭");
  44.             $("#close").val("Socket已关闭")
  45.         };
  46. //发生了错误事件
  47.         socket.onerror = function() {
  48.             alert("Socket发生了错误");
  49. //此时可以尝试刷新页面
  50.         }
  51. //离开页面时，关闭socket
  52. //jquery1.8中已经被废弃，3.0中已经移除
  53. // $(window).unload(function(){
  54. // socket.close();
  55. //});
  56.     }
  57. </script>
  58.  
  59. </body>
  60. </html>

github源码：https://github.com/wangyuanchen/socketdemo

 

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Monodyee/article/detail/178663
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号