目录
1 Websocket的定义及一些使用场景
2 使用方法
2.1 导入依赖坐标
2.2 创建WebSocket服务
2.3 编写配置类注册WebSocket
2.4 在需要处使用WebSocket服务
1 Websocket的定义及一些使用场景
定义:Websocket实现了浏览器与服务器全双工通信一浏览器和服务器只需要完成WebSocket 是基于 TCP 的一种新的网络协议。一次握手,两者之间就可以创建持久性的连接,并进行双向数据传输。(来自黑马程序员)
使用场景:商家端用户催单的提醒、商家端用户下订单的提醒……
2 使用方法
2.1 导入依赖坐标
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
2.2 创建WebSocket服务
模板,可以直接使用,如下:
@Slf4j
@Component //交给Spring容器管理
@ServerEndpoint("/ws/{sid}") //访问路径
public class WebSocketServer {//存放会话对象private static Map<String, Session> sessionMap = new HashMap();/*** 连接建立成功调用的方法*/@OnOpenpublic void onOpen(Session session, @PathParam("sid") String sid) {log.info("客户端:{}建立连接", sid);sessionMap.put(sid, session);}/*** 收到客户端消息后调用的方法** @param message 客户端发送过来的消息*/@OnMessagepublic void onMessage(String message, @PathParam("sid") String sid) {log.info("收到来自客户端:{}的信息:{}", sid, message);}/*** 连接关闭调用的方法** @param sid*/@OnClosepublic void onClose(@PathParam("sid") String sid) {log.info("连接断开:{}", sid);sessionMap.remove(sid);}/*** 群发,主要功能代码** @param message*/public void func(String message) {Collection<Session> sessions = sessionMap.values();for (Session session : sessions) {try {//服务器向客户端发送消息session.getBasicRemote().sendText(message);} catch (Exception e) {e.printStackTrace();}}}}
2.3 编写配置类注册WebSocket
也是模板代码,没啥好说的,如下:
@Configuration
public class WebSocketConfiguration {@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}}
2.4 在需要处使用WebSocket服务
比如我们可以在用户完成支付之后,通过Websocket给商家端发送来单提醒。
@Service
public class OrderServiceImpl implements OrderService {@Autowiredprivate WebSocketServer webSocketServer;public void paySuccess(String outTradeNo) {//其它代码...//websocket向客户端发送消息Map map = new HashMap<>();//添加的内容String jsonString = JSON.toJSONString(map);webSocketServer.sendToAllClient(jsonString);}}