使用REST API对Parse.com进行复合查询

Question

我继承的项目目前使用Parse作为后端.我正在尝试迁移数据的获取/发布方式,从Parse iOS SDK迁移到使用Parse REST API(使用AFNetworking).

我能够将PFQuery类似下面的简单转换为它的REST等价物:

PFQuery

NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
[dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.'999Z'"];
[dateFormatter setTimeZone:[NSTimeZone timeZoneWithName:@"GMT"]];

NSString *createdAt = [dateFormatter stringFromDate:createdAtDate];

PFQuery *query = [PFQuery queryWithClassName:@"Photo"];
[query whereKey:@"createdAt" lessThan:createdAt];
[query orderByDescending:@"createdAt"];
[query setLimit:10];
[query findObjectsInBackgroundWithBlock:^(NSArray *objects, NSError *error) {
    if (!error) {
        //Etc...
    }
}];

REST API请求:

NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
[dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.'999Z'"];
[dateFormatter setTimeZone:[NSTimeZone timeZoneWithName:@"GMT"]];

NSString *createdAt = [dateFormatter stringFromDate:createdAtDate];

NSString *dateQueryString = [NSString stringWithFormat:@"{\"createdAt\":{\"$lte\":{\"__type\":\"Date\",\"iso\":\"%@\"}}}", createdAt];

    NSDictionary* parameters = @{@"order": @"-createdAt",
                                 @"limit": @10,
                                 @"include": @"user",
                                 @"where":dateQueryString};    

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
manager.requestSerializer = [AFJSONRequestSerializer parseSerializer]; // Already has App-Id, App-key and Content-Type set.

NSMutableURLRequest* request = [manager.requestSerializer requestWithMethod:@"GET" URLString:@"https://api.parse.com/1/classes/Photo" parameters:parameters error:nil];

AFHTTPRequestOperation* operation = [manager HTTPRequestOperationWithRequest:request success:^(AFHTTPRequestOperation *operation, id responseObject) {

    // Etc..

} failure:^(AFHTTPRequestOperation *operation, NSError *error) {

    NSLog(@"%@", error.localizedDescription);
}];

[operation start];

然而问题是复合查询,如下所示:

NSMutableArray* subqueriesArray = [NSMutableArray array];

PFQuery *followingActivitiesQuery = [PFQuery queryWithClassName:@"Activity"];
[followingActivitiesQuery whereKey:@“type” equalTo:@“Follow”];
[followingActivitiesQuery whereKey:@“fromUser” equalTo:[PFUser currentUser]];
followingActivitiesQuery.limit = 1000;

PFQuery *privateUserQuery = [PFUser query];
[privateUserQuery whereKey:@“yourMomLikedThisPhoto” equalTo:[NSNumber numberWithBool:NO]]; // fake whereKey of course

PFQuery *photosFromFollowedUsersQuery = [PFQuery queryWithClassName:@"Photo"];
[photosFromFollowedUsersQuery whereKey:@“yourMomLikedThisPhoto” equalTo:[NSNumber numberWithBool:YES]];
[photosFromFollowedUsersQuery whereKey:@“user” matchesKey:@“toUser” inQuery:followingActivitiesQuery];
[photosFromFollowedUsersQuery whereKey:@“user” matchesQuery:privateUserQuery];

PFQuery *photosFromCurrentUserQuery = [PFQuery queryWithClassName:@"Photo"];
[photosFromCurrentUserQuery whereKey:@“yourMomLikedThisPhoto” equalTo:[NSNumber numberWithBool:YES]];
[photosFromCurrentUserQuery whereKey:@“user” equalTo:[PFUser currentUser]];

[subqueriesArray addObject:photosFromFollowedUsersQuery];
[subqueriesArray addObject:photosFromCurrentUserQuery];

PFQuery *query = [PFQuery orQueryWithSubqueries:subqueriesArray];
[query includeKey:@"Photo"];
[query orderByDescending:@"createdAt"];

如果有人可以帮助我理解如何构建parameters这个,我真的很感激.关于如何朝着正确的方向前进的一般想法也会有所帮助.我已经提到了Parse REST API指南,但我似乎无法得到它.我正在尝试使用它$inQuery,但没有运气.

这个问题的答案将涵盖在使用Parse REST API(在iOS上)查询时遇到的大多数常见和复杂问题.

Answer 1

$or 的变革性使用

我认为您想要做的是使用您选择的库 (AFNetworking) 将以下调用转换为相关的 http 调用。正如您所看到的，子查询行为嵌入在一个特定的编码 URL 中，该 URL 包含一个带有字典的数组，其值是带有比较语句的字典。

curl -X GET \
  -H "X-Parse-Application-Id: ${APPLICATION_ID}" \
  -H "X-Parse-REST-API-Key: ${REST_API_KEY}" \
  -G \
  --data-urlencode 'where={"$or":[{"wins":{"$gt":150}},{"wins":{"$lt":5}}]}' \
  https://api.parse.com/1/classes/Player

（来源）

另一种方法是使用子类查询。

子类查询

您可以使用类方法查询来查询特定子类的对象。以下示例查询用户可以购买的盔甲：

PFQuery *query = [Armor query];
[query whereKey:@"rupees" lessThanOrEqualTo:[PFUser currentUser][@"rupees"]];
[query findObjectsInBackgroundWithBlock:^(NSArray *objects, NSError *error) {
  if (!error) {
    Armor *firstArmor = [objects firstObject];
    // ...
  }
}];

（来源）

关系查询

有多种方法可以发出对关系数据的查询。如果要检索字段与特定 PFObject 匹配的对象，可以使用 whereKey:equalTo: 就像其他数据类型一样。例如，如果每个 Comment 在其帖子字段中都有一个 Post 对象，您可以获取特定帖子的评论：

// Assume PFObject *myPost was previously created.
// Using PFQuery
PFQuery *query = [PFQuery queryWithClassName:@"Comment"];
[query whereKey:@"post" equalTo:myPost];

[query findObjectsInBackgroundWithBlock:^(NSArray *comments, NSError *error) {
    // comments now contains the comments for myPost
}];

// Using NSPredicate
NSPredicate *predicate = [NSPredicate predicateWithFormat:@"post = %@", myPost];
PFQuery *query = [PFQuery queryWithClassName:@"Comment" predicate:predicate];

[query findObjectsInBackgroundWithBlock:^(NSArray *comments, NSError *error) {
    // comments now contains the comments for myPost
}];

一篇 Parse 博客文章还提到可以使用以下方法进一步增强谓词：

目前，我们支持这些 NSPredicate 功能：

简单比较，例如 =、!=、<、>、<=、>= 和 BETWEEN 与键和常量。包含谓词，例如 x IN {1, 2, 3}。键存在谓词，例如 x IN SELF。BEGINSWITH 表达式。包含 AND、OR 和 NOT 的复合谓词。带有“key IN %@”的子查询，子查询。请参阅我们的文档以获取更多详细信息和示例。

分解参数的具体技巧

我建议评估任何显示 REST API 值如何解释的示例。请记住，大多数传输可能会表示类似 JSON 的格式。在这些情况下，“[”方括号是数组，“{”大括号代表字典，您需要在将参数化数据推送到 http 请求之前对其进行编码。

应用信息

根据上面讨论的内容，您可以创建 REST API 调用。您必须对特定于您的用例的各种标准的 where 子句进行编码。可以使用以下方法来确保这些参数符合您需要的查询属性：

var encodedParam = param.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.URLQueryAllowedCharacterSet())

假设上面的参数是一些字符串，其键值类似于：

'where={"$or":[{"wins":{"$gt":150}},{"wins":{"$lt":5}}]}'

编码参数将添加到您的应用程序 ID 和 REST API 密钥之后到基本 REST-API 查询字符串 - 这应该返回您想要的对象： （注意第四个用于查询的 URL）。

看起来编码参数应该位于上面引用的类名之后，如下例所示：

（使用上面的格式推断您的值，另请注意查询字符串“...classname ?% sencodedParams”上的额外字符）。

您可能想要使用的其他查询运算符包括：

其他查询示例

人们可以通过使用Parse 网站上提供的示例来推断如何构建更复杂的查询。将这些查询打包到编码参数中应该会产生您想要的结果。我要做的是首先使用常规 Parse API 构造一个查询，然后将其转换为上面标识的 REST-API 构造。

例如：

let urlpath = NSString(format: "https://api.parse.com/1/classes/Photo?%s\(encodedParams)")

... add code to call the urlPath

针对您的主要问题的具体答复

重新阅读问题后，我想回答您的具体问题，即需要将多个子查询添加到 REST-API 参数列表中。我认为仔细检查 $or 子句会很有用。只要您可以将照片对象上的相关键应用到多重条件中，那么您应该能够实现您的目标。

'where={"$or":[{"wins":{"$gt":150}},{"wins":{"$lt":5}}]}'

复合查询示例

$or 子句是 Parse 网站上复合查询下使用的示例。上面的代码可以转换为您的用例，并使用前面指定的编码 url 方法进行应用。

诺塔·贝尼

请注意，下面的示例显示了多个相关对象的检索（使用 $inQuery）。对于可以检索的内部对象的数量存在限制。我注意到这基本上与您在代码中所做的事情等效，因此希望使用此示例进行推断会相对简单。

警告

请注意 Parse 关于何时使用 REST-API 的警告。