WebSocket使用@OnMessage注解无法收到消息的坑与解决方法

一、前言

最近新写了一个Java WebSocket后台，用来和前端通信；本来前端通过js是可以成功建立WebSocket连接的，但是前端使用WebSocket发给后台的消息，后台却怎么也收不到。

以下是问题描述与解决办法。

二、问题描述

1.前端建立WebSocket连接的关键代码样例如下：

var msg="abc123";
//var imUrl="wss://10.123.123.123:9999/api/im";
var imUrl="ws://10.123.123.123:9999/api/im";

_createIM(msg){
  this.im = new IM({
    url: imUrl,
    msg
  })
  return this.im.connect()
}

//调用
this._createIM(msg);

这段代码就是前端建立WebSocket连接的方法，同时给后台发送了消息（abc123）。

2.后台关键WebSocket代码样例如下：

@OnOpen
public void onOpen(Session session, EndpointConfig config) throws IOException {
  this.session = (WsSession)session;
  //这句是想把webSocket的Session转换为HttpSession的，但是加了没有用
  //this.httpSession = (HttpSession)config.getUserProperties().get(HttpSession.class.getName());
  
  //打印日志记录
  log.info("webSocket, sessionId : ["+session.getId()+"] 已连接");
}

@OnMessage
public void onMessage(String message) throws IOException{
  log.info("webSocket后台收到消息："+message);
}

3.样例如上，前端js执行后，建立webSocket连接，后台onOpen方法中的log.info会成功打印日志

4.但是，前端发给后台的消息（abc123）、后台并没有收到，后台的onMessage方法并没有打印日志

5.个人从前端js代码中推测，也许消息（abc123）是在建立连接的同时发送给后端的，可能消息在WebSocket的session中；于是各种修改onOpen方法，尝试从Session中获得消息，但是没有成功。

6.个人尝试了把WebSocket的Session转换为HttpSession，但是没有成功，HttpSession一直为null。

三、解决办法

1.通过百度发现，WebSocket有4种消息类型，BinaryMessage，PingMessage，PongMessage，TextMessage

2.打断点查看onOpen中的WebSocket中的Session对象，发现textMessageHandler(MessageHandler类型)是有值的，但是binaryMessageHandler(MessageHandler类型)是null。

3.想办法让binaryMessageHandler不为null，于是增加了如下代码：

@OnMessage
public void onMessage(byte[] message) throws IOException{
  String msg = new String(message, "utf-8");
  log.info("webSocket后台收到消息：" + msg);
}

终于，这样收到消息了；但是消息前半部分为乱码，不知道为什么。

5.优化上方的方法，如下：

@OnMessage
public void onMessage(byte[] message) throws IOException{
  byte[] data = Arrays.copyOfRange(message, 50, message.length);
  String msg = new String(data, "utf-8");
  log.info("webSocket后台收到消息：" + msg);
}

上方代码中对byte数组进行了截取，然后转换为String。

到此，终于成功收到了前端传给后端的消息（abc123）。

四、总结

1.上方代码中，前端建立WebSocket连接的同时给后端发送了消息，但是，与HttpSession不同，WebSocket的Session中并不保存消息。

2.后端使用@OnMessage注解方法接收消息时，需要注意：
(1)如果前端给后端发送的是TextMessage类型的，就这样接收：

@OnMessage
public void onMessage(String message) {}

(2)如果前端给后端发送的是BinaryMessage类型的，就这样接收：

@OnMessage
public void onMessage(byte[] message) {}

(3)PingMessage与PongMessage的发送与接收方法，暂未研究。