js封裝一個websocket
建立websocket.js
let Socket = '' let setIntervalWesocketPush = null/**
- 建立websocket連線
- @param {string} url ws地址
*/
export const createSocket = url => {
Socket && Socket.close()
if (!Socket) {
console.log('建立websocket連線')
Socket = new WebSocket(url)
Socket.onopen = onopenWS
Socket.onmessage = onmessageWS
Socket.onerror = onerrorWS
Socket.onclose = oncloseWS
} else {
console.log('websocket已連線')
}
}/**開啟WS之後傳送心跳 */
const onopenWS = () => {
sendPing()
}/**連線失敗重連 */
const onerrorWS = () => {
Socket.close()
clearInterval(setIntervalWesocketPush)
console.log('連線失敗重連中')
if (Socket.readyState !== 3) {
Socket =null
createSocket()
}
}/**WS資料接收統一處理 */
const onmessageWS = e => {
window.dispatchEvent(new CustomEvent('onmessageWS', {
detail: {
data: e.data
}
}))
}/**
- 傳送資料但連線未建立時進行處理等待重發
- @param {any} message 需要傳送的資料
*/
const connecting = message => {
setTimeout(() => {
if (Socket.readyState === 0) {
connecting(message)
} else {
Socket.send(JSON.stringify(message))
}
}, 1000)
}/**
- 傳送資料
- @param {any} message 需要傳送的資料
*/
export const sendWSPush = message => {
if (Socket ! null && Socket.readyState = 3) {
Socket.close()
createSocket()
} else if (Socket.readyState = 1) {
Socket.send(JSON.stringify(message))
} else if (Socket.readyState = 0) {
connecting(message)
}
}/斷開重連 */
const oncloseWS = () => {
clearInterval(setIntervalWesocketPush)
console.log('websocket已斷開....正在嘗試重連')
if (Socket.readyState !== 2) {
Socket = null
createSocket()
}
}
/傳送心跳
- @param {number} time 心跳間隔毫秒 預設5000
- @param {string} ping 心跳名稱 預設字串ping
*/
export const sendPing = (time = 5000, ping = 'ping') => {
clearInterval(setIntervalWesocketPush)
Socket.send(ping)
setIntervalWesocketPush = setInterval(() => {
Socket.send(ping)
}, time)
}
下載 (也可複製原始碼，放在本地，使用方式相同)
npm install @sven0706/websocket -S
使用
// 在main.js或需要使用的地方引入並建立連線 import { createSocket } from '@sven0706/websocket' createSocket('wss://api.baidu.com')// 傳送訊息
import { sendWSPush } from '@sven0706/websocket'
sendWSPush(data)// 接收訊息
const getsocketData = e => { // 建立接收訊息函式
const data = e && e.detail.data
console.log(data)
}
// 註冊監聽事件
window.addEventListener('onmessageWS', getsocketData)// 在需要的時候解除安裝監聽事件，比如離開頁面
window.removeEventListener('onmessageWS', getsocketData)
API
僅三個api, 且一般只需要用到`createSocket`, `sendWSPush`
/**
- 建立websocket連線
- @param {string} url ws地址
*/
createSocket(url)
/**
- 傳送資料
- @param {any} message 需要傳送的資料
*/
sendWSPush(message)
/**傳送心跳
- @param {number} time 心跳間隔毫秒 預設5000
@param {string} ping 心跳名稱 預設字串ping
*/
sendPing()