WebSocket 的 简介:WebSocket 是一种在单个 TCP 连接上进行 全双工 通信的协议。
初次接触 WebSocket 的人,都会问同样的问题:我们已经有了 HTTP 协议,为什么还需要另一个 协议?它能带来什么好处?
答案很简单,因为 HTTP 协议有一个缺陷:通信只能由客户端发起。
举例来说,我们想了解今天的天气,只能是客户端向服务器发出请求,服务器返回查询结果。HTTP 协议做不到服务器主动向客户端推送信息。
这种单向请求的特点,注定了如果服务器有连续的状态变化,客户端要获知就非常麻烦。我们只能使用"轮询":每隔一段时候,就发出一个询问,了解服务器有没有新的信息。最典型的场景就是聊天室。
轮询的效率低,非常浪费资源(因为必须不停连接,或者 HTTP 连接始终打开)。因此,工程师们一直在思考,有没有更好的方法。WebSocket 就是这样发明的。
简介:
WebSocket 协议在2008年诞生,2011年成为国际标准。所有浏览器都已经支持了。
它的最大特点就是,服务器可以主动向客户端推送信息,客户端也可以主动向服务器发送信息,是真正的双向平等对话,属于服务器推送技术的一种。
其他特点包括:
(1)建立在 TCP 协议之上,服务器端的实现比较容易。
(2)与 HTTP 协议有着良好的兼容性。默认端口也是80和443,并且握手阶段采用 HTTP 协议,因此握手时不容易屏蔽,能通过各种 HTTP 代理服务器。
(3)数据格式比较轻量,性能开销小,通信高效。
(4)可以发送文本,也可以发送二进制数据。
(5)没有同源限制,客户端可以与任意服务器通信。
(6)协议标识符是ws
(如果加密,则为wss
),服务器网址就是 URL。
废话少说,上代码:
1. 核心包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.corundumstudio.socketio</groupId>
<artifactId>netty-socketio</artifactId>
<version>1.7.17</version>
</dependency>
2. WebSocketConfig
启用WebSocket的支持也是很简单
package com.scrm.order.util;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* @author: wangyy
* @create: 2021/6/23
* @Description: 开启WebSocket支持
* @FileName: WebSocketConfig
* @History:
* @自定义内容:
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter(){
return new ServerEndpointExporter();
}
}
3.WebSocketServer (核心)
package com.scrm.order.handler;
import java.io.IOException;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
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.scrm.member.feign.IMemberClient;
import com.scrm.member.vo.MemberInformationVO;
import com.scrm.order.service.IMallOrderService;
import com.scrm.order.vo.MallOrderVO;
import com.scrm.order.vo.MpGoodsGroupBuyReturnVO;
import lombok.extern.slf4j.Slf4j;
import org.springblade.core.tool.utils.BeanUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
/**
* @author: wangyy
* @create: 2021/6/24
* @Description:
* @FileName: WebSocketServer
* @History:
* @自定义内容:
*/
@Slf4j
@ServerEndpoint("/ws/{goodsId}/{mid}")
@Component
public class WebSocketServer {
@Autowired
private IMallOrderService mallOrderService;
@Resource
private IMemberClient iMemberClient;
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<>();
private static WebSocketServer webSocketServer;
//接收sid
public static Long mid = null;
//
public static Long goodsId = null;
@PostConstruct //通过@PostConstruct实现初始化bean之前进行的操作
public void init() {
webSocketServer = this;
webSocketServer.mallOrderService = this.mallOrderService;
webSocketServer.iMemberClient = this.iMemberClient;
// 初使化时将已静态化的testService实例化
}
/**
* 用来保存websocket连接信息,供统计查询当前连接数使用
*/
private static final ConcurrentMap<String, WebSocketServer> USER_CLIENT_MAP = new ConcurrentHashMap<>();
private Session session;
/**
* 连接建立成功调用的方法
*
* @param session 链接session
*/
@OnOpen
public void onOpen(Session session, @PathParam("goodsId") Long goodsId, @PathParam("mid") Long mid) {
USER_CLIENT_MAP.put(session.getId(), this);
this.session = session;
webSocketSet.add(this);
WebSocketServer.mid = mid;
WebSocketServer.goodsId = goodsId;
// 写自己需要发送的方法
this.sendMessage("发信信息");
}
/**
* 收到客户端消息后调用的方法
*
* @param message 消息内容
* @param session session
*/
@OnMessage
public void onMessage(String message, Session session) {
log.debug("websocket连接onMessage。{},{},{}", message, this.toString(), session.getId());
String key = this.session.getId();
if (!USER_CLIENT_MAP.containsKey(key)) {
this.close();
return;
}
push("token", "收到你的消息:" + message);
}
/**
* 发生异常时的处理
*
* @param session 客户端session
* @param throwable session
*/
@OnError
public void onError(Session session, Throwable throwable) {
if (this.session != null && this.session.isOpen()) {
log.error("websocket连接onError。inputSession:{}-localSession:{}", session.getId(), this.toString(), throwable);
this.close();
} else {
log.debug("已经关闭的websocket连接发生异常!inputSession:{}-localSession:{}", session.getId(), this.toString(), throwable);
}
}
/**
* * 群发自定义消息
* *
*/
public static void sendInfo(String message, @PathParam("mid") Long mid) {
log.info("推送消息到窗口" + mid + ",推送内容:" + message);
for (WebSocketServer item : webSocketSet) {
try {
//这里可以设定只推送给这个sid的,为null则全部推送
if (mid == null) {
item.sendMessage(message);
} else if (item.mid.equals(mid)) {
item.sendMessage(message);
}
} catch (Exception e) {
continue;
}
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
log.debug("websocket连接onClose。{}", this.toString());
webSocketSet.remove(this);
//然后关闭
this.close();
}
public void push(String token, String message) {
if (org.springframework.util.StringUtils.isEmpty(token)) {
throw new RuntimeException("token must not be null. token=" + token + ", message=" + message);
}
if (StringUtils.isEmpty(message)) {
throw new RuntimeException("message must not be null. token=" + token + ", message=" + message);
}
if (!session.isOpen()) {
this.close();
throw new RuntimeException("session is closed. token=" + token + ", message=" + message);
}
//发送消息
this.sendMessage(message);
}
/**
* 推送消息给客户端
*
* @param message 消息内容
*/
private void sendMessage(String message) {
try {
//使用同步块和同步方法发送。看是否能防止产生IllegalStateException异常
//modify by caoshuo at 200506
synchronized (session) {
session.getBasicRemote().sendText(message);
}
} catch (Exception e) {
log.error("websocket连接发送客户端发送消息时异常!{}-{}", message, this.toString(), e);
}
}
/**
* 关闭session连接
*/
private void close() {
//从本机map中移除连接信息
USER_CLIENT_MAP.remove(this.session.getId());
if (session == null) {
log.debug("websocket连接关闭完成。{}", this.toString());
return;
}
try {
if (session.isOpen()) {
session.close();
}
log.info("连接已经关闭");
} catch (IOException e) {
log.error("websocket连接关闭时异常。{}", this.toString(), e);
}
}
public void sendToAll(Map<String, Object> map) {
USER_CLIENT_MAP.values().forEach(item -> {
item.sendMessage(map.toString());
});
}
public static CopyOnWriteArraySet<WebSocketServer> getWebSocketSet() {
return webSocketSet;
}
}
4.定时消息推送
package com.scrm.order.util;
import com.alibaba.fastjson.JSON;
import com.scrm.member.feign.IMemberClient;
import com.scrm.member.vo.MemberInformationVO;
import com.scrm.order.handler.WebSocketServer;
import com.scrm.order.service.IMallOrderService;
import com.scrm.order.vo.MallOrderVO;
import com.scrm.order.vo.MpGoodsGroupBuyReturnVO;
import org.springblade.core.tool.utils.BeanUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* @author: wangyy
* @create: 2021/6/25
* @Description:
* @FileName: TimeTask
* @History:
* @自定义内容:
*/
@Component
@EnableScheduling
public class TimeTask {
@Scheduled(cron = "0/5 * * * * ?") // 每分钟执行一次
public void test() {
System.err.println("********* 定时任务执行 **************");
CopyOnWriteArraySet<WebSocketServer> webSocketSet = WebSocketServer.getWebSocketSet();
webSocketSet.forEach(c -> {
try {
System.out.println("发送完成");
} catch (Exception e) {
e.printStackTrace();
}
});
System.err.println("----------定时任务完成 ---------------");
}
}
5.运行效果
websocket在线测试网址:websocket在线测试 (websocket-test.com)
前端代码,网上很多,自行百度