全文搜索开发指南

在应用内使用全文搜索是一个很常见的需求。例如一个阅读类的应用，里面有很多有价值的文章，开发者会提供一个搜索框，让用户键入关键字后就能查找到应用内相关的文章，并按照相关度排序，就好像我们打开浏览器用 Google 搜索关键字一样。 虽然使用正则查询也可以实现全文搜索功能，但数据量较大的时候正则查询会有性能问题，因此 LeanCloud 提供了专门的全文搜索功能。

LeanCloud 也提供了与全文搜索搭配使用的 DeepLink 功能，让应用可以响应外部调用链接。

为 Class 启用搜索

你需要选择至少一个 Class 为它开启全文搜索。开启后，该 Class 的数据将被 LeanCloud 自动建立索引，并且可以调用我们的搜索组件或者 API 搜索到内容。

请注意，启用了搜索的 Class 数据，其搜索结果仍然遵循 ACL。如果你为 Class 里的 Object 设定了合理的 ACL，那么搜索结果也将遵循这些 ACL 值，保护你的数据安全。

你可以在「控制台 > 存储 > 全文搜索」为 Class 启用搜索，点击「添加搜索 Class」：

• Class：选择需要启用搜索的 Class。开发版应用最多允许 5 个 Class 启用全文搜索，商用版应用最多允许 10 个 Class 启用全文搜索。
• 开放的列：你可以选择将哪些字段加入搜索索引。默认情况下，objectId、createdAt、updatedAt 三个字段将无条件加入开放字段列表。除了这三个字段外，开发版应用每个 Class 最多允许索引 5 个字段，商用版应用每个 Class 最多允许索引 10 个字段。请仔细挑选要索引的字段。

如果一个 Class 启用了全文搜索，但是超过两周没有任何搜索调用，我们将自动禁用该 Class 的搜索功能。

搜索 API

LeanCloud 提供了 全文搜索的 REST API 接口。 JavaScript SDK、Objective C SDK、Java SDK 封装了这一接口。

假设你对 GameScore 类启用了全文搜索，你就可以尝试传入关键字来搜索：

const query = new AV.SearchQuery('GameScore');
query.queryString('dennis');
// 高亮玩家字段中匹配到的 dennis 字符串，如要匹配多个字段，可传入一个数组
query.highlights('player'); 
query.highlights('player'); 
query.find().then(function(results) {
  console.log("Find " + query.hits() + " docs.");
  // 打印输出：Find 4 docs.
  // 打印带高亮的第一个匹配结果，剩余匹配结果的处理同理
  console.log(results[0].get('_highlight').player);
  // 打印输出：[ '<em>dennis</em> ZX' ]
}).catch(function(err){
  //处理 err
});

AVSearchQuery *searchQuery = [AVSearchQuery searchWithQueryString:@"test-query"];
searchQuery.className = @"GameScore";
searchQuery.highlights = @"field1,field2";
searchQuery.limit = 10;
searchQuery.cachePolicy = kAVCachePolicyCacheElseNetwork;
searchQuery.maxCacheAge = 60;
searchQuery.fields = @[@"field1", @"field2"];
[searchQuery findInBackground:^(NSArray *objects, NSError *error) {
  for (AVObject *object in objects) {
        NSString *appUrl = [object objectForKey:@"_app_url"];
        NSString *deeplink = [object objectForKey:@"_deeplink"];
        NSString *hightlight = [object objectForKey:@"_highlight"];
        // other fields
        // code is here
    }
}];

AVSearchQuery searchQuery = new AVSearchQuery("dennis");
searchQuery.setClassName("GameScore");
searchQuery.setLimit(10);
searchQuery.orderByAscending("score"); //根据score字段升序排序。
searchQuery.findInBackground().subscribe(new Observer<List<AVObject>>() {
  @Override
  public void onSubscribe(Disposable disposable) {}

  @Override
  public void onNext(List<AVObject> results) {
    for (AVObject o:results) {
      System.out.println(o);
    }
    testSucceed = true;
    latch.countDown();
  }

  @Override
  public void onError(Throwable throwable) {
    throwable.printStackTrace();
    testSucceed = true;
    latch.countDown();
  }

  @Override
  public void onComplete() {}
});

