Java后端向前端推送消息完整代码实例

 更新时间:2026年02月02日 10:05:28   作者:recollection℡¹⁸⁶  
WebSocket是一种全双工通信协议,允许后端主动向前端推送消息,下面这篇文章主要介绍了Java后端向前端推送消息的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下

1、WebSocketConfig配置类

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

@Configuration
@EnableWebSocket
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return  new ServerEndpointExporter();
    }
}

2、WebSocket消息发送接收

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.ObjectUtils;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

@Slf4j
@Component
@ServerEndpoint(value = "/web/{id}")
public class WebSocketProcess {

    /*
     * 持有每个webSocket对象,以key-value存储到线程安全ConcurrentHashMap,
     */
    private static ConcurrentHashMap<Long, WebSocketProcess> concurrentHashMap = new ConcurrentHashMap<>(12);

    /**
     * 会话对象
     **/
    private Session session;


    /*
     * 客户端创建连接时触发
     * */
    @OnOpen
    public void onOpen(Session session, @PathParam("id") long id) {
        //每新建立一个连接,就把当前客户id为key,this为value存储到map中
        this.session = session;
        concurrentHashMap.put(id, this);
        log.info("Open a websocket. id={}", id);
    }

    /**
     * 客户端连接关闭时触发
     **/
    @OnClose
    public void onClose(Session session, @PathParam("id") long id) {
        //客户端连接关闭时,移除map中存储的键值对
        concurrentHashMap.remove(id);
        log.info("close a websocket, concurrentHashMap remove sessionId= {}", id);
    }

    /**
     * 接收到客户端消息时触发
     */
    @OnMessage
    public void onMessage(String message, @PathParam("id") String id) {
        log.info("receive a message from client id={},msg={}", id, message);
    }

    /**
     * 连接发生异常时候触发
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("Error while websocket. ", error);
    }

    /**
     * 发送消息到指定客户端
     *
     * @param id
     * @param message
     */
    public void sendMessage(long id, String message) throws Exception {
        //根据id,从map中获取存储的webSocket对象
        WebSocketProcess webSocketProcess = concurrentHashMap.get(id);
        if (!ObjectUtils.isEmpty(webSocketProcess)) {
            //当客户端是Open状态时,才能发送消息
            if (webSocketProcess.session.isOpen()) {
                webSocketProcess.session.getBasicRemote().sendText(message);
            } else {
                log.error("websocket session={} is closed ", id);
            }
        } else {
            log.error("websocket session={} is not exit ", id);
        }
    }

    /**
     * 发送消息到所有客户端
     */
    public void sendAllMessage(String msg) throws Exception {
        log.info("online client count={}", concurrentHashMap.size());
        Set<Map.Entry<Long, WebSocketProcess>> entries = concurrentHashMap.entrySet();
        for (Map.Entry<Long, WebSocketProcess> entry : entries) {
            Long cid = entry.getKey();
            WebSocketProcess webSocketProcess = entry.getValue();
            boolean sessionOpen = webSocketProcess.session.isOpen();
            if (sessionOpen) {
                webSocketProcess.session.getBasicRemote().sendText(msg);
            } else {
                log.info("cid={} is closed,ignore send text", cid);
            }
        }
    }
}

3、消息推送Controller

import com.xyl.web.controller.common.WebSocketProcess;
import com.xyl.web.controller.common.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testws")
public class WebSocketController {

    /**
     * 注入WebSocketProcess
     **/
    @Autowired
    private  WebSocketProcess webSocketProcess;

