背景
目前成都創(chuàng)新互聯(lián)公司已為近1000家的企業(yè)提供了網(wǎng)站建設(shè)、域名、虛擬主機(jī)、網(wǎng)站托管維護(hù)、企業(yè)網(wǎng)站設(shè)計(jì)、寶興網(wǎng)站維護(hù)等服務(wù),公司將堅(jiān)持客戶導(dǎo)向、應(yīng)用為本的策略,正道將秉承"和諧、參與、激情"的文化,與客戶和合作伙伴齊心協(xié)力一起成長(zhǎng),共同發(fā)展。
有一個(gè)項(xiàng)目,今年12月份開(kāi)始重構(gòu),項(xiàng)目涉及到了socket。但是socket用的是以前一個(gè)開(kāi)發(fā)人員封裝的包(這個(gè)一直被當(dāng)前的成員吐槽為什么不用已經(jīng)千錘百煉的輪子)。因此,趁著這個(gè)重構(gòu)的機(jī)會(huì),將vue-socket.io引入,后端就用socket.io。我也好奇看了看vue-socket.io的源碼(我不會(huì)說(shuō)是因?yàn)檫@個(gè)庫(kù)的文檔實(shí)在太簡(jiǎn)略了,我為了穩(wěn)點(diǎn)去看源碼了解該怎么用)
開(kāi)始
文件架構(gòu)
我們主要看src下的三個(gè)文件,可以看出該庫(kù)是用了觀察者模式
Main.js
// 這里創(chuàng)建一個(gè)observe對(duì)象,具體做了什么可以看Observer.js文件 let observer = new Observer(connection, store) // 將socket掛載到了vue的原型上,然后就可以 // 在vue實(shí)例中就可以this.$socket.emit('xxx', {}) Vue.prototype.$socket = observer.Socket;
import store from './yourstore' Vue.use(VueSocketio, socketio('http://socketserver.com:1923'), store);
我們?nèi)绻褂眠@個(gè)庫(kù)的時(shí)候,一般是這樣寫(xiě)的代碼(上圖2)。上圖一的connection和store就分別是圖二的后兩個(gè)參數(shù)。意思分別為socket連接的url和vuex的store啦。圖一就是將這兩個(gè)參數(shù)傳進(jìn)Observer,新建了一個(gè)observe對(duì)象,然后將observe對(duì)象的socket屬性掛載在Vue原型上。那么我們?cè)赩ue的實(shí)例中就可以直接 this.$sockets.emit('xxx', {})了
// 👇就是在vue實(shí)例的生命周期做一些操作 Vue.mixin({ created(){ let sockets = this.$options['sockets'] this.$options.sockets = new Proxy({}, { set: (target, key, value) => { Emitter.addListener(key, value, this) target[key] = value return true; }, deleteProperty: (target, key) => { Emitter.removeListener(key, this.$options.sockets[key], this) delete target.key; return true } }) if(sockets){ Object.keys(sockets).forEach((key) => { this.$options.sockets[key] = sockets[key]; }); } }, /** * 在beforeDestroy的時(shí)候,將在created時(shí)監(jiān)聽(tīng)好的socket事件,全部取消監(jiān)聽(tīng) * delete this.$option.sockets的某個(gè)屬性時(shí),就會(huì)將取消該信號(hào)的監(jiān)聽(tīng) */ beforeDestroy(){ let sockets = this.$options['sockets'] if(sockets){ Object.keys(sockets).forEach((key) => { delete this.$options.sockets[key] }); } }
下面就是在Vue實(shí)例的生命周期做一些操作。創(chuàng)建的時(shí)候,將實(shí)例中的$options.sockets的值先緩存下來(lái),再將$options.sockets指向一個(gè)proxy對(duì)象,這個(gè)proxy對(duì)象會(huì)攔截外界對(duì)它的賦值和刪除屬性操作。這里賦值的時(shí)候,鍵就是socket事件,值就是回調(diào)函數(shù)。賦值時(shí),就會(huì)監(jiān)聽(tīng)該事件,然后將回調(diào)函數(shù),放進(jìn)該socket事件對(duì)應(yīng)的回調(diào)數(shù)組里。刪除時(shí),就是取消監(jiān)聽(tīng)該事件了,將賦值時(shí)壓進(jìn)回調(diào)數(shù)組的那個(gè)回調(diào)函數(shù),刪除,表示,我不監(jiān)聽(tīng)了。這樣寫(xiě)法,其實(shí)就跟vue的響應(yīng)式一個(gè)道理。也因此,我們就可以動(dòng)態(tài)地添加和移除監(jiān)聽(tīng)socket事件了,比如this.$option.sockets.xxx = () => ()和 delete this.$option.sockets.xxx。最后將緩存的值,依次賦值回去,那么如下圖的寫(xiě)法就會(huì)監(jiān)聽(tīng)到事件并執(zhí)行回調(diào)函數(shù)了:
var vm = new Vue({ sockets:{ connect: function(){ console.log('socket connected') }, customEmit: function(val){ console.log('this method was fired by the socket server. eg: io.emit("customEmit", data)') } }, methods: { clickButton: function(val){ // $socket is socket.io-client instance this.$socket.emit('emit_method', val); } } })
Emitter.js
Emitter.js主要是寫(xiě)了一個(gè)Emitter對(duì)象,該對(duì)象提供了三個(gè)方法:
addListener
addListener(label, callback, vm) { // 回調(diào)函數(shù)類(lèi)型是回調(diào)函數(shù)才對(duì) if(typeof callback == 'function'){ // 這里就很常見(jiàn)的寫(xiě)法了,判斷map中是否已經(jīng)注冊(cè)過(guò)該事件了 // 如果沒(méi)有,就初始化該事件映射的值為空數(shù)組,方便以后直接存入回調(diào)函數(shù) // 反之,直接將回調(diào)函數(shù)放入數(shù)組即可 this.listeners.has(label) || this.listeners.set(label, []); this.listeners.get(label).push({callback: callback, vm: vm}); return true } return false }
其實(shí)很常規(guī)啦,實(shí)現(xiàn)發(fā)布訂閱者模式或者觀察者模式代碼的同學(xué)都很清楚這段代碼的意思。Emiiter用一個(gè)map來(lái)存儲(chǔ)事件以及它對(duì)應(yīng)的回調(diào)事件數(shù)組。這段代碼先判斷map中是否之前已經(jīng)存儲(chǔ)過(guò)了該事件,如果沒(méi)有,初始化該事件對(duì)應(yīng)的值為空數(shù)組,然后將當(dāng)前的回調(diào)函數(shù),壓進(jìn)去,反之,直接壓進(jìn)去。
removeListener
if (listeners && listeners.length) { index = listeners.reduce((i, listener, index) => { return (typeof listener.callback == 'function' && listener.callback === callback && listener.vm == vm) ? i = index : i; }, -1); if (index > -1) { listeners.splice(index, 1); this.listeners.set(label, listeners); return true; } } return false;
這里也很簡(jiǎn)單啦,獲取該事件對(duì)應(yīng)的回調(diào)數(shù)組。如果不為空,就去尋找需要移除的回調(diào),找到后,直接刪除,然后將新的回調(diào)數(shù)組覆蓋原來(lái)的那個(gè)就可以了
emit
if (listeners && listeners.length) { listeners.forEach((listener) => { listener.callback.call(listener.vm,...args) }); return true; } return false;
這里就是監(jiān)聽(tīng)到事件后,執(zhí)行該事件對(duì)應(yīng)的回調(diào)函數(shù),注意這里的call,因?yàn)楸O(jiān)聽(tīng)到事件后我們可能要修改下vue實(shí)例的數(shù)據(jù)或者調(diào)用一些方法,用過(guò)vue的同學(xué)都知道我們都是this.xxx來(lái)調(diào)用的,所以一定得將回調(diào)函數(shù)的this指向vue實(shí)例,這也是為什么存回調(diào)事件時(shí)也要把vue實(shí)例存下來(lái)的原因。
Observer.js
constructor(connection, store) { // 這里很明白吧,就是判斷這個(gè)connection是什么類(lèi)型 // 這里的處理就是你可以傳入一個(gè)連接好的socket實(shí)例,也可以是一個(gè)url if(typeof connection == 'string'){ this.Socket = Socket(connection); }else{ this.Socket = connection } // 如果有傳進(jìn)vuex的store可以響應(yīng)在store中寫(xiě)的mutations和actions // 這里只是掛載在這個(gè)oberver實(shí)例上 if(store) this.store = store; // 監(jiān)聽(tīng),啟動(dòng)! this.onEvent() }
這個(gè)Observer.js里也主要是寫(xiě)了一個(gè)Observer的class,以上是它的構(gòu)造函數(shù),構(gòu)造函數(shù)第一件事是判斷connection是不是字符串,如果是就構(gòu)建一個(gè)socket實(shí)例,如果不是,就大概是個(gè)socket的實(shí)例了,然后直接掛載在它的對(duì)象實(shí)例上。其實(shí)這里我覺(jué)得可以參數(shù)檢查嚴(yán)格點(diǎn), 比如字符串被人搞怪地可能會(huì)傳入一個(gè)非法的url,對(duì)吧。這個(gè)時(shí)候判斷下,拋出一個(gè)error提醒下也好,不過(guò)應(yīng)該也沒(méi)人這么無(wú)聊吧,2333。然后如果傳入了store,也掛在對(duì)象實(shí)例上吧。最后就啟動(dòng)監(jiān)聽(tīng)事件啦。我們看看onEvent的邏輯
onEvent(){ // 監(jiān)聽(tīng)服務(wù)端發(fā)來(lái)的事件,packet.data是一個(gè)數(shù)組 // 第一項(xiàng)是事件,第二個(gè)是服務(wù)端傳來(lái)的數(shù)據(jù) // 然后用emit通知訂閱了該信號(hào)的回調(diào)函數(shù)執(zhí)行 // 如果有傳入了vuex的store,將該事件和數(shù)據(jù)傳入passToStore,執(zhí)行passToStore的邏輯 var super_onevent = this.Socket.onevent; this.Socket.onevent = (packet) => { super_onevent.call(this.Socket, packet); Emitter.emit(packet.data[0], packet.data[1]); if(this.store) this.passToStore('SOCKET_'+packet.data[0], [ ...packet.data.slice(1)]) }; // 這里跟上面意思應(yīng)該是一樣的,我很好奇為什么要分開(kāi)寫(xiě),難道上面的寫(xiě)法不會(huì)監(jiān)聽(tīng)到下面的信號(hào)? // 然后這里用一個(gè)變量暫存this // 但是下面都是箭頭函數(shù)了,我覺(jué)得沒(méi)必要,畢竟箭頭函數(shù)會(huì)自動(dòng)綁定父級(jí)上下文的this let _this = this; ["connect", "error", "disconnect", "reconnect", "reconnect_attempt", "reconnecting", "reconnect_error", "reconnect_failed", "connect_error", "connect_timeout", "connecting", "ping", "pong"] .forEach((value) => { _this.Socket.on(value, (data) => { Emitter.emit(value, data); if(_this.store) _this.passToStore('SOCKET_'+value, data) }) }) }
這里就是有點(diǎn)類(lèi)似重載onevent這個(gè)函數(shù)了,監(jiān)聽(tīng)到事件后,將數(shù)據(jù)拆包,然后通知執(zhí)行回調(diào)和傳遞給store。大體的邏輯是這樣子。然后這代碼實(shí)現(xiàn)有兩部分,第一部分和第二部分邏輯基本一樣。只是分開(kāi)寫(xiě)。(其實(shí)我也不是很懂啦,如果很有必要的話,我猜第一部分的寫(xiě)法還監(jiān)聽(tīng)不了第二部分的事件吧,所以要另外監(jiān)聽(tīng))。最后只剩下一個(gè)passToStore了,其實(shí)也很容易懂
passToStore(event, payload){ // 如果事件不是以SOCKET_開(kāi)頭的就不用管了 if(!event.startsWith('SOCKET_')) return // 這里遍歷vuex的store中的mutations for(let namespaced in this.store._mutations) { // 下面的操作是因?yàn)椋绻鹲tore中有module是開(kāi)了namespaced的,會(huì)在mutation的名字前加上 xxx/ // 這里將mutation的名字拿出來(lái) let mutation = namespaced.split('/').pop() // 如果名字和事件是全等的,那就發(fā)起一個(gè)commit去執(zhí)行這個(gè)mutation // 也因此,mutation的名字一定得是 SOCKET_開(kāi)頭的了 if(mutation === event.toUpperCase()) this.store.commit(namespaced, payload) } // 這里類(lèi)似上面 for(let namespaced in this.store._actions) { let action = namespaced.split('/').pop() // 這里強(qiáng)制要求了action的名字要以 socket_ 開(kāi)頭 if(!action.startsWith('socket_')) continue // 這里就是將事件轉(zhuǎn)成駝峰式 let camelcased = 'socket_'+event .replace('SOCKET_', '') .replace(/^([A-Z])|[\W\s_]+(\w)/g, (match, p1, p2) => p2 ? p2.toUpperCase() : p1.toLowerCase()) // 如果action和事件全等,那就發(fā)起這個(gè)action if(action === camelcased) this.store.dispatch(namespaced, payload) } }
passToStore嘛其實(shí)就是做兩個(gè)事情,一個(gè)是獲取與該事件對(duì)應(yīng)的mutation,然后發(fā)起一個(gè)commit,一個(gè)是獲取與該事件對(duì)應(yīng)的action,然后dispatch。只是這里的實(shí)現(xiàn)對(duì)mutations和actions的命名有了要求,比如mutations的命名一定得是SOCKET_開(kāi)頭,action就是一個(gè)得socket_開(kāi)頭,然后還得是駝峰式命名。
最后
首先,這個(gè)源碼是不是略有點(diǎn)簡(jiǎn)單,哈哈哈,不過(guò),能給你們一些幫助,我覺(jué)得也挺好的
然后,就是如果上面我說(shuō)的有是很對(duì)的,請(qǐng)大家去這里發(fā)issue或者直接評(píng)論吧
最后,源碼的詳細(xì)的注釋在這里
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。
本文名稱(chēng):VueSocket.io源碼解讀
標(biāo)題路徑:http://m.newbst.com/article48/jhsjhp.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站改版、App開(kāi)發(fā)、自適應(yīng)網(wǎng)站、云服務(wù)器、品牌網(wǎng)站設(shè)計(jì)、定制網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)