脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot集成WebSocket

SpringBoot集成WebSocket的两种方式(JDK内置版和Spring封装版)

 更新时间：2023年06月14日 15:36:31   作者：haiyangyiba  
这篇文章主要介绍了SpringBoot集成WebSocket的两种方式,这两种方式为JDK内置版和Spring封装版,本文结合示例代码给大家介绍的非常详细，需要的朋友可以参考下

本站在2014年4月时曾全面的学习HTML5的技术，特写过HTML5的WebSocket示例，当时使用的Servlet3.0规范中的API，需要Tomcat7的支持（貌似在Tomcat6的后期维护版本也增加了WebSocket的支持），早在当初该示例还是本站的一个特色功能，好多来找我要源码的呢。时隔多年再来使用SpringBoot架构来体验一下集成WebSocket的实现，经过一番资料的百科大概有找到使用两种方式的实现，我分别对它们进行了实践，所以我称这两种方式为JDK内置版和Spring封装版。

1.JDK内置版

主要是使用javax.websocket包下的注解进行集成，主要有：ServerEndpoint、OnOpen、OnMessage、OnClose、OnError相关的类和注解来集成，整体上比较简单，都是基于注解定义的方法来声明的，参考如下代码所示：

JdkWebSocket

package cn.chendd.websocket.jdk;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
/**
 * websocket实现
 *
 * @date 2023/6/2 21:02
 */
@Component
@ServerEndpoint(value = "/websocket/jdk")
public class JdkWebSocket {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("WebSocketConfig.onOpen");
    }
    @OnMessage
    public void onMessage(Session session , String message) {
        System.out.println("WebSocketConfig.onMessage-->" + session + "--->" + message);
    }
    @OnClose
    public void onClose() {
        System.out.println("WebSocketConfig.onClose");
    }
    @OnError
    public void onError(Session sesison , Throwable throwable) {
        System.out.println("WebSocketConfig.onError-->" + sesison + "--->" + throwable);
    }
}

JdkWebSocketConfig

package cn.chendd.websocket.jdk;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
 * @author chendd
 * @date 2023/6/2 21:15
 */
@Configuration
public class JdkWebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

运行结果

2.Spring封装版

Spring封装版本有对于消息类型进行封装，提供了更加全面的WebSocket方面的API，值得深入分析。

SpringWebSocketHandler

package cn.chendd.websocket.spring;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.*;
import org.springframework.web.socket.handler.TextWebSocketHandler;
/**
 * SpringWebSocketHandler
 *
 * @author chendd
 * @date 2023/6/2 22:08
 */
@Component
public class SpringWebSocketHandler extends TextWebSocketHandler {
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        super.afterConnectionEstablished(session);
        System.out.println("SpringWebSocketHandler.afterConnectionEstablished");
    }
    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        super.handleMessage(session, message);
        System.out.println("SpringWebSocketHandler.handleMessage");
    }
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        super.handleTextMessage(session, message);
        System.out.println("SpringWebSocketHandler.handleTextMessage");
    }
    @Override
    protected void handlePongMessage(WebSocketSession session, PongMessage message) throws Exception {
        super.handlePongMessage(session, message);
        System.out.println("SpringWebSocketHandler.handlePongMessage");
    }
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        super.handleTransportError(session, exception);
        System.out.println("SpringWebSocketHandler.handleTransportError");
    }
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        super.afterConnectionClosed(session, status);
        System.out.println("SpringWebSocketHandler.afterConnectionClosed");
    }
    @Override
    public boolean supportsPartialMessages() {
        System.out.println("SpringWebSocketHandler.supportsPartialMessages");
        return super.supportsPartialMessages();
    }
}

SpringWebSocketConfig

package cn.chendd.websocket.spring;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import javax.annotation.Resource;
/**
 * SpringWebSocketConfig
 *
 * @author chendd
 * @date 2023/6/2 22:11
 */
@Configuration
@EnableWebSocket
public class SpringWebSocketConfig implements WebSocketConfigurer {
    @Resource
    private SpringWebSocketHandler springWebSocketHandler;
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(springWebSocketHandler , "/websocket/spring").setAllowedOrigins("*");
    }
}

