全部产品
云市场

搜索Demo

更新时间:2019-07-20 15:41:03

V3.1 SDK搜索文档样例代码

搜索报错判断:
用户需按code和message,进行异常情况判断,不要按status进行判断。
code对应的错误信息查看——错误码文档

SDK样例Demo:

  1. package com.aliyun.opensearch;
  2. import com.aliyun.opensearch.sdk.dependencies.com.google.common.collect.Lists;
  3. import com.aliyun.opensearch.sdk.dependencies.org.json.JSONObject;
  4. import com.aliyun.opensearch.sdk.generated.OpenSearch;
  5. import com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException;
  6. import com.aliyun.opensearch.sdk.generated.commons.OpenSearchException;
  7. import com.aliyun.opensearch.sdk.generated.search.*;
  8. import com.aliyun.opensearch.sdk.generated.search.general.SearchResult;
  9. import com.aliyun.opensearch.search.SearchParamsBuilder;
  10. import com.aliyun.opensearch.search.SearchResultDebug;
  11. import java.nio.charset.Charset;
  12. public class testSearch {
  13. private static String appName = "替换为opensearch应用名";
  14. private static String accesskey = "替换accesskey";
  15. private static String secret = "替换secret";
  16. private static String host = "替换应用的API访问地址";
  17. public static void main(String[] args) {
  18. //查看文件和默认编码格式
  19. System.out.println(String.format("file.encoding: %s", System.getProperty("file.encoding")));
  20. System.out.println(String.format("defaultCharset: %s", Charset.defaultCharset().name()));
  21. //创建并构造OpenSearch对象
  22. OpenSearch openSearch = new OpenSearch(accesskey, secret, host);
  23. //创建OpenSearchClient对象,并以OpenSearch对象作为构造参数
  24. OpenSearchClient serviceClient = new OpenSearchClient(openSearch);
  25. //创建SearcherClient对象,并以OpenSearchClient对象作为构造参数
  26. SearcherClient searcherClient = new SearcherClient(serviceClient);
  27. //定义Config对象,用于设定config子句参数,分页或数据返回格式,指定应用名等等
  28. Config config = new Config(Lists.newArrayList(appName));
  29. config.setStart(0);
  30. config.setHits(5);
  31. //设置返回格式为FULLJSON,目前支持返回 XML,JSON,FULLJSON 等格式
  32. config.setSearchFormat(SearchFormat.FULLJSON);
  33. // 设置搜索结果返回应用中哪些字段
  34. config.setFetchFields(Lists.newArrayList("id", "name", "phone", "int_arr", "literal_arr", "float_arr", "cate_id"));
  35. // 注意:config子句中的rerank_size参数,在Rank类对象中设置
  36. //设置Kvpairs子句参数,此处为distinct子句添加uniq插件,用于reserverd=false时,total及viewtotal不准确问题
  37. //config.setKvpairs("duniqfield:cate_id");
  38. // 创建参数对象
  39. SearchParams searchParams = new SearchParams(config);
  40. // 设置查询子句,若需多个索引组合查询,需要setQuery处合并,否则若设置多个setQuery后面的会替换前面查询
  41. searchParams.setQuery("name:'opensearch'");
  42. // 设置聚合打散子句
  43. Distinct dist = new Distinct();
  44. dist.setKey("cate_id"); //设置dist_key
  45. dist.setDistCount(1); //设置dist_count
  46. dist.setDistTimes(1); //设置dist_times
  47. dist.setReserved(false); //设置reserved
  48. dist.setUpdateTotalHit(false); //设置update_total_hit
  49. dist.setDistFilter("cate_id<=3"); //设置过滤条件
  50. dist.setGrade("1.2"); //设置grade
  51. //此处duniqfield参数通过在config子句中指定kvpairs子句形式添加
  52. //添加Distinct对象参数
  53. searchParams.addToDistincts(dist);
  54. //设置统计子句
  55. Aggregate agg = new Aggregate();
  56. agg.setGroupKey("cate_id"); //设置group_key
  57. agg.setAggFun("count()"); //设置agg_fun
  58. agg.setAggFilter("cate_id=1"); //设置agg_filter
  59. agg.setRange("0~10"); //设置分段统计
  60. agg.setAggSamplerThresHold("5"); //设置采样阈值
  61. agg.setAggSamplerStep("5"); //设置采样步长
  62. agg.setMaxGroup("5"); //设置最大返回组数
  63. //添加Aggregate对象参数
  64. //searchParams.addToAggregates(agg);
  65. // 设置查询过滤条件
  66. // searchParams.setFilter("id > \"0\""); //此处也可改用后面的ParamsBuilder实现添加过滤条件
  67. // 设置sort条件
  68. Sort sorter = new Sort();
  69. sorter.addToSortFields(new SortField("id", Order.DECREASE)); //设置id字段降序
  70. sorter.addToSortFields(new SortField("RANK", Order.INCREASE)); //若id相同则以RANK升序
  71. //添加Sort对象参数
  72. searchParams.setSort(sorter);
  73. // 设置粗精排表达式,此处设置为默认
  74. Rank rank = new Rank();
  75. rank.setFirstRankName("default");
  76. rank.setSecondRankName("default");
  77. rank.setReRankSize(5);//设置参与精排文档个数
  78. //添加Aggregate对象参数
  79. searchParams.setRank(rank);
  80. //设置 re_search 重查参数
  81. //strategy:threshold,params:total_hits#10 => 这里面 strategy:threshold 表示策略,目前只支持一种策略。
  82. //threshold 的参数是total_hits,表示第一请求的total_hits小于这个值时触发重查。
  83. Map<String, String> reSearchParams = new HashMap<String, String>();
  84. reSearchParams.put("re_search", "strategy:threshold,params:total_hits#10");
  85. //searchParams.setCustomParam(reSearchParams);
  86. // 设置搜索结果摘要信息,此处采用下面的SearchParamsBuilder对象添加搜索结果摘要,比较简便
  87. Summary summ = new Summary("name");
  88. summ.setSummary_field("name");//指定的生效的字段。此字段必需为可分词的text类型的字段。
  89. summ.setSummary_len("50");//片段长度
  90. summ.setSummary_element("em"); //飘红标签
  91. summ.setSummary_ellipsis("...");//片段链接符
  92. summ.setSummary_snippet("1");//片段数量
  93. //添加Summary对象参数
  94. // searchParams.addToSummaries(summ);
  95. // SearchParams的工具类,提供了更为便捷的操作
  96. SearchParamsBuilder paramsBuilder = SearchParamsBuilder.create(searchParams);
  97. // 使用SearchParamsBuilder对象添加搜索结果摘要
  98. paramsBuilder.addSummary("name", 50, "em", "...", 1);
  99. // 设置查询过滤条件
  100. paramsBuilder.addFilter("id>=0", "AND");
  101. try {
  102. // 执行返回查询结果。用户需按code和message,进行异常情况判断。code对应的错误信息查看——错误码文档。
  103. SearchResult searchResult = searcherClient.execute(paramsBuilder);
  104. String result = searchResult.getResult();
  105. JSONObject obj = new JSONObject(result);
  106. // 输出查询结果
  107. System.out.println(obj.toString());
  108. //个别用户可能需要debug请求地址信息
  109. SearchResultDebug searchdebugrst = searcherClient.executeDebug(searchParams);
  110. //输出上次查询请求串信息
  111. System.out.println(searchdebugrst.getRequestUrl());
  112. } catch (OpenSearchException e) {
  113. e.printStackTrace();
  114. } catch (OpenSearchClientException e) {
  115. e.printStackTrace();
  116. }
  117. }
  118. }