, ,

如何讓Client得知你系統的事件?

Introduction

不管是任何系統都會有自己特有事件，而使用者會對某些事件有興趣。對於不同的案例，會有不同的解法。這裡主要收集Study的結果。

Categories

WebHook - Pub/Sub

在這種方法中，Client扮演著subscriber；Server則為publisher。Client會透過Server提供的介面去註冊某個有興趣的訊息，而Server當發生了事件後，會把訊息送給對應的subscriber。參考Jenkins Notification Plugin的UI設計: (圖片來自: link)

以Jenkins的Plugin來說，User可以透過它的UI設定你的Client所接受的Format、Protocol(http、https、udp、tcp)，有興趣的Event，還有要callback的URL。如果你的Server提供的介面是RestAPI，可以參考Google Drive的做法。最重要的就在於User願意接受你所提出的格式。

使用這方法的應用有: Google Drive、AZure、Jenkins Plugin。

WebHook – PubSubHubBub

PubSubHubBub是一個Publish/Subscribe的開放標準，詳細介紹看這裡。我們直接說說操作過程(圖片來自link):

  1. Discovery: subscriber會先從publisher的topic_url取得hub_url，publisher回應格式是基於RSS或ATOM XML。
  2. Subscribe: subscriber會到hub_url註冊有興趣的topic_url與要收通知的callback_url，callback_url通常被稱為webhook。
  3. Publish: 當Publisher有事件發生會通知Hub，而Hub會去取得最新的事件。
  4. Notify: Hub通知所有subscriber新增與改變的事件。

與一般的Pub/Sub最大差別，我想:

  1. PubSubHubBub通常會是一個外部服務，不太容易適用於內部網路；Pub/Sub比較容易用於內部網路。
  2. 由於publisher只要通知Hub，即使有多個subscriber，也不會有巨大流量產生在publisher上；Pub/Sub是由publisher自己通知所有的subscriber。

因為我的需求是內部網路，之後有時間再深入試玩看看。
使用這方法的應用有: WordPress Plugin、YouTube、GitHub、Instagram

Poll

這算是最陽春的方法: 固定一段時間去詢問某個URL的結果，即使它沒有改變。傳統的Web應用程式都是使用這樣的方式，Client-side每幾秒去Server-side要資料。這是一個很沒效率但卻最簡單的做法。以RestAPI而言，User就必須自己去區別資料狀態。

使用這方法的應用有: Dropbox、AZure。

Longpoll

Longpoll就是client會先連線至server。在一段時間內，如果server有任何改變就通知client；這段時間如果沒改變，也通知client沒改變。如果一段時間內，有頻繁的通知，client與server就要經歷多次的建立連線、通知、中斷連線循環。因此後來有websocket去解決這樣問題；網路上也有RestAPI+Websocket做法的討論，以後有用到再看看。更多可參考此篇

使用這方法的應用有: Dropbox，。

Hook Scripts

我最早使用Hook Scripts是在SVN時期，它可以針對不同事件發生時，執行你所提供的腳本。例如commit code後，觸發持續整合系統的建置；在commit之前，必須先做某些事情才允許commit等。(圖片來自: link)

以Git Hook範例來說，在第二步驟執行後，會觸發Pre-Commit Notification；在Pre-Commit Notification成功後，接著執行第三步驟後，會觸發Post-Commit Notification。

如果提供Hook Scripts的方式，你可以不需要管Client長什麼樣，因為User可以根據它的需求去做對應的Script出來。(如果他提供無法跑的Script，那就是來亂的無誤)

使用這方法的應用有: Git、Subversion。

Reference