1.webSocket
WebSocket 使得客戶端和服務器之間的數(shù)據(jù)交換變得更加簡單，允許服務端主動向客戶端推送數(shù)據(jù)。在 WebSocket API 中巩剖，瀏覽器和服務器只需要完成一次握手，兩者之間就直接可以創(chuàng)建持久性的連接，并進行雙向數(shù)據(jù)傳輸暑始。在 WebSocket API 中，瀏覽器和服務器只需要做一個握手的動作婴削，然后廊镜，瀏覽器和服務器之間就形成了一條快速通道。兩者之間就直接可以數(shù)據(jù)互相傳送唉俗。
image.png
2.webSocket屬性
socket.readyState(表連接狀態(tài))
- 0 - 表示連接尚未建立嗤朴。
- 1 - 表示連接已建立，可以進行通信虫溜。
- 2 - 表示連接正在進行關閉雹姊。
- 3 - 表示連接已經(jīng)關閉或者連接不能打開。
Socket.bufferedAmount
- 只讀屬性 bufferedAmount 已被 send() 放入正在隊列中等待傳輸衡楞，但是還沒有發(fā)出的 UTF-8 文本字節(jié)數(shù)吱雏。
3.webSocket事件
- Socket.onopen:連接建立時觸發(fā)
- Socket.onmessage:客戶端接收服務端數(shù)據(jù)時觸發(fā)
- Socket.onerror:通信發(fā)生錯誤時觸發(fā)
- Socket.onclose 連接關閉時觸發(fā)
4.webSocket方法
- Socket.send()：使用連接發(fā)送數(shù)據(jù)
- Socket.close():關閉連接
webSocket實例
后臺代碼
- 添加依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
- WebSocketConfig.java
/**
* WebSocket的配置類
* 開啟了WebSocket支持
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
- WebSocketServer.java
//客戶端向服務器端建立WebSocket連接的url
@ServerEndpoint("/websocket")
@Component
public class WebSocketServer {
//靜態(tài)變量，用來記錄當前在線連接數(shù),可選
private static int onlineCount = 0;
//concurrent包的線程安全Set瘾境，用來存放每個客戶端對應的MyWebSocket對象歧杏，必須
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet
= new CopyOnWriteArraySet<WebSocketServer>();
//與某個客戶端的連接會話，需要通過它來給客戶端發(fā)送數(shù)據(jù),必須
private Session session;
/**
* 連接建立成功調(diào)用的方法
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //將客戶端加入set中
addOnlineCount(); //在線數(shù)加1
System.out.println("有新窗口開始監(jiān)聽,當前在線人數(shù)為"
+ getOnlineCount());
try {
sendMessage("連接成功");
} catch (IOException e) {
System.out.println("WebSocket IO異常");
}
}
/**
* 連接關閉調(diào)用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //從set中刪除
subOnlineCount(); //在線數(shù)減1
System.out.println("有連接關閉寄雀！當前在線人數(shù)為" + getOnlineCount());
}
/**
* 收到客戶端消息后調(diào)用的方法
*
* @param message 客戶端發(fā)送過來的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
System.out.println("收到客戶端的信息:" + message);
//群發(fā)消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
System.out.println("發(fā)生錯誤");
error.printStackTrace();
}
/**
* 實現(xiàn)服務器主動推送
*/
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 群發(fā)自定義消息
*/
public static void sendInfo(String message) throws IOException {
System.out.println("推送消息內(nèi)容:" + message);
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
}
- WebSocketController.java
@RestController
public class WebSocketController {
//推送數(shù)據(jù)接口
@GetMapping("/socket/push")
public String pushMsg(String message) {
try {
WebSocketServer.sendInfo(message);
} catch (IOException e) {
e.printStackTrace();
}
return "success";
}
}
前端
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>websocket示例</title>
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
</head>
<body>
<div id="app">
<h3>消息顯示</h3>
<ul>
<li v-for="(message, index) in messages" :key="index">
{{message}}
</li>
</ul>
<hr>
<h3>發(fā)送消息 </h3>
<input type="text" v-model="sendMsg" />
<button type="button" @click="send">發(fā)送</button>
</div>
<script type="text/javascript">
var socket;
var app = new Vue({
el: '#app',
data: {
messages: [],
sendMsg: ''
},
created: function() {
var _this = this;
//創(chuàng)建WebSocket對象得滤，指定要連接的服務器地址和端口，建立連接
socket = new WebSocket("ws://10.40.209.53:8080/websocket");
//打開連接
socket.onopen = function() {
console.log("Socket已打開");
};
//獲得服務端推送的消息
socket.onmessage = function(msg) {
console.log(msg.data);
_this.messages.push(msg.data);
console.log(_this.messages);
};
//關閉連接
socket.onclose = function() {
console.log("Socket已關閉");
};
//發(fā)送錯誤
socket.onerror = function() {
alert("Socket發(fā)生了錯誤");
}
},
watch: {
// 如果 `messages` 發(fā)生改變盒犹，這個函數(shù)就會運行
messages: function(newMsg, oldMsg) {
this.messages = newMsg;
},
},
methods: {
send: function() {
socket.send(this.sendMsg);
}
}
})
</script>
</body>
</html>
