04.实时查询Live Queries

实时查询

1.标准API

正如我们在LiveQuery协议中讨论的,我们保持一个与Parse LiveQuery服务器进行通信的WebSocket连接。当使用服务器端时,我们使用ws包,在浏览器中则使用window.WebSocket。我们认为在大多数情况下,没有必要直接处理WebSocket连接。因此,我们开发了一个简单的API,让您专注于自己的业务逻辑。

注意:实时查询仅在具有JS SDK~1.8以上版本的Parse Server中受支持。

1.创建订阅

let query = new Parse.Query('Game');
let subscription = query.subscribe();

您获得的订阅实际上是一个事件发射器。有关事件发射器的更多信息,请查看此处。您将通过此subscription获取LiveQuery事件。您首次调用subscribe时,我们将尝试为您打开与LiveQuery服务器的WebSocket连接。

2.事件处理

我们定义了几种可通过subscription对象获取的事件:

打开事件

subscription.on('open', () => {
 console.log('subscription opened');
});

当您调用query.subscribe()时,我们向LiveQuery服务器发送订阅请求。当我们从LiveQuery服务器获得确认时,将发出此事件。

当客户端失去与LiveQuery服务器的WebSocket连接时,我们将尝试自动重连LiveQuery服务器。如果我们重连上LiveQuery服务器并成功重新订阅ParseQuery,您同样会获得此事件。

创建事件

subscription.on('create', (object) => {
  console.log('object created');
});

当一个新的ParseObject被创建并满足你所订阅的ParseQuery时,你就会得到这个事件。返回的object就是已创建的ParseObject。

更新事件

subscription.on('update', (object) => {
  console.log('object updated');
});

当满足您订阅的ParseQuery的ParseObject被更新(满足ParseQuery的ParseObject更改前后)时,您将收到此事件。返回的object就是已更新的ParseObject。其内容是ParseObject的最新值。

进入事件

subscription.on('enter', (object) => {
  console.log('object entered');
});

当现有ParseObject的旧值不满足ParseQuery但新值满足时,你会得到这个事件。该object是进入ParseQuery的ParseObject。其内容是ParseObject的最新值。

离开事件

subscription.on('leave', (object) => {
  console.log('object left');
});

当一个现有ParseObject的旧值满足ParseQuery但它的新值不满足时,你会得到这个事件。该object是离开ParseQuery的ParseObject。其内容是ParseObject的最新值。

删除事件

subscription.on('delete', (object) => {
  console.log('object deleted');
});

当一个现有的满足ParseQuery的ParseObject被删除时,你会得到这个事件。该object是被删除的ParseObject。

关闭事件

subscription.on('close', () => {
  console.log('subscription closed');
});

当客户端失去与LiveQuery服务器的WebSocket连接,且我们无法获得更多事件时,您将获得此事件。

3.退订

subscription.unsubscribe();

如果你想停止从ParseQuery接收事件,你可以取消订阅subscription。之后,您将不会从subscription对象中获取任何事件。

4.关闭

Parse.LiveQuery.close();

使用LiveQuery完毕后,可以调用Parse.LiveQuery.close()。此功能将关闭与LiveQuery服务器的WebSocket连接、取消自动重连、并取消订阅所有基于此的subscriptions。此后,如果您调用query.subscribe(),我们将创建一个新的WebSocket连接到LiveQuery服务器。

5.设置Server URL

Parse.liveQueryServerURL = 'ws://XXXX'

大多数时候你不需要手动设置。如果您已经设置好了Parse.serverURL,我们将尝试提取主机名并将ws://hostname当作liveQueryServerURL的默认值。不过,如果想定义自己的liveQueryServerURL或使用不同的协议(比如wss),您应该自行设置。

6.WebSocket状态

我们提供了三个事件来帮助您监视WebSocket连接的状态:

打开事件

Parse.LiveQuery.on('open', () => {
  console.log('socket connection established');
});

当我们建立与LiveQuery服务器的WebSocket连接时,您将获得此事件。

关闭事件

