云開發(fā) 實時數(shù)據(jù)推送

云開發(fā)數(shù)據(jù)庫支持實時推送變更數(shù)據(jù)的能力，給定查詢條件，每當(dāng)數(shù)據(jù)庫更新而導(dǎo)致查詢條件對應(yīng)的查詢結(jié)果發(fā)生變更時，在小程序端就可收到一個更新事件，通過更新時間返回的對象就可獲取更新內(nèi)容和更新后的查詢結(jié)果快照。

一、應(yīng)用場景與注意事項

1、實時數(shù)據(jù)推送的應(yīng)用場景

當(dāng)用戶在小程序端停留時間比較長，需要關(guān)注其他用戶的行為而導(dǎo)致的一些數(shù)據(jù)的實時變化時，就可以使用實時數(shù)據(jù)推送，只要數(shù)據(jù)發(fā)生變動，都能實時的在前端呈現(xiàn)出來。實時數(shù)據(jù)推送有著廣泛的應(yīng)用場景：

• 聊天/即時通信：小游戲內(nèi)聊天、大廳廣播、區(qū)服廣播等；企業(yè)內(nèi)部小程序中的即時通信能力等；

• 直播實時彈幕：在開視頻直播時，用戶點贊量、發(fā)送的禮物、評論等都可以實時在直播間滾動播放；

• 多人小游戲：使用狀態(tài)同步的小游戲，如棋牌類等回合制游戲等

• 協(xié)作工具：如在線協(xié)作文檔、團(tuán)隊任務(wù)管理等，用戶的編輯信息會實時同步到參與方；

• 實時應(yīng)用狀態(tài)同步：可以實時獲取最新文章、以及最新評論、點贊、通知等內(nèi)容，讓交互更順暢自然；比如看體育直播，和網(wǎng)友實時互動；

• 在線商城：比如搶購時的庫存量在不刷新界面的情況下實時更新；價格會實時變化的拼購；

• 股票基金報價：股票的價格總是瞬息萬變的，當(dāng)你打開小程序查看股票價格時，你希望是實時的，而不是當(dāng)你刷新頁面時，數(shù)據(jù)才會同步；

• 基于位置的應(yīng)用，比如你和你的好友開啟了位置共享；或者你在景區(qū)內(nèi)不斷移動，景區(qū)會實時根據(jù)你的位置推送相關(guān)的景區(qū)介紹；

2、實時數(shù)據(jù)推送注意事項

1、實時數(shù)據(jù)推送只支持小程序端(Web端)

實時數(shù)據(jù)推送的watch請求只支持在小程序端(Web端)等前端調(diào)用，不支持云函數(shù)端。

2、不要濫用實時數(shù)據(jù)推送

只有在小程序端需要快速同步數(shù)據(jù)變動響應(yīng)時，才需要使用實時數(shù)據(jù)推送，一般情況用頁面刷新即可；也只有在用戶在頁面停留時間比較長的情況下才可以使用實時數(shù)據(jù)推送，

3、注意集合的權(quán)限設(shè)置

集合的權(quán)限需要設(shè)置為所有人可讀，僅創(chuàng)建者可讀寫。集合的讀權(quán)限設(shè)置在實時數(shù)據(jù)推送里同樣生效，如果權(quán)限是設(shè)置為僅可讀用戶自己的數(shù)據(jù)，則監(jiān)聽的時候無法監(jiān)聽到非用戶自己創(chuàng)建的數(shù)據(jù)。

4、查詢不支持field

監(jiān)聽集合中符合查詢條件的數(shù)據(jù)的更新事件。使用 watch 時，支持 where, orderBy, limit，不支持 field。在監(jiān)聽中，orderBy 最多可以指定 5 個排序字段，limit 最大值為 200。limit 默認(rèn)不存在即取所有數(shù)據(jù)。

5、只監(jiān)聽必要的數(shù)據(jù)

監(jiān)聽時應(yīng)明確查詢條件，只監(jiān)聽必須用到的數(shù)據(jù)，避免監(jiān)聽不必要的數(shù)據(jù)，以此提高初次加載數(shù)據(jù)的性能以及接收數(shù)據(jù)變更的性能。

6、監(jiān)聽返回的數(shù)據(jù)不受默認(rèn) 20 條限制

