HarmonyOS基礎(chǔ)之JS UI任意組件通訊
51CTO和華為官方合作共建的鴻蒙技術(shù)社區(qū)
組件間的通信主要作用是能在組件間傳遞數(shù)據(jù)或者執(zhí)行相關(guān)的業(yè)務(wù)邏輯,對(duì)于鴻蒙應(yīng)用組件,下面將對(duì)幾種組件間的通信方式進(jìn)行代碼實(shí)現(xiàn),其中包括實(shí)現(xiàn)自定義實(shí)現(xiàn)任意組件通信。
文件結(jié)構(gòu)
首先我們準(zhǔn)備好幾個(gè)組件 parent組件、current組件、child1組件、child2組件,其中parent與current是父子組件關(guān)系、curren與child1/child2是父子組件關(guān)系、child1與child2是兄弟組件關(guān)系、parent與child1/child2是跨層級(jí)組件的關(guān)系,詳細(xì)的代碼文件可以參考附件源碼,最終預(yù)覽得到結(jié)果如下:

父子關(guān)系通信
parent與current是父子組件關(guān)系,在current.js中props的title=''current-title",在parent.hml中使用current組件時(shí)傳入title="parent"時(shí),current組件顯示parent,這里使用了props由父組件向子組件傳遞title值進(jìn)行通信,預(yù)覽結(jié)果見下圖:


curren與child1/child2是父子組件關(guān)系,在current組件中有三個(gè)按鈕 改變parent、改變child1、改變child2,按鈕配置如下:

在curren組件中,點(diǎn)擊改變parent按鈕會(huì)觸發(fā)changeParent方法,點(diǎn)擊改變child1按鈕會(huì)觸發(fā)changeChild1方法,點(diǎn)擊改變child1按鈕會(huì)觸發(fā)changeChild1方法,這些方法會(huì)改變對(duì)應(yīng)組件中的數(shù)據(jù),如下:
點(diǎn)擊改變parent按鈕,通過使用$parent方法得到parent組件的實(shí)例,然后通過實(shí)例對(duì)象與parent組件進(jìn)行數(shù)據(jù)通信:

點(diǎn)擊改變child1,通過使用$child方法得到child1組件的實(shí)例,然后通過實(shí)例對(duì)象與child1組件進(jìn)行數(shù)據(jù)通信:

點(diǎn)擊改變child2,通過使用$child方法得到child2組件的實(shí)例,然后通過實(shí)例對(duì)象與child2組件進(jìn)行數(shù)據(jù)通信:

在changeParent方法中使用this.$parent()方法來獲取了parent組件的ViewModel,從而可以訪問和改變parent組件的數(shù)據(jù)
在changeChild1和changeChild2中使用了this.$child(id)方法來獲取child1/child2組件的ViewModel,從而可以訪問和改變child1/child2組件的數(shù)據(jù)
除了使用this.$parent方法外還可以使用自定義事件的方式來進(jìn)行子組件調(diào)用父組件方法來向父組件傳值,parent組件在引用current組件時(shí)綁定事件,在current組件中調(diào)用this.$emit方法來觸發(fā)綁定的自定義事件。
parent.hml中綁定自定義的eventEmit方法


current.js中使用this.$emit方法觸發(fā)eventEmit方法:

總結(jié)下來,父子組件間的通信方式大概有幾種方法:
- props:用于父組件向子組件傳遞數(shù)據(jù)
- $emit:用于自組件向父組件傳遞數(shù)據(jù)或調(diào)用父組件方法
- $parent:用于獲取父組件ViewModel從而可以修改父組件數(shù)據(jù)和調(diào)用父組件方法
- $child:用于獲取子組件ViewModel從而修改子組件數(shù)據(jù)和調(diào)用子組件方法
兄弟關(guān)系與跨層級(jí)組件間通信
根據(jù)上面父子組件的通信方式,對(duì)于兄弟組件和跨層級(jí)組件之間,可以組合使用上面的幾種方法組合的方式可以實(shí)現(xiàn)非父子組件間的通信,但是如果組件間嵌套比較復(fù)雜,嵌套層級(jí)比較多的情況下,使用以上方法組合的方式顯然不太方便,在這里嘗試實(shí)現(xiàn)一種類似vue bus全局通信的方式來進(jìn)行任意組件間的通信。
在JS API中app.js文件中定義的數(shù)據(jù)可以通過this.app.app.def獲取,根據(jù)這個(gè)特性和使用觀察者模式來設(shè)計(jì)一可以全局訂閱響應(yīng)的通信模式。

