WebSocket
百度百科
WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455,并由RFC7936补充规范。WebSocket API也被W3C定为标准。
WebSocket使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。
使用场景
当我们需要实现界面展示实时数据的时候,如果采用http轮询会极大浪费http资源。webSocket很好的为我们解决这一问题。
前端
getAccountList: function() {
if(typeof(WebSocket) == "undefined") {
console.log("您的浏览器不支持WebSocket");
return ;
}else {
console.log("您的浏览器支持WebSocket");
}
$("#swiperWrapper .accountRecord").remove();
var url = 'ws://'+location.host+"/webSocket/getAccountList/"+loginType+"/"+selfCode+"/"+queryVillageno;
var socket = new WebSocket(url);
socket.onopen = function () { console.log("websocket已打开"); };
socket.onmessage = function(res) {
console.log("websocket返回结果");
};
//关闭事件
socket.onclose = function() {
console.log("websocket已关闭");
};
//发生了错误事件
socket.onerror = function() {
console.log("websocket发生了错误");
}
},
SpringBoot 后端
依赖引入
<!-- websocket -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
@ServerEndpoint("/webSocket/getAccountList/{loginType}/{selfCode}/{queryVillageno}")
@Component
public class WebSocketAccount {
static Logger logger= LoggerFactory.getLogger(WebSocketUserServer.class);
/**静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。*/
private static int onlineCount = 0;
/**concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。*/
private static ConcurrentHashMap<String,WebSocketAccount> webSocketMap = new ConcurrentHashMap<>();
/**与某个客户端的连接会话,需要通过它来给客户端发送数据*/
private Session session;
/** selfCode : 账号标识码*/
private String selfCode;
/** loginType : 账号类型*/
private String loginType;
/** 小区编号 */
private String villageno;
private String queryVillageno;
/**
* 连接建立成功调用的方法
* return status P: 第一次返回数据接在后面 A: 后续添加数据
*/
@OnOpen
public void onOpen(Session session, @PathParam("selfCode") String selfCode, @PathParam("loginType") String loginType, @PathParam("queryVillageno") String queryVillageno){
this.session = session;
this.loginType = loginType;
this.selfCode = selfCode;
this.queryVillageno = queryVillageno;
if(webSocketMap.containsKey(selfCode)){
webSocketMap.remove(selfCode);
//加入set中
webSocketMap.put(selfCode,this);
}else{
//加入set中
webSocketMap.put(selfCode,this);
//在线数加1
WebSocketAccount.onlineCount++;
}
logger.info("用户连接:"+selfCode+",当前在线人数为:" + onlineCount);
try {
// 逻辑处理 获取用户通行记录
if(villagenoList.size()==0){
logger.info("通行记录查询?");
sendInfo("", selfCode);
}else {
logger.info("通行记录查询!");
sendInfo(json.toString(), selfCode);
}
} catch (IOException e) {
logger.error("用户:"+selfCode+",网络异常!!!!!!");
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
if(webSocketMap.containsKey(selfCode)){
webSocketMap.remove(selfCode);
//从set中删除
WebSocketAccount.onlineCount--;
}
logger.info("用户退出:"+selfCode+",当前在线人数为:" + onlineCount);
}
/**
* 收到客户端消息后调用的方法
* @param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, Session session) throws IOException {
logger.info("OnMessage: 用户消息:"+selfCode+",报文:"+message);
}
/**
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
logger.error("用户错误:"+this.selfCode+",原因:"+error.getMessage());
error.printStackTrace();
}
/**
* 实现服务器主动推送
*/
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 发送自定义消息
* */
public static void sendInfo(String message,@PathParam("selfCode") String selfCode) throws IOException {
logger.info("发送消息到:"+selfCode+",报文:"+message);
if(StringUtils.isNotBlank(selfCode)&&webSocketMap.containsKey(selfCode)&&(!"0".equals(selfCode))){
logger.info("webSocket推送消息:"+selfCode+";webSocketMap:"+webSocketMap.toString());
webSocketMap.get(selfCode).sendMessage(message);
}else{
logger.error("用户"+selfCode+",不在线!");
}
}
}