監(jiān)聽返回的數(shù)據(jù)可能超過 20 條，不受小程序端默認(rèn) 20 條上限限制。一次監(jiān)聽的記錄數(shù)上限為 5000，若超出上限會拋錯并停止監(jiān)聽。監(jiān)聽過大量的數(shù)據(jù)時初始化會較慢，對監(jiān)聽效率也有影響，如果預(yù)期監(jiān)聽發(fā)起時少于 5000，但后續(xù)有可能超過 5000，請注意在即將超過時重新監(jiān)聽并保證不超過 5000。

二、實時數(shù)據(jù)推送案例

數(shù)據(jù)庫的實時監(jiān)聽既可以監(jiān)聽集合中符合查詢條件的文檔的變化，也可以監(jiān)聽單個doc，下面以監(jiān)聽單個doc為例。使用開發(fā)者工具新建一個頁面，比如snapshot，然后在snapshot.wxml里輸入一個可以修改數(shù)據(jù)的button，比如點擊一下就會增加點贊次數(shù)：

<button bindtap="addStar">點贊{{stars}}</button>

然后在數(shù)據(jù)庫里新建一個集合比如livevideo（注意要修改集合的權(quán)限可以用安全規(guī)則修改為所有人可讀可寫，或者將點贊采用調(diào)用云函數(shù)的方式），添加一個簡單的記錄比如：

"_id":"room2020032101",
"star":0

再在snapshot.js的data屬性里聲明stars，以及添加事件處理函數(shù)addStar,還有就是在頁面的onLoad生命周期函數(shù)里監(jiān)聽數(shù)據(jù)的變化，并將數(shù)據(jù)的變化渲染到頁面。

  data:{
    stars:0
  },
  onLoad: function() {
    const that =this
    const watcher = db.collection('livevideo').doc('room2020032101')
    .watch({
      onChange: function(snapshot) {
        that.setData({
          stars:snapshot.docs[0].star
        })
        console.log('文檔數(shù)據(jù)發(fā)生變化', snapshot)
      },
      onError: function(err) {
        console.error('監(jiān)聽因錯誤停止', err)
      }
    })
  }
  addStar(){
    db.collection('livevideo').doc('room2020032101').update({
      data: {
        star:  _.inc(1)
      },
      success: console.log,
      fail: console.error
    })
  }

watch有兩個屬性，onError是失敗回調(diào)，onChange是成功回調(diào)，成功回調(diào)傳入的參數(shù) snapshot 是變更快照。onChange 和 onError 是必傳參數(shù)。onChange 用于接收變更快照，onError 用于處理監(jiān)聽錯誤。如果監(jiān)聽發(fā)起失敗或監(jiān)聽過程中出現(xiàn)不可恢復(fù)的錯誤，則會終止監(jiān)聽并通過 onError 拋出異常。onChange 會在第一次監(jiān)聽初始化及后續(xù)數(shù)據(jù)變更時收到推送事件。第一次初始化時會收到的查詢條件對應(yīng)的查詢結(jié)果，后續(xù)變更事件會包含變更內(nèi)容和變更后的查詢結(jié)果快照。

如果想要預(yù)覽實時數(shù)據(jù)推送的效果，可以使用開發(fā)者工具的多賬號調(diào)試，在開發(fā)者工具欄-工具-多賬號調(diào)試即可。當(dāng)A用戶點擊點贊的button，點贊的數(shù)量就會實時同步給所有在線用戶的小程序端。在多賬號的控制臺里也能實時看到打印的信息。

我們可以留意打印的snapshot對象，這個對象包含的信息非常多，主要有

• type：快照類型，僅在第一次初始化數(shù)據(jù)時有值為 init,也就是當(dāng)我們加載snapshot頁面，在有用戶點擊button之前，type為init，一旦數(shù)據(jù)變化，type為undefined;

• id為變更事件id，記錄了事件變更的次數(shù)；

• docChanges:表示更新事件數(shù)組，前端操作

• docs:數(shù)據(jù)快照，表示此更新事件發(fā)生后查詢語句對應(yīng)的查詢結(jié)果

docChanges對象里的queueType和dataType字段，前者表示更新事件對監(jiān)聽列表的影響，后者表示記錄的具體更新類型。注意這兩者的不同，比如上面的案例我們只是更新了字段的值，所以它為update；如果監(jiān)聽的記錄出現(xiàn)增加，或者減少，queueType的值就會有所不同，而removedFields也會有刪除的字段；而dataType字段的值則與數(shù)據(jù)庫請求的方法相對應(yīng)，而所有更新的字段及字段更新后的值都會在updatedFields對象里。