事件监听 编辑文档

事件监听是指通过事件触发的方式来获取云端变化的数据。通过监听云端事件,本地获取并处理数据,保持和数据实时同步。

事件

数据在云端发生变化后会触发事件。

事件包含以下五种:

事件类型 说明
child_added 初始化监听或有新增子节点。
child_changed 子节点数据发生更改。
child_removed 子节点被删除。
child_moved 子节点排序发生变化。
value 初始化监听或指定节点及子节点数据发生变化。

注意:


每当指定节点下的数据(包括更深层节点数据)发生改变时,都会触发 Value 事件。所以,为了聚焦你关心的数据,你应该把监听的节点路径设置的更加精确。例如,尽量不要在根节点设置 Value 事件监听。

监听事件

通过 Wilddog Sync 提供的方法,监听云端的事件,保持和云端实时同步。

设置监听

on() 方法用于与事件配合来监听指定节点的数据。

例如,通过 on() 方法配合 Value 事件监听 Jobs 节点下的数据:

// 初始化
var config = {
authDomain: "docs-examples.wilddog.com",
syncURL: "https://docs-examples.wilddogio.com"
};
wilddog.initializeApp(config);
var ref = wilddog.sync().ref("/web/saving-data/wildblog/users/Jobs");
ref.on('value', function(snapshot) {
var newPost = snapshot.val();
console.log("full_name: " + newPost.full_name);
console.log("gender: " + newPost.gender);
}, function (error) {
console.log(error);
}
});

之后 Jobs 节点下的数据发生任何变化,都会触发回调方法。

例如,博客应用 中,通过 on() 方法配合 Child 事件来监听博客的状态变化:

var postsRef = wilddog.sync().ref("/web/saving-data/wildblog/posts");
postsRef.on('child_added', function(data) {
console.log(data.val().author + " 发布了一篇名为《" + data.val().title + "》的博客");
});
postsRef.on('child_changed', function(data) {
console.log(data.val().author + " 更新博客标题为《" + data.val().title + "》");
});
postsRef.on('child_removed', function(data) {
console.log( "博客《" + data.val().title + "》被删除");
});

更多使用,请参考 on()


提示:


如果你只想监听一次数据,可使用once()方法。该监听的回调方法只被触发一次,之后会自动取消监听。

移除监听

off()方法用于移除指定事件。移除监听之后,事件回调方法将不会被触发。

参数为移除的事件类型和回调方法:

ref.off("value", originalCallback);

在不带任何参数的情况下,在该节点调用 off(),将移除该节点位置的所有监听:

ref.off();

注意:


在父节点上调用 off() 方法时不会移除在其子节点上添加的监听。

条件监听

Wilddog Sync 支持对事件监听设置条件:数据排序或数据筛选。

根据数据排序监听

Wilddog Sync 支持按键(key)、按值(value)、按节点的优先级(priority) 或按指定子节点的值(value)对数据进行排序。

数据排序包含以下四种方法:

方法 说明
orderByChild() 按指定子节点的值(value)对结果排序。
orderByKey() 按节点的键(key)对结果排序。
orderByValue() 按节点的值(value)对结果排序。
orderByPriority() 按节点的优先级(priority)对结果排序。

orderByChild

orderByChild()方法用于按子节点的指定值(value)对结果排序,规则如下:Boolean(false) < Boolean(true) < Number < String

例如,在 班级示例应用 中按照每个学生的身高(”height” 节点的值)进行排序:

// 初始化
var config = {
authDomain: "class-demo.wilddog.com",
syncURL: "https://class-demo.wilddogio.com"
};
wilddog.initializeApp(config);
// 使用 orderByChild 进行排序
var ref = wilddog.sync().ref("students");
ref.orderByChild("height").on("child_added", function(snapshot) {
console.log(snapshot.key() + " was " + snapshot.val().height + " centimeters tall");
});

orderByKey()