eventBus
首先我們定義evnetBus.js文件,在里面定義相關(guān)的訂閱、發(fā)布和取消訂閱的方法:
- const Bus = {
- // 發(fā)布的事件集合
- $events:{},
- /**
- * 發(fā)布事件方法
- * type: string 字符串
- * fun: function 綁定的方法
- * */
- $on(type,fun){
- },
- /**
- * 觸發(fā)事件方法
- * type: string 發(fā)布事件的字符串
- * args: 傳參
- * */
- $emit(type,...args){
- },
- /**
- * 注銷事件方法
- * type: string 字符串
- * fun: string|function 發(fā)布事件時(shí)返回的值或者發(fā)布的原function
- * */
- $off(type,fun){
- }
- }
- export default Bus;
在里面我們定義了$events對(duì)象用于綁定事件的存放,$on方法用于綁定事件,$emit方法用于觸發(fā)事件,$off方法用于注銷事件,完整的eventBus.js如下:
eventBus.js
- const Bus = {
- // 發(fā)布的事件集合
- $events:{ },
- /**
- * 發(fā)布事件方法
- * type: string 字符串
- * fun: function 綁定的方法
- * */
- $on(type,fun){
- let res = "";
- if(type && typeof type == "string" && fun && typeof fun =="function"){
- let events = this.$events[type];
- if(events){
- let index = events.findIndex(null);
- if(index > -1){
- res = `${String(index)}${type}`;
- events[index] = fun;
- }else{
- events.push(fun);
- }
- }else{
- this.$events[type] = [fun];
- res = `0${type}`;
- }
- }
- return res;
- },
- /**
- * 觸發(fā)事件方法
- * type: string 發(fā)布事件的字符串
- * args: 傳參
- * */
- $emit(type,...args){
- if(type && typeof type == "string"){
- let events = this.$events[type];
- if(events){
- events.forEach(fun => {
- if(fun && typeof fun =="function"){
- fun(...args);
- }
- });
- }
- }
- },
- /**
- * 注銷事件方法
- * type: string 字符串
- * fun: string|function 發(fā)布事件時(shí)返回的值或者發(fā)布的原function
- * */
- $off(type,fun){
- if(type && typeof type == "string" && fun){
- let events = this.$events[type];
- if(events){
- if(typeof fun == "string"){
- let indexStr = fun.replace(type,'');
- let index = parseInt(indexStr);
- events[index] = null;
- }
- if(typeof fun == "function"){
- events.forEach(item => {
- if(item == fun){
- item = null;
- }
- });
- }
- }
- }
- }
- }
- export default Bus;
使用方法
引入
首先在app.js中引入eventBus,將eventBus綁定在我們的全局對(duì)象上:

綁定
在parent組件的onInit方法中綁定事件,可以通過綁定的事件來改變parent組件的值,使用this.$app.$def方法獲取全局app下掛載的eventBus對(duì)象:

觸發(fā)
然后我們修改child1組件,添加按鈕使用eventBus對(duì)象的$emit方法來觸發(fā)bus事件:

在觸發(fā)方法的時(shí)候我們傳入了自定義參數(shù)數(shù)據(jù)"123456789"

在點(diǎn)擊按鈕后將會(huì)觸發(fā)我們?cè)趐arent組件中綁定的方法從而改變parent組件數(shù)據(jù),同時(shí)也接收到了child組件傳過來的數(shù)據(jù)"123456789"

在此就實(shí)現(xiàn)了跨層級(jí)組件間的通信,此方法可以對(duì)任意組件間的事件觸發(fā)和傳值都有效,限于篇幅不再展示,最后我們還要在組件銷毀的時(shí)候注銷我們綁定的事件。
注銷
我們定義一個(gè)注銷事件的按鈕并綁定注銷事件:

在我們$on綁定事件的時(shí)候可以得到一個(gè)返回值,這個(gè)值也可以用于事件的注銷,在這里就不做演示了,有興趣的可以下去嘗試一下。
總結(jié)
以上就是使用觀察者模式實(shí)現(xiàn)了一個(gè)簡(jiǎn)易版的事件總線機(jī)制可以在任意組件間通信,基本功能可以實(shí)現(xiàn),還有一些缺點(diǎn)需要提示:
首先這個(gè)在使用的時(shí)候必須依賴?guó)櫭蒍S API this.$app.$def 這個(gè)方法,每次使用都要用這個(gè)來獲取eventBus對(duì)象。
在注冊(cè)綁定事件后一定要記得在當(dāng)前組件銷毀的時(shí)候注銷綁定的事件,否則可能會(huì)造成內(nèi)存泄露。
事件注銷有兩種方式,需要稍微理解注銷事件的原理才能熟練使用。
51CTO和華為官方合作共建的鴻蒙技術(shù)社區(qū)