运行结果

3.其它说明

（1）本次示例重点在于服务端Java代码的示例，未编写前端示例，可在下方的项目源码中参见前端的HTML集成，或者是使用本例中使用的在线WebSocket测试的页面地址进行在线验证，右键查看其源代码也是原生的HTML5规范的相关代码；

（2）提供了JDK的内置版本和Spring的封装版本，个人推荐使用Spring的封装版，毕竟JDK的注解不够清晰的描述出被注解的方法的方法具体参数，而Spring封装版本有对于消息类型进行封装；

（3）代码比较简单，结合前文的参考链接中的全量代码也包含在内，代码包结构如下：

参考文章链接：一个猜你所选的小程序随写

到此这篇关于SpringBoot集成WebSocket的两种方式的文章就介绍到这了,更多相关SpringBoot集成WebSocket内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • SpringBoot应用程序启动监听功能的常见方法

    SpringBoot应用程序启动监听功能的常见方法

    应用启动监听在 Spring Boot 和其他框架中扮演着重要的角色,它们的主要作用是在应用启动或关闭时触发特定的操作或任务,本文给大家介绍了SpringBoot应用程序启动监听功能的常见方法,需要的朋友可以参考下
    2024-05-05
  • 四步教你完美解决IDEA运行maven项目时报错：java: 错误: 不支持发行版本 5

    四步教你完美解决IDEA运行maven项目时报错：java: 错误: 不支持发行版本 5

    这篇文章主要介绍了四步教你完美解决IDEA运行maven项目时报错：java: 错误: 不支持发行版本 5的相关资料,文中通过图文将解决的办法介绍的非常详细,需要的朋友可以参考下
    2025-09-09
  • 使用BigDecimal去掉小数点后无用的0

    使用BigDecimal去掉小数点后无用的0

    这篇文章主要介绍了使用BigDecimal去掉小数点后无用的0操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-08-08
  • java一个数据整理的方法代码实例

    java一个数据整理的方法代码实例

    这篇文章主要介绍了java一个数据整理的方法代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • 详解Java中restTemplate的使用

    详解Java中restTemplate的使用

    这篇文章主要为大家详细介绍了Java中restTemplate用法的相关资料，文中的示例代码讲解详细，对我们学习Java有一定的帮助，需要的可以参考一下
    2022-11-11
  • Spring中RedisTemplate使用方法详解

    Spring中RedisTemplate使用方法详解

    Spring封装了一个比较强大的模板,也就是redisTemplate,方便在开发的时候操作Redis缓存,这篇文章主要给大家介绍了关于Java中RedisTemplate使用方法的相关资料,需要的朋友可以参考下
    2023-12-12
  • Java AQS 原理与 ReentrantLock 实现方法

    Java AQS 原理与 ReentrantLock 实现方法

    AQS 的作用是解决同步器的实现问题,它将复杂的同步器实现分解为简单的框架方法,开发者只需要实现少量特定的方法就能快速构建出可靠的同步器,这篇文章主要介绍Java AQS原理与ReentrantLock实现,需要的朋友可以参考下
    2025-03-03
  • HandlerMapping之RequestMappingHandlerMapping作用详解

    HandlerMapping之RequestMappingHandlerMapping作用详解

    这篇文章主要介绍了HandlerMapping之RequestMappingHandlerMapping作用详解,HandlerMapping是用来寻找Handler的,并不与Handler的类型或者实现绑定,而是根据需要定义的,那么为什么要单独给@RequestMapping实现一个HandlerMapping,需要的朋友可以参考下
    2023-10-10
  • Java中并行执行任务的多种方式

    Java中并行执行任务的多种方式

    在Java编程中,经常会遇到需要并行执行任务的情况,特别是在处理大量数据或者需要异步处理的场景下,本文将介绍几种常用的并行执行任务的方式,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2024-04-04
  • SpringBoot静态资源与首页配置实现原理深入分析

    SpringBoot静态资源与首页配置实现原理深入分析

    最近在做SpringBoot项目的时候遇到了“白页”问题，通过查资料对SpringBoot访问静态资源做了总结，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
    2022-10-10

最新评论