Springboot中使用websocket发送信息给指定用户和群发

最新推荐文章于 2024-05-31 09:59:41 发布
最新推荐文章于 2024-05-31 09:59:41 发布
阅读量1.6w 收藏 41
点赞数 8
文章标签： springboot websocket 聊天 消息推送 交互
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/CharlesLiu233/article/details/80516892
版权

       websocket是一种长连接协议，相较于传统的http短连接，websocket不仅可以由客户端向服务器发送消息，可以主动向客户端发起信息，经常用于及时聊天，游戏和服务器向客户端推送信息。

主要优点：

1. 节约带宽。 不停地轮询服务端数据这种方式，使用的是http协议，head信息很大，有效数据占比低， 而使用WebSocket方式，头信息很小，有效数据占比高。
2. 无浪费。 轮询方式有可能轮询10次，才碰到服务端数据更新，那么前9次都白轮询了，因为没有拿到变化的数据。 而WebSocket是由服务器主动回发，来的都是新数据。

3. 实时性，考虑到服务器压力，使用轮询方式不可能很短的时间间隔，否则服务器压力太多，所以轮询时间间隔都比较长，好几秒，设置十几秒。 而WebSocket是由服务器主动推送过来，实时性是最高。


接下来我们看看怎么在springboot中使用websocket和html页面交互：

首先新建springboot项目，导入需要的websocket和springboot依赖，pom.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.lk</groupId>
	<artifactId>websocketdemo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>websocketdemo</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<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>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>


</project>

application.properties中配置tomcat端口，我配置的是80：

server.port=80

然后就可以开始配置websocket了，首先创建WebSocket配置文件：WebSocketConfig.class 
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

再创建WebSocket服务器类：WebSocketServer.class,具体代码说明注释都写得很清楚了：

