快捷導(dǎo)航

Java后端向前端推送消息完整代碼實(shí)例

更新時(shí)間：2026年02月02日 10:05:28 作者：recollection℡1??

WebSocket是一種全雙工通信協(xié)議,允許后端主動(dòng)向前端推送消息,下面這篇文章主要介紹了Java后端向前端推送消息的相關(guān)資料,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下

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消息發(fā)送接收

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 {

    /*
     * 持有每個(gè)webSocket對(duì)象，以key-value存儲(chǔ)到線程安全ConcurrentHashMap，
     */
    private static ConcurrentHashMap<Long, WebSocketProcess> concurrentHashMap = new ConcurrentHashMap<>(12);

    /**
     * 會(huì)話對(duì)象
     **/
    private Session session;


    /*
     * 客戶端創(chuàng)建連接時(shí)觸發(fā)
     * */
    @OnOpen
    public void onOpen(Session session, @PathParam("id") long id) {
        //每新建立一個(gè)連接，就把當(dāng)前客戶id為key,this為value存儲(chǔ)到map中
        this.session = session;
        concurrentHashMap.put(id, this);
        log.info("Open a websocket. id={}", id);
    }

    /**
     * 客戶端連接關(guān)閉時(shí)觸發(fā)
     **/
    @OnClose
    public void onClose(Session session, @PathParam("id") long id) {
        //客戶端連接關(guān)閉時(shí)，移除map中存儲(chǔ)的鍵值對(duì)
        concurrentHashMap.remove(id);
        log.info("close a websocket, concurrentHashMap remove sessionId= {}", id);
    }

    /**
     * 接收到客戶端消息時(shí)觸發(fā)
     */
    @OnMessage
    public void onMessage(String message, @PathParam("id") String id) {
        log.info("receive a message from client id={},msg={}", id, message);
    }

    /**
     * 連接發(fā)生異常時(shí)候觸發(fā)
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("Error while websocket. ", error);
    }

    /**
     * 發(fā)送消息到指定客戶端
     *
     * @param id
     * @param message
     */
    public void sendMessage(long id, String message) throws Exception {
        //根據(jù)id,從map中獲取存儲(chǔ)的webSocket對(duì)象
        WebSocketProcess webSocketProcess = concurrentHashMap.get(id);
        if (!ObjectUtils.isEmpty(webSocketProcess)) {
            //當(dāng)客戶端是Open狀態(tài)時(shí)，才能發(fā)送消息
            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);
        }
    }

    /**
     * 發(fā)送消息到所有客戶端
     */
    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;

    /**
     * 向指定客戶端發(fā)消息
     *
     * @param id

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

    /**
     * 發(fā)消息到所有客戶端
     *
     * @param text
     */
    @PostMapping(value = "sendMsgToAllClient")
    public void sendMsgToAllClient(@RequestParam String text) {
        try {
            webSocketProcess.sendAllMessage(text);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
     /**
     * 定時(shí)向客戶端推送消息
     * @throws Exception
     */
    @Scheduled(cron = "0/5 * * * * ?")
    private void configureTasks() throws Exception {
        webSocketProcess.sendAllMessage("向前端推送消息內(nèi)容");
    }
}

4、測(cè)試HTML

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>websocket測(cè)試</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;
        //檢測(cè)瀏覽器是否支持webSocket
        if("WebSocket" in window){
            $("#content").html("您的瀏覽器支持webSocket!");
            //模擬產(chǎn)生clientID
            let clientID = Math.ceil(Math.random()*100);

            //創(chuàng)建 WebSocket 對(duì)象,注意請(qǐng)求路徑?。。?！
            ws = new WebSocket("ws://127.0.0.1:9095/web/"+clientID);

            //與服務(wù)端建立連接時(shí)觸發(fā)
            ws.onopen = function(){
                $("#content").append("<p>與服務(wù)端建立連接建立成功！您的客戶端ID="+clientID+"</p>");

                //模擬發(fā)送數(shù)據(jù)到服務(wù)器
                ws.send("你好服務(wù)端！我是客戶端 "+clientID);
            }

            //接收到服務(wù)端消息時(shí)觸發(fā)
            ws.onmessage = function (evt) {
                let received_msg = evt.data;
                $("#content").append("<p>接收到服務(wù)端消息:"+received_msg+"</p>");
            };

            //服務(wù)端關(guān)閉連接時(shí)觸發(fā)
            ws.onclose = function() {
                console.error("連接已經(jīng)關(guān)閉.....")
            };
        }else{
            $("#content").html("您的瀏覽器不支持webSocket！");
        }
    })

</script>
</html>