orderByKey()方法用于按节点的键(key)对结果排序,排序规则为字典顺序。

例如,在 班级示例应用 中按照学生的名称进行排序:

var ref = wilddog.sync().ref("students");
ref.orderByKey().on("child_added", function(snapshot) {
console.log(snapshot.key());
});

orderByValue()

orderByValue()方法用于按节点的值(value)对结果排序,规则如下:Boolean(false) < Boolean(true) < Number < String

例如,在 得分示例应用 中按照得分数据进行排序:

var ref = wilddog.sync().ref("scores");
ref.orderByValue().on("value", function(snapshot) {
snapshot.forEach(function(data) {
console.log("The " + data.key() + " student's score is " + data.val());
});
});

orderByPriority()

orderByPriority()方法用于按节点的优先级(priority)对结果排序,规则如下:null < Number < String


注意:



  • 每次只能使用一种排序方法。对同一监听调用多个排序方法会引发错误。

  • 排序会占用较多计算机资源。如果你的应用使用了排序,建议定义 .indexOn 规则,在服务器上添加数据索引以提高排序效率。更多使用,请参考 数据索引


根据数据筛选结果监听

对数据排序之后,才能进行数据筛选。

数据筛选包含以下五种方法:

方法 用法
limitToFirst() 设置从第一条开始,一共返回多少个节点。
limitToLast() 设置从最后一条开始,一共返回多少个节点(返回结果仍是升序,降序要自己处理)。
startAt() 返回大于或等于指定的 key、value 或 priority 的节点,具体取决于所选的排序方法。
endAt() 返回小于或等于指定的 key、value 或 priority 的节点,具体取决于所选的排序方法。
equalTo() 返回等于指定的 key、value 或 priority 的节点,具体取决于所选的排序方法。可用于精确查询。

你可以结合不同的方法来筛选数据。例如,结合 startAt() 方法与 endAt() 方法将结果限制在指定的范围内。

数量筛选

limitToFirst()方法用于获取从第一条(或 startAt() 方法指定的位置)开始向后指定数量的子节点。

limitToLast()方法用于获取从最后一条(或 endAt() 方法指定的位置)开始向前指定数量的子节点。

例如,在 班级示例应用 中,如果你只想知道最高的是哪三位同学:

var config = {
authDomain: "class-demo.wilddog.com",
syncURL: "https://class-demo.wilddogio.com"
};
wilddog.initializeApp(config);
var ref = wilddog.sync().ref("students");
ref.orderByChild("height").limitToLast(3).on("child_added", function(snapshot) {
console.log(snapshot.key() + " was " + snapshot.val().height + " centimeters tall ");
});

如果使用 limitToFirst(100) 筛选数据,那么第一次返回节点数最多为 100 个。当数据发生更改时,对于进入到前 100 个的节点,你会接收到 child_added 事件。对于从前 100 个中消失的节点,你会接收到 child_removed 事件。

范围筛选

startAt()方法、endAt()方法 和 equalTo() 方法用于监听选择任意起点、终点或等量点。

例如,在 班级示例应用 中,如果你只想知道哪些学生的考分超过 60:

var ref = wilddog.sync().ref("scores");
ref.orderByValue().startAt(60).on("child_added", function(snapshot) {
console.log(snapshot.key() + " is " + snapshot.val());
});

注意:


  • 范围筛选中,当节点的 value 相同时,会按照 key 进行排序。

  • startAt、endAt 配合使用时,只能查找相同类型的值,例如 startAt(2).endAt(4) 或 startAt(‘b’).endAt(‘d’)。

  • 范围筛选可用于 数据分页精确查询 。关于分页的具体实现,请参考 如何实现分页

    野狗新手?
    立即注册,为你提供安全可靠的实时通信云服务。
    没找到需要的文档?
    你可以提交工单反馈 或 阅读常见问题
    期待收到你的反馈,帮助我们改进文档。
    参与调研