@Component
//访问服务端的url地址
@ServerEndpoint(value = "/websocket/{id}")
public class WebSocketServer {
    private static int onlineCount = 0;
    private static ConcurrentHashMap<String, WebSocketServer> webSocketSet = new ConcurrentHashMap<>();

    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;
    private static Logger log = LogManager.getLogger(WebSocketServer.class);
    private String id = "";
    /**
     * 连接建立成功调用的方法*/
    @OnOpen
    public void onOpen(@PathParam(value = "id") String id, Session session) {
        this.session = session;
        this.id = id;//接收到发送消息的人员编号
        webSocketSet.put(id, this);     //加入set中
        addOnlineCount();           //在线数加1
        log.info("用户"+id+"加入！当前在线人数为" + getOnlineCount());
        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("websocket IO异常");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("来自客户端的消息:" + message);
        //可以自己约定字符串内容，比如 内容|0 表示信息群发，内容|X 表示信息发给id为X的用户
        String sendMessage = message.split("[|]")[0];
        String sendUserId = message.split("[|]")[1];
        try {
            if(sendUserId.equals("0"))
                sendtoAll(sendMessage);
            else
                sendtoUser(sendMessage,sendUserId);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    /**
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }


    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    /**
     * 发送信息给指定ID用户，如果用户不在线则返回不在线信息给自己
     * @param message
     * @param sendUserId
     * @throws IOException
     */
    public void sendtoUser(String message,String sendUserId) throws IOException {
        if (webSocketSet.get(sendUserId) != null) {
            if(!id.equals(sendUserId))
                webSocketSet.get(sendUserId).sendMessage( "用户" + id + "发来消息：" + " <br/> " + message);
            else
                webSocketSet.get(sendUserId).sendMessage(message);
        } else {
            //如果用户不在线则返回不在线信息给自己
            sendtoUser("当前用户不在线",id);
        }
    }

    /**
     * 发送信息给所有人
     * @param message
     * @throws IOException
     */
    public void sendtoAll(String message) throws IOException {
        for (String key : webSocketSet.keySet()) {
            try {
                webSocketSet.get(key).sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }


    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }
}

这时我们的webSocket后端已经创建好了，接下来写两个前端代码：

<!DOCTYPE HTML>
<html>
<head>
    <title>WebSocket</title>
</head>

<body>
Welcome<br/>
<input id="text" type="text" /><button οnclick="send()">Send</button>    <button οnclick="closeWebSocket()">Close</button>
<div id="message">
</div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:80/websocket/2");
    }
    else{
        alert('Not support websocket')
    }

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

    //连接成功建立的回调方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }

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

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

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function(){
        websocket.close();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭连接
    function closeWebSocket(){
        websocket.close();
    }

    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

<!DOCTYPE HTML>
<html>
<head>
    <title>WebSocket</title>
</head>

<body>
Welcome<br/>
<input id="text" type="text" /><button οnclick="send()">Send</button>    <button οnclick="closeWebSocket()">Close</button>
<div id="message">
</div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:80/websocket/1");
    }
    else{
        alert('Not support websocket')
    }

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

    //连接成功建立的回调方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }

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

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

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function(){
        websocket.close();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭连接
    function closeWebSocket(){
        websocket.close();
    }

    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

两个前端代码都是一样的，不同的地方在于一个访问是new WebSocket("ws://localhost:80/websocket/1");一个是new WebSocket("ws://localhost:80/websocket/2");即访问id传参不同，这时启动springboot后台服务，再打开两个前端html文件：

根据之前在代码中定义的输入格式：“信息内容|接受者Id|”进行输入，当输入id为0时表示群发：




项目源码：https://github.com/wsliukang/websocketdemo

冰蓝zeal
关注
  • 8
    点赞
  • 踩
  • 41
    收藏
    觉得还不错? 一键收藏
  • 12
    评论
SpringBoot入门系列篇（二）：SpringBoot发送json格式数据
qq_27905183的博客
01-11 6027
前情提要 JSON应该是目前web开发（甚至是Andriod开发）来说用的比较多的一种数据交换格式了吧，到现在为止，出现了很多的JSON支持库，比较流行的有fastjson、jackjson和gson等。现在就来学习使用SpringBoot来发送json格式数据吧 使用SpringBoot直接发送json格式数据 使用SpringBoot来发送json格式数据其实很简单，只需要自
SpringBoot WebSocket消息推送（群发和指定到个人或多人）
10-11
SpringBoot WebSocket消息推送（群发和指定到个人或多人）,导入项目可以直接运行。
使用webSocket简单实现群发消息和指定用户发送消息
05-09
通过调用webSocketSev类的方法,指定用户名,实现指定用户发送消息和群发消息
使用WebSocket方式能将群聊信息实时群发给所有在线用户
qq_44205675的博客
12-26 1528
WebSocket是一种在单个TCP连接上进行全双工通信的网络协议。它是为了在Web浏览器和Web服务器之间提供实时、双向的通信而设计的。传统的HTTP协议是一种单向通信协议，客户端发送请求，服务器响应，然后连接就关闭了。而WebSocket允许在客户端和服务器之间建立持久连接，使得双方可以通过该连接随时发送数据。WebSocket协议通过在HTTP握手阶段使用Upgrade头来升级连接，使其成为全双工通信通道。一旦升级完成，WebSocket连接就保持打开状态，允许双方在任何时候发送数据。
Springboot+WebSocket实现消息推送
最新发布
weixin_45817985的博客
05-31 744
Springboot+WebSocket实现消息推送
SpringBoot集成WebSocket(实时消息推送)
总结分享
03-25 2250
WebSocket 允许服务器在没有收到请求的情况下主动向客户端发送数据，从而实现了更高效的实时通信。
Springboot 集成 webscoket 实现系统给用户发信息， 用户界面右上角有个小铃铛
u013890784的博客
05-17 812
websocket 实时消息推送
SpringBoot整合WebSocket实现数据推送
攻城狮Chova的博客
01-19 925
SpringBoot整合WebSocket实现数据推送基本概念 基本概念 WebSocket: WebSocket是一种在单个TCP连接上进行全双工通信的协议 WebSocket使得服务器和客户端之间的数据交换更加简单,允许服务端主动向客户端推送数据 在WebSocket中,浏览器和服务器只需要完成一次握手,两者之间就可以直接创建持久性的连接,并进行双向数据传输 使用WebSocket方式实现数据推送: 使用WebSocket实现数据推送的优点: 较少的控制开销: 在连接创建后,服务器与客户端之
Spring Boot系列20 Spring Websocket实现向指定的用户发送消息
weixin_33752045的博客
07-19 1122
概述 不同上文Spring Boot系列十七 Spring Boot 集成 websocket，使用RabbitMQ做为消息代理，本文我们介绍通过Spring websocket实现向特定的用户发送消息。 本文的内容如下： 1. 首先实现简单的登录功能，这里向特定用户发送消息的必要条件 2. 用户登录系统后，才可以登录websocket，并重写MyPrincipal 3. 实现向特定用户发送消息的...
websocket在springboot+vue中的使用教程
08-25
在本教程中，我们将详细介绍如何在Spring Boot和Vue中使用WebSocket。WebSocket是一种实时通信协议，允许服务器推送数据到客户端，而不需要客户端不断地请求服务器。下面，我们将通过实例代码，展示如何在Spring ...
SpringBoot webSocket实现发送广播、点对点消息和Android接收
08-31
SpringBoot WebSocket 实现发送广播、点对点消息和 Android 接收 SpringBoot 是一个流行的 Java 框架，提供了许多实用的功能，包括 WebSocket。WebSocket 是一种双向通信协议，允许客户端和服务器之间进行实时通信...
SpringBootwebSocket 消息发送与接收
11-16
SpringBootwebSocket 消息发送与接收 webSocket 消息推送于接收 个人信息推送 springBoot项目,直接下载 导包就能执行
websocket群发和指定用户发消息spring boot练习
11-14
消息|0 大概就是这个格式，后面为0就是群发，别的就是指定用户， 练习spring boot时候弄的，不喜勿喷，俺也是花了点时间的啊，还整理了。。。导进去就可以运行，只要3C哦
websocket 给指定用户发送聊天消息
03-30
为了给指定用户发送聊天消息，我们需要在服务器端维护一个用户与WebSocket会话（Session）的映射。当用户连接时，将其Session存入映射，并通过Session对象的`sendText()`方法向特定用户发送消息。 在客户端，我们...
springboot+websocket分布式实现
11-17
WebSocket是一种在客户端和服务器之间建立长连接的协议，它提供了双向通信的能力，即服务器和客户端都可以主动发送数据。SpringBoot是Java开发中的一个轻量级框架，它简化了创建独立的、生产级别的基于Spring的应用...
SpringBoot整合websocket实现群聊
2301_79099480的博客
04-07 289
使用springboot 2.3.10.RELEASE版本；java8。
基于Springboot用Netty实现WebSocket及用户身份校验
linbeiwo的博客
07-21 2413
基于Springboot用Netty实现WebSocket及用户身份校验
9、springboot和websocket的集成，实现简单的单发和群发消息
一点光辉的博客
05-28 527
新建简单的springboot项目，引入socket相关的jar包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.springframework.b
springboot中WebSocket实现批量和定向推送
weixin_45740898的博客
01-11 1233
1.添加依赖 注：这是springboot中整合 <!--字节套实现消息推送--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> 2.配置文件 import org.spri
springboot中使用websocket
08-23
在Spring Boot项目中使用WebSocket，首先需要引入spring-boot-starter-websocket组件。这可以通过在pom.xml文件中添加以下依赖实现： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 然后，你需要在你的项目中创建一个WebSocket处理器类。这个处理器类应该使用注解@Component进行声明，以便被Spring管理。在处理器类中，你可以定义处理WebSocket连接、消息发送和接收的方法。 在前端代码中，你需要确保WebSocket地址与后端的地址一致。例如，可以使用以下代码创建WebSocket： ```javascript websocket = new WebSocket("ws://localhost:8080/websocket"); ``` 通过上述步骤，你就可以在Spring Boot中成功使用WebSocket了。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [Websocket 在Springboot中使用](https://blog.csdn.net/u011144425/article/details/79231212)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [springboot中使用websocket](https://blog.csdn.net/qq_36027670/article/details/83009586)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论 12
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值