• HTTP 协议有一个缺陷:通信只能由客户端发起,HTTP 协议做不到服务器主动向客户端推送信息。

springboot2.0

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

WebSocketConfig

/**
 * 
 * @see socket配置类
 *
 */
@Configuration
public class WebSocketConfig {

 @Bean  
    public ServerEndpointExporter serverEndpointExporter() {  
        return new ServerEndpointExporter();  
    }  
}

WebSocketServer

  • 因为WebSocket是类似客户端服务端的形式(采用ws协议),那么这里的WebSocketServer其实就相当于一个ws协议的Controller

  • 直接@ServerEndpoint("/imserver/{userId}") 、@Component启用即可,然后在里面实现@OnOpen开启连接,@onClose关闭连接,@onMessage接收消息等方法。

  • 新建一个ConcurrentHashMap webSocketMap 用于接收当前userId的WebSocket,方便IM之间对userId进行推送消息。单机版实现到这里就可以。


import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@ServerEndpoint("/imserver/{userId}")
@Component
public class SocketServer {

 static Logger log = LoggerFactory.getLogger(SocketServer.class);
 /** 静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。 */
 private static int onlineCount = 0;
 /** concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。 */
 private static ConcurrentHashMap<String, SocketServer> webSocketMap = new ConcurrentHashMap<>();
 /** 与某个客户端的连接会话,需要通过它来给客户端发送数据 */
 private Session session;
 /** 接收userId */
 private String userId = "";

 /**
  * 连接建立成功调用的方法
  */
 @OnOpen
 public void onOpen(Session session, @PathParam("userId") String userId) {
  this.session = session;
  this.userId = userId;
  if (webSocketMap.containsKey(userId)) {
   webSocketMap.remove(userId);
   webSocketMap.put(userId, this);
   // 加入set中
  } else {
   webSocketMap.put(userId, this);
   // 加入set中
   addOnlineCount();
   // 在线数加1
  }

  log.info("用户连接:" + userId + ",当前在线人数为:" + getOnlineCount());

  try {
   sendMessage("连接成功");
  } catch (IOException e) {
   log.error("用户:" + userId + ",网络异常!!!!!!");
  }
 }

 /**
  * 连接关闭调用的方法
  */
 @OnClose
 public void onClose() {
  if (webSocketMap.containsKey(userId)) {
   webSocketMap.remove(userId);
   // 从set中删除
   subOnlineCount();
  }
  log.info("用户退出:" + userId + ",当前在线人数为:" + getOnlineCount());
 }

 /**
  * 收到客户端消息后调用的方法
  *
  * @param message 客户端发送过来的消息
  */
 @OnMessage
 public void onMessage(String message, Session session) {
  log.info("用户消息:" + userId + ",报文:" + message);
  // 可以群发消息
  // 消息保存到数据库、redis
  if (StringUtils.isNotBlank(message)) {
   try {
    // 解析发送的报文
    JSONObject jsonObject = JSON.parseObject(message);
    // 追加发送人(防止串改)
    jsonObject.put("fromUserId", this.userId);
    String toUserId = jsonObject.getString("toUserId");
    // 传送给对应toUserId用户的websocket
    if (StringUtils.isNotBlank(toUserId) && webSocketMap.containsKey(toUserId)) {
     webSocketMap.get(toUserId).sendMessage(jsonObject.toJSONString());
    } else {
     log.error("请求的userId:" + toUserId + "不在该服务器上");
     // 否则不在这个服务器上,发送到mysql或者redis
    }
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
 }

 /**
  *
  * @param session
  * @param error
  */
 @OnError
 public void onError(Session session, Throwable error) {
  log.error("用户错误:" + this.userId + ",原因:" + error.getMessage());
  error.printStackTrace();
 }

 /**
  * 实现服务器主动推送
  */
 public void sendMessage(String message) throws IOException {
  this.session.getBasicRemote().sendText(message);
 }

 /**
  * 发送自定义消息
  */
 public static void sendInfo(String message, @PathParam("userId") String userId) throws IOException {
  log.info("发送消息到:" + userId + ",报文:" + message);
  if (StringUtils.isNotBlank(userId) && webSocketMap.containsKey(userId)) {
   webSocketMap.get(userId).sendMessage(message);
  } else {
   log.error("用户" + userId + ",不在线!");
  }
 }

 public static synchronized int getOnlineCount() {
  return onlineCount;
 }

 public static synchronized void addOnlineCount() {
  SocketServer.onlineCount++;
 }

 public static synchronized void subOnlineCount() {
  SocketServer.onlineCount--;
 }
}

消息推送

@RequestMapping("/push/{toUserId}")
 public ResponseEntity<String> pushToWeb(String message, @PathVariable String toUserId) throws IOException {
  SocketServer.sendInfo(message, toUserId);
  return ResponseEntity.ok("MSG SEND SUCCESS");
 }