LCSearchQuery<GameScore> query = new LCSearchQuery<GameScore>('GameScore');
query.queryString('dennis');
query.orderByDescending('score');
query.limit(10);
LCSearchResponse<GameScore> response = await query.find();
// 符合查询条件的文档总数
print(response.hits);
// 符合查询条件的结果文档
for (GameScore score in response.results) {

}
// 标记本次查询结果，下次查询继续传入这个 sid 用于查找后续的数据，用来支持翻页查询
print(response.sid);

LCSearchQuery<GameScore> query = new LCSearchQuery<GameScore>("GameScore");
query.QueryString("dennis")
    .OrderByDescending("score")
    .Limit(10);
LCSearchResponse<GameScore> response = await query.Find();
// 符合查询条件的文档总数
Debug.Log(response.Hits);
// 符合查询条件的结果文档
foreach (GameScore score in response.Results) {

}
// 标记本次查询结果，下次查询继续传入这个 sid 用于查找后续的数据，用来支持翻页查询
Debug.Log(response.Sid);

有关查询语法，可以参考 q 查询语法。

因为每次请求都有 limit 限制，所以一次请求可能并不能获取到所有满足条件的记录。 AVSearchQuery 的 hits() 标示所有满足查询条件的记录数。 你可以多次调用同一个 AV.SearchQuery 的 find() 获取余下的记录。

如果在不同请求之间无法保存查询的 query 对象，可以利用 sid 做到翻页，一次查询是通过 AV.SearchQuery 的 _sid 属性来标示的。 你可以通过 AV.SearchQuery 的 sid() 来重建查询 query 对象，继续翻页查询。 sid 在 5 分钟内有效。

复杂排序可以使用 AV.SearchSortBuilder，例如，假设 scores 是由分数组成的数组，现在需要根据分数的平均分倒序排序，并且没有分数的排在最后：

searchQuery.sortBy(new AV.SearchSortBuilder().descending('scores', 'avg', 'last'));

AVSearchSortBuilder *builder = [AVSearchSortBuilder newBuilder];
[builder orderByDescending:@"scores" withMode:@"max" andMissing:@"last"];
searchQuery.AVSearchSortBuilder = builder;

AVSearchSortBuilder builder = AVSearchSortBuilder.newBuilder();
builder.orderByDescending("scores","avg","last");
searchQuery.setSortBuilder(builder);

LCSearchSortBuilder sortBuilder = new LCSearchSortBuilder();
sortBuilder.orderByAscending('scores', mode: 'avg', missing: 'last');
searchQuery.sortBy(sortBuilder);

LCSearchSortBuilder sortBuilder = new LCSearchSortBuilder();
sortBuilder.OrderByAscending("balance", "avg", "last");
searchQuery.SortBy(sortBuilder);

更多 API 请参考 SDK API 文档：

• AV.SearchQuery
• AV.SearchSortBuilder

• AVSearchQuery
• AVSearchSortBuilder

• AVSearchQuery
• AVSearchSortBuilder

• LCSearchQuery
• LCSearchSortBuilder
• LCSearchResponse

• LCSearchQuery
• LCSearchSortBuilder
• LCSearchResponse

自定义分词

默认情况下， String 类型的字段都将被自动执行分词处理，我们使用的分词组件是 mmseg，词库来自搜狗。但是很多用户由于行业或者专业的特殊性，一般都有自定义词库的需求，因此我们提供了自定义词库的功能。应用创建者可以通过 LeanCloud 控制台 > 存储 > 全文搜索 > 自定义词库 上传词库文件。

词库文件要求为 UTF-8 编码，每个词单独一行，文件大小不能超过 512 K，例如：

面向对象编程
函数式编程
高阶函数
响应式设计

将其保存为文本文件，如 words.txt，上传即可。上传后，分词将于 3 分钟后生效。开发者可以通过 analyze API（要求使用 master key）来测试。

自定义词库生效后，仅对新添加或者更新的文档/记录才有效，如果需要对原有的文档也生效的话，需要在 存储 > 全文搜索 点击「重建索引」按钮，重建原有索引。 同样，如果更新了自定义词库（包括删除自定义词库），也需要重建索引。