Parse.LiveQuery.on('close', () => {
  console.log('socket connection closed');
});

当我们失去与LiveQuery服务器的WebSocket连接时,您将收到此事件。

错误事件

Parse.LiveQuery.on('error', (error) => {
  console.log(error);
});

当发生某些网络错误或LiveQuery服务器错误时,您将收到此事件。

2.高级API

在我们的标准API中,我们为您管理全局WebSocket连接,这适用于大多数情况。但是,在某些情况下,比如您有多个LiveQuery服务器并想都连接时,一个WebSocket连接是不够的。我们提供了LiveQueryClient来应对这些情况。

1.LiveQueryClient

LiveQueryClient是标准WebSocket客户端的包装器。我们添加了几个有用的方法来帮助您连接/断开LiveQueryServer、轻松的订阅/取消订阅一个ParseQuery。

初始化

let Parse = require('parse/node');
let LiveQueryClient = Parse.LiveQueryClient;
let client = new LiveQueryClient({
  applicationId: '',
  serverURL: '',
  javascriptKey: '',
  masterKey: ''
});
  • applicationId是强制性的,它是您Parse应用程序的applicationId
  • liveQueryServerURL是强制性的,它是LiveQuery服务器的URL
  • javascriptKey和masterKey是可选的,它们用于当尝试连接到LiveQuery服务器时验证LiveQueryClient。如果你设置它们,它们应该匹配你的Parse应用程序。您可以在此查看LiveQuery协议以获取更多详细信息。

打开

client.open();

调用它之后,LiveQueryClient将尝试向LiveQuery服务器发送连接请求。

订阅

let query = new Parse.Query('Game');
let subscription = client.subscribe(query, sessionToken); 
  • query是强制性的,它是你想订阅的ParseQuery
  • sessionToken是可选的,如果您提供了sessionToken,当LiveQuery服务器从Parse服务器获取ParseObject的更新时,将检查 sessionToken是否满足该ParseObject的ACL。LiveQuery服务器只会向sessionToken满足该ParseObject ACL的客户端发送更新。您可以查看LiveQuery协议了解更多详细信息。这里你得到的subscription与从标准API得到的subscription相同。您可以查看标准 API,了解如何使用subscription来获取事件。

退订

client.unsubscribe(subscription); 
  • subscription是强制性的,它是您要取消订阅的subscription。调用它之后,您将不会从subscription对象获取任何事件。

关闭

client.close();

此功能将关闭LiveQueryClient的WebSocket连接、取消自动重连、并取消订阅所有基于此的subscriptions。

2.事件处理

我们提供了三个事件来帮助您监控LiveQueryClient的状态。

打开事件

client.on('open', () => {
  console.log('connection opened');
});

当我们建立与LiveQuery服务器的WebSocket连接时,您将获得此事件。

关闭事件

client.on('close', () => {
  console.log('connection closed');
});

当我们失去与LiveQuery服务器的WebSocket连接时,您将收到此事件。

错误事件

client.on('error', (error) => {
  console.log('connection error');
});

当发生某些网络错误或LiveQuery服务器错误时,您将收到此事件。

3.重新连接

由于整个LiveQuery功能都依赖于与LiveQuery服务器的WebSocket连接,因此我们始终尝试保持一个开放的WebSocket连接。因此,当我们发现我们失去与LiveQuery服务器的连接时,我们将尝试自动重连。在底层实现上,我们采用了指数退避算法(exponential back off)。不过,如果使用Parse.LiveQuery.close()或client.close()关闭了WebSocket连接,我们将取消自动重连。

4.SessionToken

订阅ParseQuery时,我们会把sessionToken发送到LiveQuery服务器。对于标准API,默认使用当前用户的sessionToken。对于高级API,在订阅ParseQuery时可以使用任何sessionToken 。要注意的一个重要事情是,当您注销或所使用的sessionToken已失效时,您应取消订阅subscription并再次订阅ParseQuery。否则,您可能会遇到安全问题,因为您将收到不应发送给您的事件。

你可能感兴趣的:(04.实时查询Live Queries)