SpringBoot集成WebSocket遇到的問題及解決

更新時(shí)間：2023年07月18日 14:42:27 作者：華陽余文樂

這篇文章主要介紹了SpringBoot集成WebSocket遇到的問題及解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。

SpringBoot集成WebSocket遇到的問題

最近在項(xiàng)目中需要使用WebSocket，因?yàn)轫?xiàng)目是使用的SpringBoot架構(gòu)，所以集成比較簡(jiǎn)單。

上代碼：

pom.xml

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

WebSocketServer.java

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
/**
 * web socket 工具類
 *
 * @author alvinqiu
 * @data 2018/10/24
 */
@Slf4j
@Component
@ServerEndpoint(value = "/ws/{type}")
public class WebSocketServer {
    /**
     * concurrent包的線程安全Set，用來存放每個(gè)客戶端對(duì)應(yīng)的Session對(duì)象
     */
    private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();
    @OnOpen
    public void onOpen(@PathParam("type") String type, Session session) {
        SessionSet.add(session);
        log.info("WebSocket有連接加入, 請(qǐng)求的數(shù)據(jù)類型為: " + type);
        try {
            sendMessage("Hello WebSocket " + type);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    @OnClose
    public void onClose(Session session) {
        SessionSet.remove(session);
        log.info("WebSocket有連接關(guān)閉");
    }
    @OnError
    public void onError(Throwable error) {
        log.info("WebSocket發(fā)生錯(cuò)誤, 原因: " + error.getMessage());
    }
    @OnMessage
    public void onMessage(String message) {
        log.info("收到來自WebSocket客戶端的消息: " + message);
    }
    /**
     * 發(fā)送消息給客戶端
     *
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException {
        for (Session session : SessionSet) {
            if (session.isOpen()) {
                session.getBasicRemote().sendText(message);
            }
        }
    }
}

WebSocketConfig.java

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
 * web socket 配置類
 *
 * @author alvinqiu
 * @data 2018/10/24
 */
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

客戶端就不寫了，上面的代碼也沒什么好說的，相當(dāng)簡(jiǎn)單，項(xiàng)目跑起來就完事兒咯

結(jié)果就這簡(jiǎn)單玩意兒出現(xiàn)了問題

項(xiàng)目運(yùn)行

java.lang.IllegalStateException: Failed to register @ServerEndpoint class: class com.xxx.WebSocketServer$$EnhancerBySpringCGLIB$$62689f33

javax.websocket.DeploymentException: Cannot deploy POJO class [com.xxx.WebSocketServer$$EnhancerBySpringCGLIB$$62689f33] as it is not annotated with @ServerEndpoint

報(bào)錯(cuò)了？怎么會(huì)呢，這么簡(jiǎn)單的一個(gè)玩意兒，網(wǎng)上的教程不都是這么干的嗎

研究下錯(cuò)誤，標(biāo)注了@ServerEndPoint注解的類注冊(cè)失敗，百思不得其解，百度谷歌一番，什么jdk版本、tomcat版本、需不需要注入ServerEndpointExporter等等等等，我項(xiàng)目情況都不是（jdk1.8、tomcat8+、springboot內(nèi)置容器）

后來想想是否因?yàn)轫?xiàng)目是多模塊結(jié)構(gòu)的原因，可能是jar包沖突、循環(huán)依賴，什么可能都想過，然后新建了一個(gè)springboot項(xiàng)目，只集成websocket試試，結(jié)果是正常運(yùn)行的，版本一致，環(huán)境一致，代碼一致，問題看來出在項(xiàng)目本身了

項(xiàng)目結(jié)構(gòu)

父工程
A 模塊（啟動(dòng)模塊，依賴了其他所有子模塊，一些公共的配置類）
B 模塊（業(yè)務(wù)模塊）
...
...
Q 模塊（WebSocket模塊）

難道是WebSocket作為一個(gè)單獨(dú)模塊出的飛機(jī)？這么扯的理由我也不管了，還是把它挪到了A 模塊去，結(jié)果問題依舊....

前后折騰了很久，終于決定跟跟源碼

恩，就是這里annotation為null，至于為何為null還是不知道，突發(fā)奇想去看看另一個(gè)springboot項(xiàng)目（成功案例），

恩，annotation是有值的

發(fā)現(xiàn)了pojo的區(qū)別

（報(bào)錯(cuò)）

class com.xxx.websocket.WebSocketServer$$EnhancerBySpringCGLIB$$62689f33

（成功）

class com.xxx.websocket.WebSocketServer

后面那一串是代表類被cglib轉(zhuǎn)換為了代理對(duì)象，什么情況下會(huì)被轉(zhuǎn)換為代理對(duì)象？

AOP！AOP！AOP！

簡(jiǎn)直是如夢(mèng)初醒，虎軀一震

我的 A 模塊里是寫了一個(gè)全局的log日志切面

大概是這樣：

/**
 * 日志切面
 *
 * @author alvinqiu
 * @date 2018/09/28
 */
@Slf4j
@Aspect
@Component
public class AspectLog {
    @Pointcut("execution(* com.xxx..*.*(..))")
    public void aspectLog() {
    }
    @Pointcut("execution(* com.xxx.api..*.*(..))")
    public void aspectApiLog() {
    }
    @Pointcut("execution(* com.xxx.service..*.*(..))")
    public void aspectServiceLog() {
    }
    @Pointcut("execution(* com.xxx.mapper..*.*(..))")
    public void aspectMapperLog() {
    }
    ...
    ...
}

問題找出來咯，WebSocketServer這個(gè)類被切咯，以至于@ServerEndPoint注解無法注入至對(duì)應(yīng)的對(duì)象，導(dǎo)致報(bào)錯(cuò)