    /**
     * 向指定客户端发消息
     *
     * @param id

     */
    @PostMapping(value = "sendMsgToClientById")
    public void sendMsgToClientById(@RequestParam long id, @RequestParam String text) {
        try {
            webSocketProcess.sendMessage(id, text);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 发消息到所有客户端
     *
     * @param text
     */
    @PostMapping(value = "sendMsgToAllClient")
    public void sendMsgToAllClient(@RequestParam String text) {
        try {
            webSocketProcess.sendAllMessage(text);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
     /**
     * 定时向客户端推送消息
     * @throws Exception
     */
    @Scheduled(cron = "0/5 * * * * ?")
    private void configureTasks() throws Exception {
        webSocketProcess.sendAllMessage("向前端推送消息内容");
    }
}

4、测试HTML

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>websocket测试</title>
    <script src="http://code.jquery.com/jquery-2.1.1.min.js"></script>
</head>
<body>
<div id="content"></div>

</body>
<script type="text/javascript">

    $(function(){
        var ws;
        //检测浏览器是否支持webSocket
        if("WebSocket" in window){
            $("#content").html("您的浏览器支持webSocket!");
            //模拟产生clientID
            let clientID = Math.ceil(Math.random()*100);

            //创建 WebSocket 对象,注意请求路径!!!!
            ws = new WebSocket("ws://127.0.0.1:9095/web/"+clientID);

            //与服务端建立连接时触发
            ws.onopen = function(){
                $("#content").append("<p>与服务端建立连接建立成功!您的客户端ID="+clientID+"</p>");

                //模拟发送数据到服务器
                ws.send("你好服务端!我是客户端 "+clientID);
            }

            //接收到服务端消息时触发
            ws.onmessage = function (evt) {
                let received_msg = evt.data;
                $("#content").append("<p>接收到服务端消息:"+received_msg+"</p>");
            };

            //服务端关闭连接时触发
            ws.onclose = function() {
                console.error("连接已经关闭.....")
            };
        }else{
            $("#content").html("您的浏览器不支持webSocket!");
        }
    })

</script>
</html>


总结 

到此这篇关于Java后端向前端推送消息完整代码的文章就介绍到这了,更多相关Java后端向前端推送消息内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java8 使用CompletableFuture 构建异步应用方式

    Java8 使用CompletableFuture 构建异步应用方式

    这篇文章主要介绍了Java8 使用CompletableFuture 构建异步应用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Java中集成ELK的使用小结

    Java中集成ELK的使用小结

    本文系统讲解ELK在Java应用中的应用,涵盖日志收集、过滤、监控、集群部署及性能优化,具有一定的参考价值,感兴趣的可以了解一下
    2025-08-08
  • java批量导入Excel数据超详细实例

    java批量导入Excel数据超详细实例

    这篇文章主要给大家介绍了关于java批量导入Excel数据的相关资料,EXCEL导入就是文件导入,操作代码是一样的,文中给出了详细的代码示例,需要的朋友可以参考下
    2023-08-08
  • JavaWeb编程 Servlet的基本配置

    JavaWeb编程 Servlet的基本配置

    本文讲的是Servlet最基本的配置信息,相信对你一定有帮助
    2013-11-11
  • Springboot集成RabbitMQ死信队列的实现

    Springboot集成RabbitMQ死信队列的实现

    在大多数的MQ中间件中,都有死信队列的概念。本文主要介绍了Springboot集成RabbitMQ死信队列的实现,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • 详解SpringMVC组件之HandlerMapping(一)

    详解SpringMVC组件之HandlerMapping(一)

    这篇文章主要介绍了详解SpringMVC组件之HandlerMapping(一),HandlerMapping组件是Spring MVC核心组件,用来根据请求的request查找对应的Handler,在Spring MVC中,有各式各样的Web请求,每个请求都需要一个对应的Handler来处理,需要的朋友可以参考下
    2023-08-08
  • java实现MD5加密方法汇总

    java实现MD5加密方法汇总

    本文给大家汇总介绍了2种java实现MD5加密的方法,非常的实用,这里分享给大家,学习下其中的思路,对大家学习java非常有帮助。
    2015-10-10
  • 一起来看看springboot集成redis的使用注解

    一起来看看springboot集成redis的使用注解

    这篇文章主要为大家详细介绍了springboot集成redis的使用注解,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • java 如何往已经存在的excel表格里面追加数据的方法

    java 如何往已经存在的excel表格里面追加数据的方法

    这篇文章主要介绍了java 如何往已经存在的excel表格里面追加数据的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • Lombok @Slf4j log对象没有info等方法不可用问题及解决

    Lombok @Slf4j log对象没有info等方法不可用问题及解决

    本文主要介绍了如何解决Spring Boot项目中的日志依赖冲突问题,以及如何使用Lombok和SLF4J进行日志记录,Lombok通过生成Logger对象简化了日志记录,而SLF4J提供了一个统一的日志接口,允许开发者在运行时选择不同的日志实现
    2024-12-12

最新评论