vue脚手架插件 -- websocket
该插件是基于Vue Cli 扩展的增加websocket功能。
Install
vue add websocket
安装完成之后,会把插件中generator/template
目录下的模板文件添加到项目中,项目启动之后可在store
中获取socket
的连接信息
// 插件目录结构
├── README.md
├── generator # generator(可选)
├── template # 模板
├── src
├── store
├── modules
├── websocket.js
├── mutation-types.js
├── assets
├── js
├── websocket.js
├── index.js
├── index.js # service 插件
├── package.json
├── prompts.js # prompt 文件(可选)
└── ui.js # Vue UI 集成(可选)
tip: 插件安装完成之后,需把assets/js/websocket.js文件
中的url
替换成项目实际使用的地址
Usage
通过URL自动连接
Vue
集成Vuex
Vue
设置 sub-protocol
import VueNativeSock from 'vue-native-websocket'Vue.use(VueNativeSock, 'ws://localhost:9090', { protocol: 'my-protocol' })
启用JSON转换
Vue
message转换成JSON
Vue
自动重连
Vue
手动连接
Vueconst vm = // Connect to the websocket target specified in the configurationvm// Connect to an alternative websocket URL and Options e.g.vm// do stuff with WebSocketsvm
在vue实例中使用
var vm = methods: { // $socket is [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) instance this$socket // or with {format: 'json'} enabled this$socket }
动态监听
// 创建监听this$optionssockets console // 删除监听delete this$optionssocketsonmessage
Vuex集成
SOCKET_ONOPEN(开启socket连接)
SOCKET_ONCLOSE (关闭socket连接)
SOCKET_ONERROR (socket异常)
SOCKET_ONMESSAGE (socket消息)
Vue; Vuex
// mutation-types.js
const SOCKET_ONOPEN = '✅ Socket connected!'
const SOCKET_ONCLOSE = '❌ Socket disconnected!'
const SOCKET_ONERROR = '❌ Socket Error!!!'
const SOCKET_ONMESSAGE = 'Websocket message received'
const SOCKET_RECONNECT = 'Websocket reconnected'
const SOCKET_RECONNECT_ERROR = 'Websocket is having issues reconnecting..'
export {
SOCKET_ONOPEN,
SOCKET_ONCLOSE,
SOCKET_ONERROR,
SOCKET_ONMESSAGE,
SOCKET_RECONNECT,
SOCKET_RECONNECT_ERROR
}
// store.js
import Vue from 'vue'
import Vuex from 'vuex'
import {
SOCKET_ONOPEN,
SOCKET_ONCLOSE,
SOCKET_ONERROR,
SOCKET_ONMESSAGE,
SOCKET_RECONNECT,
SOCKET_RECONNECT_ERROR
} from './mutation-types'
Vue.use(Vuex);
export default new Vuex.Store({
state: {
socket: {
isConnected: false,
message: '',
reconnectError: false,
}
},
mutations: {
[SOCKET_ONOPEN](state, event) {
state.socket.isConnected = true
},
[SOCKET_ONCLOSE](state, event) {
state.socket.isConnected = false
},
[SOCKET_ONERROR](state, event) {
console.error(state, event)
},
// default handler called for all methods
[SOCKET_ONMESSAGE](state, message) {
state.socket.message = message
},
// mutations for reconnect methods
[SOCKET_RECONNECT](state, count) {
console.info(state, count)
},
[SOCKET_RECONNECT_ERROR](state) {
state.socket.reconnectError = true;
}
}
})
// index.js
import store from './store'
import {
SOCKET_ONOPEN,
SOCKET_ONCLOSE,
SOCKET_ONERROR,
SOCKET_ONMESSAGE,
SOCKET_RECONNECT,
SOCKET_RECONNECT_ERROR
} from './mutation-types'
const mutations = {
SOCKET_ONOPEN,
SOCKET_ONCLOSE,
SOCKET_ONERROR,
SOCKET_ONMESSAGE,
SOCKET_RECONNECT,
SOCKET_RECONNECT_ERROR
}
Vue.use(VueNativeSock, 'ws://localhost:9090', {
store: store,
mutations: mutations
})