前言
在 vue 中使用 webSocket 做一個簡單的天氣實時更新模塊。
關於 webSocket 的操作及示例:
- webSocket 連接
- 接收數據
- 重連機制
webSocket
1. 關於 webSocket
webSocket 是 HTML5 開始提供的一種在單個 TCP 連接上進行全雙工通訊的協議。瀏覽器通過 JavaScript 向服務器發出建立 webSocket 連接的請求,連接建立以後,客戶端和服務器端就可以通過 TCP 連接直接交換數據。
當你獲取 Web Socket 連接後,你可以通過 send() 方法來向服務器發送數據,並通過 onmessage 事件來接收服務器返回的數據。
var Socket = new webSocket(url, [protocol] );
protocol 是可選的,指定了可接受的子協議
2. 與 AJAX 輪的區別
現在,很多網站爲了實現推送技術,所用的技術都是 Ajax 輪詢。輪詢是在特定的的時間間隔(如每1秒),由瀏覽器對服務器發出HTTP請求,然後由服務器返回最新的數據給客戶端的瀏覽器。 這種傳統的模式帶來很 明顯的缺點,即瀏覽器需要不斷的向服務器發出請求,然而HTTP請求可能包含較長的頭部,其中真正有效的數據可能只是很小的一部分,顯然這樣會浪費很多的帶寬等資源。
HTML5 定義的 webSocket 協議,能更好的節省服務器資源和帶寬,並且能夠更實時地進行通訊。
3. webSocket 事件
事件 | 事件處理程序 | 備註 |
---|---|---|
open | Socket.onopen | 連接建立時觸發 |
message | Socket.onmessage | 客戶端接收服務端數據時觸發 |
error | Socket.onerror | 通信發生錯誤時觸發 |
close | Socket.onclose | 連接關閉時觸發 |
4. 一個簡單的示例
通過上述簡單介紹,我們來創建一個 webSocket 實例試一下:
function webSocketTest() {
if ("webSocket" in window){
alert("您的瀏覽器支持 webSocket!");
// 打開一個 webSocket
var ws = new webSocket("ws://localhost:8080/test");
ws.onopen = function() {
// webSocket 已連接上,使用 send() 方法發送數據
ws.send("發送數據");
console.log("數據發送中...");
};
ws.onmessage = function (evt) {
// 接收到的數據
var data = evt.data;
console.log("數據已接收...");
};
ws.onerror = function () {
// 連接報錯
console.log('連接報錯...');
}
ws.onclose = function() {
// 關閉 webSocket
console.log("連接已關閉...");
};
} else {
// 瀏覽器不支持 webSocket
alert("您的瀏覽器不支持 webSocket!");
}
}
可以看出,其實 webSocket 使用方法很簡單:
- 判斷瀏覽器是否支持 webSocket;
- 創建一個 webSocket 實例;
- 羅列 webSocket 事件並在相應事件中處理相應業務即可。
在vue中使用方法一樣
天氣更新
此處展示一下前面說過的天氣實時更新效果實現。項目框架爲 vue\element。
基礎代碼
<!-- 佈局 使用的element,直接使用即可 -->
<el-popover
placement="bottom"
:title="weather.title"
trigger="hover"
:content="weather.cont">
<div slot="reference" class="weather">
<img :src="weather.url" alt="">
</div>
</el-popover>
export default {
data() {
return {
weather: {
cityName: '',
title: '--市/--℃',
cont: '--',
weatherCode: '0',
url: ''
}
}
},
methods: {
// 獲取天氣
async getTheWeather() {
// 先通過接口請求一次當前天氣狀況
let res = await this.$Http.getWeather({});
if(res.code === 200) {
// 這裏將接口獲取到的天氣數據放入 data 中的 weather 中即可
...
// 然後打開 websocket 實時接收
this.connectWebSocket();
}
},
// websocket
connectWebSocket (){
let _this = this;
if ("WebSocket" in window) {
console.log("瀏覽器支持 WebSocket!");
// 打開一個 webSocket
let url ='xxxxxxxxxxx'; // 給你提供數據推送的地址
let ws = new webSocket(`ws://${url}`);
// 連接成功
ws.onopen = function () {
// Web Socket 已連接上,使用 send() 方法發送數據
ws.send("這是發送的測試數據");
console.log('連接成功');
};
// 接收數據處理
ws.onmessage = function (evt) {
let received_msg = evt.data;
// 這裏將天氣數據放入 data,然後天氣就更新了
...
};
// 連接報錯
ws.onerror = function () {
console.log('連接報錯...');
}
// 連接關閉
ws.onclose = function () {
// 關閉 websocket
console.log("連接已關閉...");
}
} else {
// 瀏覽器不支持 WebSocket
console.log("您的瀏覽器不支持 WebSocket!");
}
},
},
mounted() {
// 獲取當地天氣
this.getTheWeather();
}
}
圖片素材
天氣圖片信息最好跟後端商量好天氣code值,這樣直接取值替換就完事了。
this.weather.url = require(`@/assets/img/weather/${weatherInfo.weatherCode}@2x.png`);
重連機制
最後,介紹一種重連機制。
簡單的重連機制,直接使用 setTimeout 即可。在連接報錯/連接關閉時,使用定時器定時去重新執行 connectWebSocket 方法來重連即可。但是如此操作可能會存在多個問題,因此找到一種更加優雅的插件來重連——ReconnectingWebSocket
。
ReconnectingWebSocket 其實就是封裝的一個帶有重連機制的 webSocketTest 實例,當連接斷開時,會以一種友好的方式來嘗試重新連接,直到連上爲止。使用方法也比較簡單,直接引入然後創建即可:
// 引入
import ReconnectingWebSocket from '@/util/ReconnectingWebSocket';
export default {
data() {
return {
...
}
},
methods: {
...
connectWebSocket() {
let _this = this;
if ("WebSocket" in window) {
console.log("瀏覽器支持 WebSocket!");
// 打開一個 webSocket
let url ='xxxxxxxxxxx'; // 給你提供數據推送的地址
- let ws = new webSocket(`ws://${url}`); // 扔掉
+ let ws = new ReconnectingWebSocket(`ws://${url}`); // 改成這樣
// 連接成功
ws.onopen = function () {
// Web Socket 已連接上,使用 send() 方法發送數據
ws.send("這是發送的測試數據");
console.log('連接成功');
};
// 接收數據處理
ws.onmessage = function (evt) {
...
};
// 連接報錯
ws.onerror = function () {
console.log('連接報錯...');
}
// 連接關閉
ws.onclose = function () {
// 關閉 websocket
console.log("連接已關閉...");
}
} else {
// 瀏覽器不支持 WebSocket
console.log("您的瀏覽器不支持 WebSocket!");
}
}
}
}
ReconnectingWebSocket 是單個的JS文件,網上搜索即可,或者在【流眸】下回復【21423】即可獲取。