SpringBoot搭建WebSocket服务

最新推荐文章于 2024-05-17 08:56:14 发布
最新推荐文章于 2024-05-17 08:56:14 发布
阅读量3.2k 收藏 6
点赞数 4
分类专栏： SpringBoot 文章标签： java spring boot websocket javascript
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/swmfizl/article/details/103963820
版权

SpringBoot搭建WebSocket服务

一、环境准备

  • 开发工具：STS、HBuilderX
  • JDK：1.8
  • SpringBoot版本：2.2.2

二、后端搭建WebSocket服务

  • 1.新建SpringBoot项目，并勾选WebSocket服务
  • 2.项目目录结构如下
  • 3.新建类文件WebSocket，文件位置如项目结构所示，代码编写如下
  • 4.新建类文件WebSocketConfig，文件位置如项目结构所示，代码编写如下

1.新建SpringBoot项目，并勾选WebSocket服务

2.项目目录结构如下

3.新建类文件WebSocket，文件位置如项目结构所示，代码编写如下

package com.websocket.websocket;

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

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

import org.springframework.web.bind.annotation.RestController;

/**
 * WebSocket
 * 
 * @author ZhongLi
 * @date 2020-01-12
 * @version 1.0.0
 */
@ServerEndpoint("/WebSocket/{id}")
@RestController
public class WebSocket {

	// 存储会话
	private static ConcurrentHashMap<String, WebSocket> webSocket = new ConcurrentHashMap<String, WebSocket>();

	private String id;
	private Session session;

	/**
	 * 接入连接回调
	 * 
	 * @param session 会话对象
	 * @param id      会话ID
	 * @throws Exception 异常
	 */
	@OnOpen
	public void onOpen(Session session, @PathParam("id") String id) throws Exception {
		this.id = id;
		this.session = session;
		webSocket.put(id, this);
		// 检验后端能否正常给前端发送信息
		sendMessageToId(this.id, "前端你好，我是后端，我正在通过WebSocket给你发送消息");
		System.out.println(id + "接入连接");
	}

	/**
	 * 关闭连接回调
	 */
	@OnClose
	public void onClose() {
		webSocket.remove(this.id);
		System.out.println(this.id + "关闭连接");
	}

	/**
	 * 收到客户端发来消息回调
	 * 
	 * @param message
	 */
	@OnMessage
	public void onMessage(String message) {
		System.out.println(this.id + "发来消息：" + message);
	}

	/**
	 * 会话出现错误回调
	 * 
	 * @param error   错误信息
	 */
	@OnError
	public void onError(Throwable error) {

	}

	/**
	 * 发送消息给客户端
	 * 
	 * @param message 消息
	 * @throws IOException 异常
	 */
	public void sendMessage(String message) throws IOException {
		this.session.getBasicRemote().sendText(message);
	}

	/**
	 * 给指定的会话发送消息
	 * 
	 * @param id      会话ID
	 * @param message 消息
	 * @throws IOException 异常
	 */
	public void sendMessageToId(String id, String message) throws IOException {
		webSocket.get(id).sendMessage(message);
	}

	/**
	 * 群发消息
	 * 
	 * @param message 消息
	 * @throws IOException 异常
	 */
	public void sendMessageToAll(String message) throws IOException {
		for (String key : webSocket.keySet()) {
			try {
				webSocket.get(key).sendMessage(message);
			} catch (IOException e) {
				e.printStackTrace();
			}
		}
	}

}

4.新建类文件WebSocketConfig，文件位置如项目结构所示，代码编写如下

package com.websocket.websocket;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * WebSocketConfig
 * 
 * @author ZhongLi
 * @date 2020-01-12
 * @version 1.0.0
 */
@Configuration
public class WebSocketConfig {
	@Bean
	public ServerEndpointExporter serverEndpointExporter() {
		return new ServerEndpointExporter();
	}
}

三、新建前端项目

  • 1.新建index.html文件，代码如下

1.新建index.html文件，代码如下

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>WebSocket</title>
	</head>
	<body>
	</body>
	<script type="text/javascript">
		var websocket = null;
		//判断当前浏览器是否支持WebSocket
		if ('WebSocket' in window) {
			websocket = new WebSocket("ws://127.0.0.1:8080/WebSocket/zhongli");
		} else {
			alert('当前浏览器 Not support websocket')
		}

		//连接发生错误的回调方法
		websocket.onerror = function() {
			console.log("WebSocket连接发生错误");
		};

		//连接成功建立的回调方法
		websocket.onopen = function() {
			console.log("WebSocket连接成功");
		}

		//接收到消息的回调方法
		websocket.onmessage = function(event) {
			console.log(event.data);
		}

		//连接关闭的回调方法
		websocket.onclose = function() {
			console.log("WebSocket连接关闭");
		}

		//发送消息
		function sendMsg(msg) {
			websocket.send(msg);
		}
	</script>

