1. 介绍
WebSocket是基于 TCP 的一种新的网络协议，它实现了浏览器与服务器全双工通信——浏览器和服务器只需要握手成功，两者之间就可以创建持久性的连接， 并进行双向数据传输。
但是WebSocket并不能完全取代HTTP，它只适合在特定的场景下使用。
2 WebSocket和HTTP对比
-
WebSocket是长连接；而HTTP是短连接
-
WebSocket支持双向通信；而HTTP通信是单向主动的，基于请求响应模式
-
HTTP和WebSocket底层都是TCP连接
3 WebSocket缺点
-
服务器长期维护长连接需要一定的成本
-
各个浏览器支持程度不一；服务器的支持程度也不同
-
WebSocket 是长连接，受网络限制比较大，需要处理好重连
4 WebSocket应用场景
实时性要求较高的场景
-
适合使用WebSocket通信：服务端什么时候有新数据，什么时候主动向客户端推送即可
-
不推荐的方式：仍然使用HTTP。比如客户端每隔1s，向服务端发请求，查询最新的数据并显示到页面上
5 SpringBoot整合WebSocket使用步骤
准备服务端：
-
创建Server端类：
创建Java类，类上加
@Component，交给Spring管理类上加
@ServerEndPoint("访问路径")，声明这是一个WebSocket服务端程序。客户端可以通过此路径与服务端连接并通信-
@OnOpen：加在方法上，此方法将会在 客户端与服务端连接成功时 执行 -
@OnMessage：加在方法上，此方法将会在 客户端传递消息过来时 执行 -
@OnClose：加在方法上，此方法将会在 客户端与服务端断开连接时 执行 -
@OnError：加在方法上，此方法将会在 连接出错时 执行
-
-
创建配置类
类上加
@Configuration在配置类里创建方法，使用
@Bean方式把ServerEndpointExporter对象注册到Spring容器里
准备客户端：
-
使用js，创建WebSocket对象
6. 入门案例
1 案例分析
需求：实现浏览器与服务器全双工通信。浏览器既可以向服务器发送消息，服务器也可主动向浏览器推送消息。
效果展示：
实现步骤：
1). 直接使用websocket.html页面作为WebSocket客户端
2). 导入WebSocket的maven坐标
3). 导入WebSocket服务端组件WebSocketServer，用于和客户端通信
4). 导入配置类WebSocketConfiguration，注册WebSocket的服务端组件
5). 导入定时任务类WebSocketTask，定时向客户端推送数据
2 代码开发
1 准备前端页面
定义websocket.html页面，不需要加到项目里，放到桌面上直接双击打开就行
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>WebSocket Demo</title>
</head>
<body>
<input id="text" type="text" />
<button onclick="send()">发送消息</button>
<button onclick="closeWebSocket()">关闭连接</button>
<div id="message">
</div>
</body>
<script type="text/javascript">
var websocket = null;
var clientId = Math.random().toString(36).substr(2);
document.getElementById("message").innerHTML = "你的id是：" + clientId + "<br/>";
//判断当前浏览器是否支持WebSocket
if('WebSocket' in window){
//连接WebSocket节点
websocket = new WebSocket("ws://localhost:8080/ws/"+clientId);
}
else{
alert('Not support websocket')
}
//连接发生错误的回调方法
websocket.onerror = function(){
setMessageInnerHTML("error");
};
//连接成功建立的回调方法
websocket.onopen = function(){
setMessageInnerHTML("连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function(event){
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function(){
setMessageInnerHTML("close");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function(){
websocket.close();
}
//将消息显示在网页上
function setMessageInnerHTML(innerHTML){
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
//发送消息
function send(){
var message = document.getElementById('text').value;
websocket.send(message);
}
//关闭连接
function closeWebSocket() {
websocket.close();
}
</script>
</html>
2 准备服务端代码
导入maven坐标
在sky-server模块pom.xml中已定义
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
3 定义WebSocket服务端组件
直接导入到sky-server模块即可
package com.sky.websocket;
import org.springframework.stereotype.Component;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* WebSocket服务
*/
@Component
@ServerEndpoint("/ws/{sid}")
public class WebSocketServer {
//存放会话对象
private static Map<String, Session> sessionMap = new HashMap();
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session, @PathParam("sid") String sid) {
System.out.println("客户端：" + sid + "建立连接");
sessionMap.put(sid, session);
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, @PathParam("sid") String sid) {
System.out.println("收到来自客户端：" + sid + "的信息:" + message);
sendToAllClient(sid + "说： " + message);
}
/**
* 连接关闭调用的方法
*
* @param sid
*/
@OnClose
public void onClose(@PathParam("sid") String sid) {
System.out.println("连接断开:" + sid);
sessionMap.remove(sid);
}
/**
* 群发
*
* @param message
*/
public void sendToAllClient(String message) {
Collection<Session> sessions = sessionMap.values();
for (Session session : sessions) {
try {
//服务器向客户端发送消息
session.getBasicRemote().sendText(message);
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
4 定义配置类
注册WebSocket的服务端组件
package com.sky.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket配置类，用于注册WebSocket的Bean
*/
@Configuration
public class WebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
5 定义定时任务类，定时向客户端推送数据
package com.sky.task;
import com.sky.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@Component
public class WebSocketTask {
@Autowired
private WebSocketServer webSocketServer;
/**
* 通过WebSocket每隔5秒向客户端发送消息
*/
@Scheduled(cron = "0/5 * * * * ?")
public void sendMessageToClient() {
webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
}
}
3功能测试
启动服务，打开websocket.html页面
浏览器向服务器发送数据：
7. 小结
WebSocket是什么
是基于TCP协议的一种 双向通信的网络协议。允许客户端和服务端之间建立长连接，双方都可以主动发送消息给对方
WebSocket和HTTP的对比：
都是基于TCP协议的网络协议
WebSocket基于长连接的；HTTP基于短连接
WebSocket是双向通信；HTTP是基于请求响应，有请求才会有响应
WebSocket的缺点：
需要服务端维护长连接，成本更高一些
浏览器和服务器的支持程度不确定
还需要处理连接断开与重连的情况
什么情况下适合使用WebSocket：
客户端要求查询的数据，实时性较高的情况
WebSocket的使用步骤：
服务端：
创建服务器程序，创建一个类
类上：加@Component， @ServerEndpoint("访问路径")
类里：加方法
@OnOpen：方法将会在 客户端和服务端 建立连接时执行。方法里可以加参数
Session：封装了客户端和服务端的会话信息，通过这个对象可以给客户端发送消息
如果要接收路径变量值：@PathParam("占位符名称")
@OnMessage：方法将会在 收到消息的时候执行。方法上可以加形参
String：接收得到的消息内容
可以使用@PathParam获取参数
@OnClose：方法将会在 断开连接时执行
可以使用@PathParam获取参数
@OnError：方法将会在 出错时执行
如果要给客户端发送消息：利用session对象
session.getBasicRemote().sendText(String content);session.getBasicRemote（）.sendText（String content）;
客户端：
参考资料里的代码即可
扫一扫
777
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
