spring boot websocket

最新推荐文章于 2025-07-03 15:10:06 发布

原创最新推荐文章于 2025-07-03 15:10:06 发布 · 181 阅读

0 ·

CC 4.0 BY-SA版权

websocket 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何使用Spring Boot实现WebSocket通信，包括pom.xml配置、application.yml设置、WebSocket配置类编写、WebSocket处理器定义及客户端JS代码。展示了如何通过WebSocket进行实时消息推送。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pom.xml

    <dependencies>

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


        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.6</version>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.2.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.5.0</version>
        </dependency>


        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>


    </dependencies>

application.yml

server:
  port: 8080
  tomcat:
     max-threads: 5
     uri-encoding: utf-8
  servlet:
    context-path: /

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

import javax.annotation.Resource;

@Configuration
@EnableWebSocket
public class MessageWebSocketConfig implements WebSocketConfigurer {

    @Resource
    private MyHandler myHandler;


    @Resource
    private OnlineCountHandshakeInterceptor onlineCountHandshakeInterceptor;

    @Resource
    private OnlineUserCacheInterceptor onlineUserCacheInterceptor;

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myHandler, "/myHandler")
                .addInterceptors(onlineCountHandshakeInterceptor, onlineUserCacheInterceptor)
                .setAllowedOrigins("*");
    }

}

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.HandshakeInterceptor;

import java.util.Map;

@Slf4j
@Component
public class OnlineCountHandshakeInterceptor implements HandshakeInterceptor {
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        log.error("====beforeHandshake============");
        return true;
    }

    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable Exception exception) {
        log.error("======afterHandshake==========");
    }
}

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;

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


@Slf4j
@Service
public class MyHandler implements WebSocketHandler {

    public static final ConcurrentHashMap<Integer, WebSocketSession> users = new ConcurrentHashMap<>(100000);

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        users.put(Integer.valueOf(session.getId()), session);
        log.error("===============");
    }

    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        session.sendMessage(new TextMessage("呵呵".getBytes()));
        final TextMessage textMessage = (TextMessage) message;
        users.forEachValue(10, webSocketSession -> {
            try {
                webSocketSession.sendMessage(textMessage);
            } catch (IOException e) {
                log.error("===", e);
            }
        });
        log.error("===============");
    }

    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        log.error("===============");
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        users.remove(Integer.valueOf(session.getId()));
        log.error("===============");
    }

    @Override
    public boolean supportsPartialMessages() {
        log.error("===============");
        return false;
    }
}

JS 客户端

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

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

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

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://127.0.0.1:8080/myHandler?siteId=webtrn&userId=lucy");		
    }
    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>