</html>

四、项目演示

  • 1.启动SpringBoot项目，项目正常启动
  • 2.运行前端项目并查看控制台，浏览器控制台提示成功
  • 3.检验后端是否正常给前端发送消息，查看浏览器控制台正常收到消息
  • 4.检验前端是否正常给后端发送消息，浏览器控制台运行sendMsg()方法，正常给后端发送消息

1.启动SpringBoot项目，项目正常启动

在这里插入图片描述

2.运行前端项目并查看控制台，浏览器控制台提示成功

在这里插入图片描述

3.检验后端是否正常给前端发送消息，查看浏览器控制台正常收到消息

在这里插入图片描述

4.检验前端是否正常给后端发送消息，浏览器控制台运行sendMsg()方法，正常给后端发送消息

在这里插入图片描述

五、Github项目地址

  • SpringBootWebSocket

springboot-websocket

钟 力
关注
  • 4
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
使用SpringBoot进行WebSocket开发
禅与计算机程序设计艺术
01-31 88
1.背景介绍 使用SpringBoot进行WebSocket开发 作者：禅与计算机程序设计艺术 背景介绍 1.1 WebSocket简史 WebSocket是HTM
SpringBoot整合WebSocket，最新教程，细到极致
gubeichengxuyuan的博客
04-12 4858
大家好鸭，最近在和第三方做数据对接，老哥需要整个WebSocket发送数据。我当时在想，为什么不用kafka呢，或者其他消息中间件。emm…，这个不深究了 下面，我们用Springboot 2.6.4 整合Websocet 1、导入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-star
SpringBoot之WebSocket服务搭建
yuanjinshenglife的专栏
02-24 1627
SpringBoot之WebSocket服务搭建
SpringBoot 构建 WebSocket
永远相信美好的事情即将发生
05-07 1506
项目中有需要使用到 WebSocket，这里记录一下： 添加依赖坐标，除了基本的 spring-boot-starter-web依赖之外，还需要添加一个 websocket相关的依赖： <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> 添加 Configurer配置类，将 websocket 访问路径入口与 ha
一万字教程详解：教会你如何在 SpringBoot 中使用 WebSocket
最新发布
Wewe的博客
05-17 760
这里，我们可以设置拦截器，在做请求参数，或者权限认证的时候，不用在建立链接的函数里面去处理可以理解为 springMvc 每次请求前的拦截器/*** @createTime 2023年07月19日*/@Slf4j/*** 建立请求之前，可以用来做权限判断* session;* @return*/@Override// 模拟用户（通常利用JWT令牌解析用户信息）try {
SpringBoot（java）实现websocket实现实时通信
敲厉害的燕宝的博客
03-29 2545
WebSockets是一种在Web应用程序中实现实时通信的技术。它允许客户端和服务器之间建立持久的、双向的通信通道，从而使得服务器可以实时向客户端推送数据，而不需要客户端不断地向服务器发起请求。这种实时通信的能力对于需要即时更新数据的应用程序非常有用，比如在线聊天应用、实时游戏、股票市场更新等。：客户端向服务器发起WebSocket连接请求，服务器接受连接请求后，双方建立WebSocket连接。：一旦建立了连接，客户端和服务器就可以通过该连接进行双向通信，可以发送和接收数据。
springboot+websocket+idea.zip
09-19
【标题】"SpringBoot+websocket广播式应用"指的是在Java开发环境中，利用Spring Boot框架集成WebSocket技术来构建实时通信的应用。Spring Boot简化了Spring应用程序的初始设置和配置，使其易于快速开发独立的、生产...
SpringBoot+WebSocket搭建简单的多人聊天系统
08-25
在使用SpringBoot构建WebSocket应用时，首先需要引入相关的依赖。如果你使用的是Gradle，可以在build.gradle文件中加入以下依赖： ```groovy dependencies { implementation 'org.springframework.boot:spring-boot...
springboot+websocket+redis实现聊天室
08-05
Spring Boot是基于Spring框架的快速开发工具，它简化了Spring应用的初始搭建以及开发过程。在聊天室项目中，Spring Boot作为后端服务器，负责处理HTTP请求、数据存储和业务逻辑。通过配置启动器，可以轻松引入...
SpringBoot_WebSocket.zip
07-04
SpringBoot是基于Java的轻量级框架，简化了Spring应用的初始搭建以及开发过程。结合WebSocket，SpringBoot可以轻松创建支持实时通讯的应用，例如聊天室。 在"SpringBoot_WebSocket.zip"这个压缩包中，我们可以预见...
springboot-websocket-demo.zip
12-27
【标签】"springboot"指的是Spring Boot，一个用于简化Spring应用初始搭建以及开发过程的框架。它提供了预配置的依赖和默认设置，使得开发者可以快速创建独立运行的、生产级别的基于Spring的应用。 "websocket"是本...
SpringBoot整合WebSocket的两种方式及微服务网关Gateway配置
余金兑人的技术角落
04-23 1万+
项目中后台微服务需要向前端页面推送消息，因此不可避免的需要用到WebSocket技术。SpringBoot已经为WebSocket的集成提供了很多支持，只是WebSocket消息如何通过微服务网关Spring Cloud Gateway向外暴露接口，实际开发过程中遇到了很多问题。微服务框架本身是作为一个平台为各种服务提供支撑的，所以对常用的两种WebSocket实现方式都要能够适配，特别是用Stomp方式实现时要考虑WebSocket接口与Rest API接口共存时的跨域问题。
springBoot环境下创建webSocket服务端和客户端
qq_25613413的博客
08-22 629
1.pom文件导入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> <version>2.0.4.RELEASE</v...
SpringBoot实现WebSocket服务端方式
猫与少年
04-26 664
SpringBoot实现WebSocket服务端方式
springboot搭建websocket集群
晨曦
10-15 2024
这时如果通过服务B发送消息给前端的时候，由于服务B未与前端建立websocket连接，导致websocket消息无法发送到前端。官网在最初做登录功能的时候，是通过HTTP轮询的方式实现的，后来随着用户逐渐增加，这种方案的弊端逐步展现了，频繁的请求后端接口导致服务器负载增加，在不想增加服务器成本的情况下，将实现方案替换成了websocket技术。既然问题已经找到了，那就好办了，可以将需要发送的消息同时通知服务A和服务B，谁持有session会话信息就由谁发消息不就行了吗？在服务启动的时候先订阅一个渠道。
WebSocket（二）：完全基于Spring Boot项目的WebSocket服务端
weixin_42717117的博客
02-28 1278
系列文章目录 WebSocket（一）：基于Spring Boot项目配合H5标准的WebSocket服务端 文章目录系列文章目录前言一、使用步骤1.引入库2.编写Spring Boot启动入口2.编写WebSocket服务端3.测试结果三、总结 前言 此系列文章为记录使用WebSocket的相关过程，如有错误的地方，还请指正。 一、使用步骤 springboot整合的WebSocket服务功能更加强大 1.引入库 <!--spring boot starter websocket已经包含
springboot集成websocket
大爱仙尊
10-21 2万+
​ 这里我们使用springboot搭建一个轻量级的websocket服务，同时提供4个入参。使用websocket服务可以轻松和微信小程序、支付宝小程序、网页就行双向通讯，非常实用方便。wss地址这里是我们自己搭建的中转服务websocket地址。参数说明。
springboot 使用websocket 步骤
qq_37797583的博客
12-06 2919
直接上步骤 1.创建好springboot项目，如果不会创建可以参考我博客中分享的创建springboot项目步骤 2.导入pom.xml依赖 org.springframework.boot spring-boot-starter-websocket 3.在项目的启动入口加入类上面加入@EnableWebSocket 注解，并且在类中加入 一个bean方法，注意启动类的位置，如果和我不一样，可能你要理解一下@SpringBootApplication的作用范围，这一步完成，只要在网上找一点websoc
springboot整合websocket
热门推荐
wh柒八九的博客
02-26 3万+
迷你号
springboot搭建websocket
05-26
以下是使用Spring Boot搭建WebSocket的简单示例： 1. 添加依赖 在pom.xml中添加以下依赖： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 配置WebSocket 在Spring Boot的配置文件application.properties中添加以下配置： ``` server.port=8080 ``` 3. 编写WebSocket处理器 创建一个WebSocket处理器类，用于处理WebSocket连接和消息。 ```java @Component public class WebSocketHandler extends TextWebSocketHandler { @Override public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { String payload = message.getPayload(); session.sendMessage(new TextMessage("Received: " + payload)); } } ``` 4. 配置WebSocket处理器 创建一个WebSocket配置类，用于配置WebSocket处理器。 ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Autowired private WebSocketHandler webSocketHandler; @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(webSocketHandler, "/ws").setAllowedOrigins("*"); } } ``` 5. 测试WebSocket 在浏览器中打开http://localhost:8080/index.html，并打开浏览器的开发者工具，在控制台输入以下JavaScript代码，连接WebSocket并发送消息： ```javascript var ws = new WebSocket("ws://localhost:8080/ws"); ws.onmessage = function(event) { console.log(event.data); } ws.send("Hello, WebSocket!"); ``` 在控制台中应该可以看到收到的消息，例如： ``` Received: Hello, WebSocket! ```
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值