云开发数据库支持实时推送变更数据的能力,给定一个查询条件,每当数据库更新,查询条件对应的查询结果发生变化时,小程序端都可以收到更新事件,通过更新时间返回的对象可以获取更新的内容和更新后的查询结果快照。
12.4.1 应用场景及注意事项 1. 实时数据推送应用场景
当用户在小程序上停留时间较长,需要关注其他用户的行为导致的某些数据的实时变化时,就可以使用实时数据推送,只要数据发生变化,都可以实时呈现在前端。实时数据推送的应用场景比较广泛:
2. 实时数据推送注意事项
1.实时数据推送仅支持小程序端(Web端)
仅支持在小程序端(Web端)等前端调用实时数据推送的请求,不支持在云函数端调用。
2. 不要滥用实时数据推送
只有当小程序需要快速同步数据变化并做出响应时,才需要实时数据推送,一般页面刷新即可,只有当用户在页面停留时间较长时,才需要实时数据推送。
3.注意收藏的权限设置
集合的权限需要设置为所有人可读,只有创建者可读写。集合的读权限设置在实时数据推送时同样有效。如果权限设置为只读用户自己的数据,则监控时无法监控到非用户创建的数据。
4. 不支持查询
监听满足查询条件的集合中数据的更新事件,使用时支持 、 、 、 。监听器中最多可以指定5个排序字段,最大值为200个。如果不存在则默认取所有数据。
5. 仅监控必要的数据
监控的时候查询条件要明确,只监控必须用到的数据,避免监控不必要的数据,这样才能提高初始数据加载的性能和接收数据变化的性能。

6.监控返回的数据不限于默认的20条
监控返回的数据可能会超过20条,不受小程序端默认20条上限的限制。单次监控记录数上限为5000条,超过上限会抛出错误,监控停止。当监控数据量较大时,初始化会比较慢,也会影响监控效率。如果启动时预期监控少于5000条,但后续可能超过5000条,请注意在即将超过时重新监听,确保不超过5000条。
12.4.2 实时数据推送示例
数据库的实时监控可以监控集合中符合查询条件的文档的变化,也可以监控单个文档,下面以监控单个文档为例,使用开发者工具新建一个页面,然后在.wxml中输入一个可以修改的数据,比如增加点击的点赞数:
<button bindtap="addStar">点赞{{stars}}button>
然后在数据库中新建一个集合(注意修改集合权限,可以使用安全规则改为所有人可读写,或者使用云函数调用方法),并添加简单记录如:
"_id":"room2020032101", "star":0
然后在.js的data属性中声明,添加事件处理函数,在页面的生命周期函数中监听数据的变化,并将数据的变化渲染到页面中。
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('文档数据发生变化', snapshot) }, onError: function(err) { console.error('监听因错误停止', err) } }) } addStar(){ db.collection('livevideo').doc('room2020032101').update({ data: { star: _.inc(1) }, success: console.log, fail: console.error }) }
有两个属性, 是失败回调, 是成功回调,成功回调中传入的参数是变化快照。 和 是必选参数,用于接收变化快照,以及处理监控错误,如果监控启动失败或者监控过程中出现不可恢复的错误,监控将会终止并抛出异常。 第一次监控初始化以及后续数据变化时都会收到推送事件,第一次初始化会收到查询条件对应的查询结果,后续的变化事件会包含变化的内容以及变化后的查询结果快照。
如果想预览实时数据推送的效果,可以使用开发者工具的多账号调试,在开发者工具栏-工具-多账号调试中即可。当用户A点击点赞时,点赞数会实时同步到所有在线用户的小程序端。打印的信息在多账号控制台中也可以实时看到。
我们可以关注印刷品,它包含了很多信息,主要是
对象中的 和 字段,前者表示更新事件对监听列表的影响,后者表示记录的具体更新类型。注意两者的区别。比如上面的案例我们只更新了 字段的值,所以是;如果监听的记录增加或者减少, 的值就会不一样,同时也会有删除的字段; 字段的值对应数据库请求的方法,所有更新的字段以及 字段的更新值都会在 对象中。