概述

WebSocket 是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器的全双工通信——浏览器和服务器只需要完成一次握手,两者之间就可以创建持久性的连接, 并进行双向数据传输

HTTP协议和WebSocket协议对比:

  • HTTP和WebSocket底层都是TCP连接
  • HTTP是短连接;WebSocket是长连接
  • HTTP通信是单向的,基于请求响应模式;WebSocket支持双向通信

8d08958d-12c1-49b0-8548-eb89e0c51fee

思考:既然WebSocket支持双向通信,功能看似比HTTP强大,那么是不是可以基于WebSocket开发所有的业务功能?

WebSocket的缺点

服务器长期维护长连接需要一定的成本

各个浏览器支持程度不一

WebSocket 是长连接,受网络限制比较大,需要处理好重连

结论:WebSocket并不能完全取代HTTP,它只适合在特定的场景下使用

使用场景

  1. 视频弹幕

baeac821-4adb-4968-98f4-a56e555b10a8

  1. 网页聊天

38421c39-adf1-4d2c-b708-d49e17a38208

  1. 体育实况更新

697c700e-3b69-4de2-b022-97e96854cc0a

入门案例

需求说明:实现浏览器与服务器全双工通信。浏览器既可以向服务器发送消息,服务器也可主动向浏览器推送消息

c41b7d27-6e29-493d-952c-8eb53f3e054d

流程如下:

c7cf7741-f055-415b-a26a-c264aaa3eca6

  • 需要准备客户端,可以在浏览器上编写客户端
  • 服务端,使用java代码实现,启动一个服务
  • 客户端与服务端连接成功以后
    • 客户端可以发送数据到服务器端
    • 服务器端也可以发送数据到客户端(浏览器)

功能实现:

客户端

定义websocket.html页面充当客户端(资料中已提供)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!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);

// 判断当前浏览器是否支持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>

服务端

然后导入依赖

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

定义配置类,注册WebSocket的服务端组件(资料中已提供)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.itheima.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 {

/**
* 注册基于@ServerEndpoint声明的Websocket Endpoint
* @return
*/
@Bean
public ServerEndpointExporter serverEndpointExporter(){
return new ServerEndpointExporter();
}

}

定义WebSocket服务端组件(资料中已提供)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
package com.itheima.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

@Slf4j
@Component
@ServerEndpoint("/ws/{sid}")
public class WebSocketServer {

private static Map<String,Session> sessionMap = new HashMap<>();

/**
* 连接建立时触发
* @param session
* @param sid
*/
@OnOpen
public void onOpen(Session session , @PathParam("sid") String sid){
log.info("有客户端连接到了服务器 , {}", sid);
sessionMap.put(sid, session);
}

/**
* 服务端接收到消息时触发
* @param session
* @param message
* @param sid
*/
@OnMessage
public void onMessage(Session session , String message, @PathParam("sid") String sid){
log.info("接收到了客户端 {} 发来的消息 : {}", sid ,message);
}

/**
* 连接关闭时触发
* @param session
* @param sid
*/
@OnClose
public void onClose(Session session , @PathParam("sid") String sid){
System.out.println("连接断开:" + sid);
sessionMap.remove(sid);
}

/**
* 通信发生错误时触发
* @param session
* @param sid
* @param throwable
*/
@OnError
public void onError(Session session , @PathParam("sid") String sid , Throwable throwable){
System.out.println("出现错误:" + sid);
throwable.printStackTrace();
}

/**
* 广播消息
* @param message
* @throws IOException
*/
public void sendMessageToAll(String message) throws IOException {
Collection<Session> sessions = sessionMap.values();
if(!CollectionUtils.isEmpty(sessions)){
for (Session session : sessions) {
//服务器向客户端发送消息
session.getBasicRemote().sendText(message);
}
}
}
}

定义定时任务类,定时向客户端推送数据

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package com.itheima.job;

import com.itheima.config.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.time.LocalDateTime;

/**
* @author sjqn
*/
@Component
public class MessageTask {

@Autowired
private WebSocketServer webSocketServer;

@Scheduled(cron = "0/5 * * * * ?")
public void sendMessageToAllClient() throws IOException {
webSocketServer.sendMessageToAll("Hello Client , Current Server Time : " + LocalDateTime.now());
}
}