低代碼平臺組件間通信方案復(fù)盤

作者：徐小夕 2023-01-05 07:39:28

在設(shè)計(jì)組件通信方案前, 我們需全局維護(hù)一個公共的狀態(tài), 拿 H5-Dooring可視化平臺舉例, 我們用 redux 管理公共狀態(tài), 組件間通信本質(zhì)就是觸發(fā)公共狀態(tài)的更新:

背景介紹

3年前我開發(fā)了一款零代碼搭建平臺 H5-Dooring, 主要目的是想用更低的成本, 更快的效率, 上線 web 頁面(其實(shí)是不想寫重復(fù)的代碼了,寫麻了). 好在陸陸續(xù)續(xù)折騰了3年, 目前已經(jīng)可以滿足基本的頁面設(shè)計(jì)和搭建能力, 并能快速上線頁面.

之前也在社區(qū)分享了很多低代碼和零代碼的技術(shù)實(shí)現(xiàn), 接下來繼續(xù)和大家聊聊低代碼平臺中組件與組件之間的通信方案設(shè)計(jì).

可視化搭建平臺的基本能力

根據(jù)我自己設(shè)計(jì)可視化搭建平臺的經(jīng)驗(yàn), 其需要具備最最基本的兩個能力:

靜態(tài)頁面設(shè)計(jì)能力(也就是可以用可視化平臺制作我們想要的頁面的能力)
組件交互能力(制作好靜態(tài)頁面之后, 頁面元素能具備一定的交互, 比如跳轉(zhuǎn)鏈接, 打開彈窗等)

以上的能力可以讓我們將頁面通過拖拽的方式搭建出來:

雖然這已經(jīng)可以滿足很多展示型的需求, 但是仍然存在局限性, 比如可視化平臺的組件與組件之間, 沒辦法相互通信.

更靈活自主的可視化搭建平臺

這里給大家舉一個實(shí)際的場景, 比如我們要做一個轉(zhuǎn)盤H5頁面, 它由轉(zhuǎn)盤組件和按鈕組件組成, 當(dāng)點(diǎn)擊按鈕時, 轉(zhuǎn)盤開始運(yùn)動:

這種場景就需要轉(zhuǎn)盤組件和按鈕組件相互通信, 來實(shí)現(xiàn)交互功能. 所以在可視化搭建平臺中, 如果能實(shí)現(xiàn)組件間的通信, 那將覆蓋更多的業(yè)務(wù)場景, 從而為個人或者企業(yè)帶來更大的價值.

接下來我將和大家分享一下低代碼平臺中組件間通信的幾種方案, 共大家學(xué)習(xí)參考.

組件間通信的幾種實(shí)現(xiàn)方案

說到組件通信我們也許并不陌生, 比如在 vue 或者 React 框架中, 經(jīng)常會涉及到父子組件通信以及組件與組件間的通信, 常用的方案也有很多, 比如:

props/$emit
子組件向父組件傳值
eventBus($emit/$on)
vuex / redux
$attrs/$listeners
provide/inject

當(dāng)然還有很多方式能幫我們實(shí)現(xiàn)傳統(tǒng)組件間的通信, 那我們在低代碼組件中, 也可以參考類似的方式來實(shí)現(xiàn), 但是唯一的區(qū)別是需要設(shè)計(jì)一套規(guī)則, 來保證組件間通信可以通過用戶配置的方式來運(yùn)轉(zhuǎn).

接下來我們來分析幾種低代碼組件間的通信方案.

1.websocket

為了保證低代碼組件庫足夠純凈, 比如不應(yīng)該在組件里連接 redux, 所以我們需要把 redux 觸發(fā)器 dispatch 放在頁面的全局, 這里就可以用 websocket, 在組件里觸發(fā) socket 指令, 在頁面全局來監(jiān)聽, 并觸發(fā) dispatch :

當(dāng)然使用 socket 的方式仍然會讓低代碼組件庫負(fù)重前行(雖然能實(shí)現(xiàn)更自由的通信場景, 比如組件自更新, 生命周期回調(diào), 控制業(yè)務(wù)鉤子等), 因?yàn)槲覀儾坏貌粸槠浯罱?nbsp;socket 服務(wù), 并且需要為其設(shè)計(jì)穩(wěn)定的通信橋梁, 比如 socket 心跳連接等.

2.iframe通信 postmessage

利用 iframe 的 postmessage 等 API 雖然也能實(shí)現(xiàn)組件間通信, 但是我們需要設(shè)計(jì)一套通信機(jī)制, 保證 iframe 能接受組件傳送的指令, 并對外暴露共享狀態(tài):

我們從 Iframe 的通信模式可以發(fā)現(xiàn)它不僅可以作為中間橋梁起到通信作用, 有點(diǎn)類似于 eventBus的模式, 而且還可以實(shí)現(xiàn)頁面間的通信, 比如目前很多微前端架構(gòu)的底層支持也有采用 iframe 來設(shè)計(jì)的. 但是對于更細(xì)粒度的低代碼組件來說, 有點(diǎn)小題大作了.

接下來給大家分享一下 iframe 通信的基本代碼實(shí)現(xiàn):

// 父頁面和子頁面通信
// A.html （父）
<iframe src="http://h5.dooring.cn/h5_plus" frameborder="1" id="Bframe"></iframe>
const msg = {
    name: "H5-Dooring"
  }
window.onload = () => {
  // 自動調(diào)用必須放在onload中,通過事件調(diào)用則不用
  // let frame = document.querySelector("#Bframe").contentWindow
  let frame = window.frames[0]
  frame.postMessage(msg, "http://h5.dooring.cn/preview")
}

// B.html
window.addEventListener("message", (e) => {
  console.log(e.data)
  console.log(e.origin)
  console.log(e.source)
})

// 子頁面和父頁面通信
// A.html （父）
<iframe src="http://h5.dooring.cn/h5_plus" frameborder="1" id="Bframe"></iframe>
window.addEventListener("message", (e) => {
  console.log(e.data)
  console.log(e.origin)
  console.log(e.source)
})

// B.html
const msg = {
  name: "Dooring H5"
}
window.top.postMessage(msg, "http://h5.dooring.cn/preview")

3.Event Emitters

Event Emitters 的方式我覺得是最適合低代碼組件間通信的方案, 類似于 js 里的事件監(jiān)聽機(jī)制, 我們可以給 dom 綁定監(jiān)聽, 并暴露事件給用戶來實(shí)現(xiàn)手動觸發(fā)機(jī)制. (雖然不一定是用戶手動觸發(fā), 也有一種情況是邏輯觸發(fā), 比如當(dāng)頁面某個組件到達(dá)某一狀態(tài)的時候, 后自動觸發(fā)事件, 來改變其他組件的狀態(tài))

Event Emitters 類似一種觀察者模式, 我們可以利用 javascript 的設(shè)計(jì)模式來實(shí)現(xiàn)它, 并在組件內(nèi)部來監(jiān)聽或者觸發(fā), 一個簡單的實(shí)現(xiàn)如下:

interface Events {
  [key: string]: Function[];
}

export class EventEmitter {
  public events: Events;
  constructor(events?: Events) {
    this.events = events || {};
  }

  public subscribe(name: string, cb: Function) {
    (this.events[name] || (this.events[name] = [])).push(cb);

    return {
      unsubscribe: ()
        this.events[name] && this.events[name].splice(this.events[name].indexOf(cb) >>> 0, 1)
    };
  }

  public emit(name: string, ...args: any[]): void {
    (this.events[name] || []).forEach(fn fn(...args));
  }
}