全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
开放搜索

使用教程

更新时间:2017-09-18 10:20:31

准备工作

登录控制台创建应用

  • 手动在控制台根据实际业务需要创建对应表结构及其它相关配置,例如:索引,属性,数据源,过滤条件等。
  • 下载此处我们提供的测试 应用结构模板,在创建应用结构时,选择“通过模板创建应用结构”,然后下一步,再选择左上角的“导入模板”,上传此处下载的应用结构模板,一直下一步直到完成。【此应用结构测试模板,可适用于标准版Java SDK文档中的搜索及推送数据Demo代码】

获取用户AccessKeyId和秘钥(secret)

用户可以使用阿里云的账号登录本系统,在登录完成后,点击“ACCESSKEY管理”可以查看您的Access Key ID(AccessKeyId)和 Access Key Secret(secret)。也可以在阿里云官网,点击“用户中心>我的服务>安全验证”即可到ACCESSKEY管理中心。

将SDK添加到项目中

使用OpenSearch SDK有两种方式:

  • 1.下载SDK源码包,在下载中心下载最新版的JAVA SDK到本地,再下载此处的 slf4j-api-1.7.25 依赖 jar包,并将这2个jar包 import 到您的项目中,若项目中不包含此依赖jar包,会出现运行报错。
  • 2.引入OpenSearch SDK依赖,通过maven二方库依赖的方式将opensearch的sdk加入到自己的项目中。
    1. <dependencies>
    2. <dependency>
    3. <groupId>com.aliyun.opensearch</groupId>
    4. <artifactId>aliyun-sdk-opensearch</artifactId>
    5. <version>3.1.3</version>
    6. </dependency>
    7. </dependencies>

创建client

通过控制台也可以完成创建应用的操作,这里介绍一下如何使用SDK实现。这里使用import SDK的方式,使用上面获取的AccessKey和Secret实例化一个SearcherClient(下面的操作里将继续使用如下的client),具体代码如下:

  1. import com.aliyun.opensearch.*;
  2. import com.aliyun.opensearch.sdk.dependencies.com.google.common.collect.Lists;
  3. import com.aliyun.opensearch.sdk.generated.OpenSearch;
  4. import com.aliyun.opensearch.sdk.generated.search.Config;
  5. import com.aliyun.opensearch.sdk.generated.search.SearchFormat;
  6. String appName = "应用名称";
  7. String accesskey = "您的阿里云的Access Key ID";
  8. String secret = "阿里云 Access Key ID 对应的 Access Key Secret";
  9. String host = "这里的host需要根据访问应用基本信息页中提供的的API入口来确定";
  10. //创建并构造OpenSearch对象
  11. OpenSearch openSearch = new OpenSearch(accesskey, secret, host);
  12. //创建OpenSearchClient对象,并以OpenSearch对象作为构造参数
  13. OpenSearchClient serviceClient = new OpenSearchClient(openSearch);
  14. ## 上传文档
  15. OpenSearch的文档是一个json类型的字符串,结构如下:
  16. 打开控制台中的应用后,内部右上角也有 “上传文件” 功能,里面提供了类似下面的json格式测试数据,可下载下来直接上传使用,注意文件必须是utf8格式,且不能包含BOM头,否者上传会报错。
  17. [
  18. {
  19. fields”:{...},
  20. cmd”:"..."
  21. }
  22. ...
  23. ]

