您的位置:首页 > 健康 > 美食 > Spring Boot + WebSocket 实现 IM 即时通讯

Spring Boot + WebSocket 实现 IM 即时通讯

2024/12/23 21:37:37 来源:https://blog.csdn.net/qq_43546721/article/details/139905689  浏览:    关键词:Spring Boot + WebSocket 实现 IM 即时通讯

文章目录

      • 1. 项目环境准备
      • 2. 配置WebSocket
      • 3. 创建消息处理器
      • 4. 创建消息类
      • 5. 创建前端页面
      • 6. 启动应用并测试
      • 7. 分析与扩展
      • 结论

在这里插入图片描述

🎉欢迎来到SpringBoot框架学习专栏~


  • ☆* o(≧▽≦)o *☆嗨~我是IT·陈寒🍹
  • ✨博客主页:IT·陈寒的博客
  • 🎈该系列文章专栏:SpringBoot
  • 📜其他专栏:Java学习路线 Java面试技巧 Java实战项目 AIGC人工智能 数据结构学习
  • 🍹文章作者技术和水平有限,如果文中出现错误,希望大家能指正🙏
  • 📜 欢迎大家关注! ❤️

即时通讯(IM)已经成为现代应用中不可或缺的一部分,从社交媒体到企业协作工具,无不依赖于IM技术来实现实时消息传递。本文将介绍如何使用Spring Boot和WebSocket实现一个简单的即时通讯系统。

在这里插入图片描述

1. 项目环境准备

首先,我们需要创建一个Spring Boot项目,并添加WebSocket的相关依赖。使用Spring Initializr创建项目时,选择如下依赖:

  • Spring Web
  • Spring WebSocket

也可以在pom.xml中手动添加:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2. 配置WebSocket

创建一个配置类,来启用WebSocket并设置消息端点:

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {@Overridepublic void configureMessageBroker(MessageBrokerRegistry config) {config.enableSimpleBroker("/topic");config.setApplicationDestinationPrefixes("/app");}@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {registry.addEndpoint("/chat").withSockJS();}
}

3. 创建消息处理器

接下来,我们需要创建一个控制器来处理WebSocket消息。创建一个新的控制器类:

import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
import org.springframework.web.util.HtmlUtils;@Controller
public class ChatController {@MessageMapping("/message")@SendTo("/topic/messages")public ChatMessage sendMessage(ChatMessage message) throws Exception {// 模拟处理时间Thread.sleep(1000);return new ChatMessage(HtmlUtils.htmlEscape(message.getContent()));}
}

4. 创建消息类

定义消息类来封装消息内容:

public class ChatMessage {private String content;public ChatMessage() {}public ChatMessage(String content) {this.content = content;}public String getContent() {return content;}public void setContent(String content) {this.content = content;}
}

5. 创建前端页面

src/main/resources/static目录下创建一个HTML页面,作为前端聊天界面:

<!DOCTYPE html>
<html>
<head><title>Chat Room</title><script src="https://cdn.jsdelivr.net/npm/sockjs-client@1.4.0/dist/sockjs.min.js"></script><script src="https://cdn.jsdelivr.net/npm/stompjs@2.3.3/lib/stomp.min.js"></script><script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
</head>
<body><h2>Chat Room</h2><div id="messages"></div><input type="text" id="message" placeholder="Type your message here..." autofocus/><button onclick="sendMessage()">Send</button><script>var stompClient = null;function connect() {var socket = new SockJS('/chat');stompClient = Stomp.over(socket);stompClient.connect({}, function (frame) {console.log('Connected: ' + frame);stompClient.subscribe('/topic/messages', function (message) {showMessage(JSON.parse(message.body).content);});});}function sendMessage() {var message = document.getElementById('message').value;stompClient.send("/app/message", {}, JSON.stringify({'content': message}));document.getElementById('message').value = '';}function showMessage(message) {$("#messages").append("<div>" + message + "</div>");}$(document).ready(function () {connect();});</script>
</body>
</html>

6. 启动应用并测试

启动Spring Boot应用,打开浏览器访问http://localhost:8080,你将看到一个简单的聊天室界面。打开多个浏览器窗口或标签页,可以在它们之间发送消息,验证即时通讯功能是否正常工作。

7. 分析与扩展

上述实现是一个简单的IM系统示例,实际应用中可能需要更多功能,如:

  • 用户身份验证:在实际应用中,用户需要先登录才能使用IM功能,可以集成Spring Security来实现用户身份验证。
  • 消息存储:将聊天记录存储到数据库,以便于后续查询和分析。
  • 群组聊天:除了单对单聊天,还可以实现群组聊天功能。
  • 文件传输:除了文本消息,还可以扩展支持文件传输、语音消息等。

结论

通过Spring Boot和WebSocket,可以快速构建一个高效的即时通讯系统。本文介绍了基本的配置和实现流程,并提供了一个简单的示例。在实际项目中,可以根据需求进一步扩展和优化。希望本文能够帮助你更好地理解和使用Spring Boot和WebSocket来实现IM功能。


🧸结尾 ❤️ 感谢您的支持和鼓励! 😊🙏
📜您可能感兴趣的内容:

  • 【Java面试技巧】Java面试八股文 - 掌握面试必备知识(目录篇)
  • 【Java学习路线】2023年完整版Java学习路线图
  • 【AIGC人工智能】Chat GPT是什么,初学者怎么使用Chat GPT,需要注意些什么
  • 【Java实战项目】SpringBoot+SSM实战:打造高效便捷的企业级Java外卖订购系统
  • 【数据结构学习】从零起步:学习数据结构的完整路径

在这里插入图片描述

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com