SpringBoot整合WebSocket

本文详细介绍了在SpringBoot项目中集成WebSocket的步骤,包括创建Maven项目、配置WebSocket服务、编写客户端、设置WebSocket处理器和配置类,以及实现连接拦截器进行权限验证,并提供了测试方法。

目录

前言

新建一个Maven项目

实现websocket服务

编写客户端

创建WebSocket处理器MyHandler

创建WebSocketconfig配置类

编写启动类

添加拦截器

测试


 

前言

 

本篇讲解了如何在springboot项目中使用websocket,并且通过拦截器拦截websocket请求。

 

 

新建一个Maven项目

 

之后我们会把服务器端websocket的信息写在java包中,我们把客户端浏览器的请求信息写在webapp包中

 

 

导入maven依赖

这里需要注意,项目的打包方式必须是war包,并且由于springboot已经集成了tomcat,所有你不用单独引入tomcat,这里我把tomcat的包给注释了。

<groupId>cn.itcast.websocket</groupId>
    <artifactId>itcast-websocket</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <!--<dependency>-->
            <!--<groupId>javax</groupId>-->
            <!--<artifactId>javaee-api</artifactId>-->
            <!--<version>7.0</version>-->
            <!--<scope>provided</scope>-->
        <!--</dependency>-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- java编译插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <!-- 配置Tomcat插件 -->
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <port>8082</port>
                    <path>/</path>
                </co
### Spring Boot 整合 WebSocket 示例教程 在 Spring Boot 中整合 WebSocket 可以实现客户端与服务端的实时通信。以下是一个完整的示例,涵盖依赖配置、WebSocket 配置类以及处理程序的实现。 #### 1. 添加依赖 首先,在项目的 `build.gradle` 文件中添加 WebSocket 相关的依赖项: ```groovy dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' implementation 'org.springframework.boot:spring-boot-starter-websocket' } ``` 上述代码片段引入了 Spring Boot 的 WebSocket 支持模块[^1]。 #### 2. 创建 WebSocket 配置类 创建一个配置类来启用 WebSocket 支持,并注册 WebSocket 处理器。以下是一个简单的配置类示例: ```java 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; @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(new MyWebSocketHandler(), "/ws") .setAllowedOrigins("*"); // 允许跨域访问 } } ``` 上述代码通过 `registerWebSocketHandlers` 方法注册了一个 WebSocket 处理器,并指定了 `/ws` 作为 WebSocket 连接的 URL 路径[^3]。 #### 3. 实现 WebSocket 处理器 接下来,实现一个自定义的 WebSocket 处理器来处理消息和事件。以下是一个简单的处理器示例: ```java import org.springframework.web.socket.TextMessage; import org.springframework.web.socket.WebSocketSession; import org.springframework.web.socket.handler.TextWebSocketHandler; public class MyWebSocketHandler extends TextWebSocketHandler { @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { String payload = message.getPayload(); System.out.println("Received message: " + payload); session.sendMessage(new TextMessage("Echo: " + payload)); } } ``` 该处理器继承了 `TextWebSocketHandler`,并在 `handleTextMessage` 方法中实现了消息的接收与响应逻辑[^2]。 #### 4. 测试 WebSocket 功能 启动应用程序后,可以通过浏览器或 WebSocket 客户端工具连接到 `/ws` 路径进行测试。例如,使用 JavaScript 代码连接 WebSocket 服务器并发送消息: ```javascript const socket = new WebSocket("ws://localhost:8080/ws"); socket.onopen = function() { console.log("Connection established"); socket.send("Hello, Server!"); }; socket.onmessage = function(event) { console.log("Message from server:", event.data); }; ``` #### 5. WebSocket 的工作原理 WebSocket 使用 HTTP/1.1 的协议升级特性,通过特定的请求头(如 `Connection: Upgrade` 和 `Upgrade: websocket`)完成握手过程。一旦握手成功,客户端和服务端即可通过全双工连接进行实时通信[^4]。 --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值