一条文档是由fields字段和cmd字段构成的一个结构体,其中fields字段内包含文档的核心数据,cmd表示针对此条文档所做的操作,但标准版和高级版部分操作有所不同,标准版不支持update及部分字段更新,只支持全字段更新,因此对文档的添加,更新操作都是通过(add)方式实现,删除(delete)与原来相同。一段文档示例如下:

  1. [
  2. {
  3. fields”: {
  4. id”: "0",
  5. name”: "广大中小企业都有各种结构化的数据需要进行检索,目前一般采用数据库本身提供的搜索功能或者利用open source的搜索软件搭建,这样的做法不但会消耗网站本身的资源,性能也会很容易成为问题,而且相关性通常也不够好。我们的产品的目的是要利用阿里云先进的云计算和搜索技术向广大中小企业提供低成本,高质量,高性能,可定制的数据搜索解决方案。本项目和云搜索的通用解决方案目标略有不同,主要区别为本项目主要针对用户的结构化数据进行搜索,云搜索的通用解决方案则主要是针对网页型数据为处理对象。"
  6. },
  7. cmd”: "ADD"
  8. },
  9. {
  10. fields”: {
  11. id”: "1",
  12. name”: "云搜索( Cloud Search Engine),是运用云计算( Cloud Computing)技术的搜索引擎,可以绑定多个域名,定义搜索范围和性质,同时,不同域名可以有不同UI和流程,这个UI和流程由运行在云计算服务器上的个性化程序完成。作为新型搜索引擎,与传统搜索引擎需要输入多个关键字不同的是,用户可以告诉搜索引擎每个搜索关键字的比重,每个搜索关键字都被置于“搜索云”中,并用不同大小,粗细的字型区分。 "
  13. },
  14. cmd”: "ADD"
  15. }
  16. ]

将文档上传到应用的某个表中的代码如下:

  1. //定义DocumentClient对象添加json格式doc数据批量提交
  2. DocumentClient documentClient = new DocumentClient(serviceClient);
  3. table_name = "要上传数据的表名";
  4. data = "[{"cmd":"add", "fields":{"id":"0","name":"blabla..."}}]";
  5. //执行推送操作
  6. OpenSearchResult osr = documentClient.push(data, appName, table_name);

另外还可以通过DocumentClient类的提供的add、remove二个接口生成待上传的数据,最后在调用push方法将数据上传;

开始搜索

OpenSearch通过设置可以实现高度个性化的搜索需求,但通用的基本的搜索功能只需通过非常简单的设置即可实现:

  1. //创建SearcherClient对象,并以OpenSearchClient对象作为构造参数
  2. SearcherClient searcherClient = new SearcherClient(serviceClient);
  3. //定义Config对象,用于设定config子句参数,指定应用名,分页,数据返回格式等等
  4. Config config = new Config(Lists.newArrayList(appName));
  5. config.setStart(0);
  6. config.setHits(5);
  7. //设置返回格式为fulljson格式
  8. config.setSearchFormat(SearchFormat.JSON);
  9. // 创建参数对象
  10. SearchParams searchParams = new SearchParams(config);
  11. // 指定搜索的关键词,这里要指定在哪个索引上搜索,如果不指定的话默认在使用“default”索引(索引字段名称是您在您的数据结构中的“索引字段列表”中对应字段。),若需多个索引组合查询,需要在setQuery处合并,否则若设置多个setQuery子句,则后面的子句会替换前面子句
  12. searchParams.setQuery("name:'搜索'");
  13. //设置查询过滤条件
  14. searchParams.setFilter("id>0");
  15. //创建sort对象,并设置二维排序
  16. Sort sort = new Sort();
  17. //设置id字段降序
  18. sort.addToSortFields(new SortField("id", Order.DECREASE));
  19. //若id相同则以RANK相关性算分升序
  20. sort.addToSortFields(new SortField("RANK", Order.INCREASE));
  21. //执行查询语句返回数据对象
  22. SearchResult searchResult = searcherClient.execute(searchParams);
  23. //以字符串返回查询数据
  24. String result = searchResult.getResult();

调试

通过上面的操作我们已经可以使用基本的搜索功能了,但是优化搜索、提高搜索结果相关性是一个漫长的的过程,需要我们不断试错和迭代来一点点改进。在这个过程中如果遇到问题或者发现结果与预期不一致时可以通过下面的接口获得请求的详细信息,您可以通过这些信息排查问题。特别是当您遇到问题,在旺旺群、钉钉群中寻求帮助的时候,根据您提供的调试信息我们可以迅速帮您定位到问题所在,主要向我们提供查询异常或不符合预期返回的,请求ID 或 查询http请求串等信息,进行查询分析定位原因。

  1. 部分用户有可能会有记录查询请求串的需求,例如打印上一次查询请求串信息,该信息中的部分查询子句可以直接截取出来放到控制台中的搜索测试框中运行调试,可参考如下代码
  2. SearchResultDebug searchdebugrst = searcherClient.executeDebug(searchParams);
  3. System.out.println(searchdebugrst.getRequestUrl());
本文导读目录