Websocket初识与聊天室Demo
写在前面
前段时间有个面试,被问到如果要做web端登录保持一端可用,即在多个浏览器登录时,要将前一次登录的信息及时踢出。当时我说了两种方案:第一种 是用ajax轮询服务器,第二种就是websocket。第一种是我刚毕业那会的实施方案,有过相关经验,第二种是之前了解过,但没有实际的开发经验。面试完后,我就想深入去了解一下websocket,然后写一些案例巩固一下。
什么是websocket
WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455,并由RFC7936补充规范。WebSocket API也被W3C定为标准。
WebSocket使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。(百度百科)
** 其实,websocket就是http5 后升级出来的一个协议,它即有http协议的特性,也有socket协议的特性。是两者的交集。http是无状态的协议,且只能主动去请求服务器的数据,websocket则保持连接,服务器可以主动推送数据给浏览器。**
WebSocket案例一:简单聊天室
在大学学JAVA的时候,那时候刚接触了socket编码,然后就写了简易的聊天室。不过基本上是通过win 的cmd命令来进行,今天,也准备用这个小案来实现一下。
主要技术栈为:
- JDK 1.8
- maven 3.3.9
- springboot 2.2.7.RELEASE
- springboot websocket
Maven 依赖
SpringBoot2.0 + 对WebSocket 已经支持 ,直接添加相关依赖即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
WebSocketConfig配置
package com.keyingbo.websocket.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
WebSocketChatRoomServer
服务端接收请求的主要配置类:
-
因为WebSocket是类似客户端服务端的形式(采用ws协议),那么这里的WebSocketServer其实就相当于一个ws协议的Controller
-
直接
@ServerEndpoint("/websocketChatRoom/{userId}")
、@Component
启用即可,然后在里面实现@OnOpen
开启连接,@onClose
关闭连接,@onMessage
接收消息等方法。 -
新建一个ConcurrentHashMap webSocketMap 用于接收当前userId的WebSocket,方便之间对userId进行推送消息。
package com.keyingbo.websocket.server;
import com.alibaba.fastjson.JSON;
import com.keyingbo.websocket.dto.UserMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
/**
* 简易聊天室服务端代码
* @ServerEndpoint
* 注解是一个类层次的注解,它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
*/
@ServerEndpoint("/websocketChatRoom/{userId}")
@Component
public class WebSocketChatRoomServer {
static Logger logger = LoggerFactory.getLogger(WebSocketChatRoomServer.class);
//静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
private static final AtomicInteger OnlineCount = new AtomicInteger(0);
//concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话,可以使用Map来存放,其中Key可以为用户标识
private static ConcurrentHashMap<String, WebSocketChatRoomServer> webSocketSet = new ConcurrentHashMap<String, WebSocketChatRoomServer>();
//与某个客户端的连接会话,需要通过它来给客户端发送数据
private Session WebSocketsession;
//当前发消息的人员userId
private String userId = "";
/**
* 连接建立成功调用的方法*/
@OnOpen
public void onOpen(@PathParam(value = "userId") String param, Session WebSocketsession, EndpointConfig config) {
userId = param;
//log.info("authKey:{}",authKey);
this.WebSocketsession = WebSocketsession;
webSocketSet.put(param, this