OpenSearch：搜尋Demo

搜尋報錯判斷：使用者需按code和message，進行異常情況判斷，不要按status進行判斷。

code對應的錯誤資訊查看——錯誤碼文檔。

SDK範例Demo:

package com.aliyun.opensearch;

import com.aliyun.opensearch.sdk.dependencies.com.google.common.collect.Lists;
import com.aliyun.opensearch.sdk.dependencies.org.json.JSONObject;
import com.aliyun.opensearch.sdk.generated.OpenSearch;
import com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException;
import com.aliyun.opensearch.sdk.generated.commons.OpenSearchException;
import com.aliyun.opensearch.sdk.generated.search.*;
import com.aliyun.opensearch.sdk.generated.search.general.SearchResult;
import com.aliyun.opensearch.search.SearchParamsBuilder;
import com.aliyun.opensearch.search.SearchResultDebug;
import java.nio.charset.Charset;

public class testSearch {

  private static String appName = "替換為opensearch應用程式名稱";
  private static String host = "替換應用的API訪問地址";

  public static void main(String[] args) {
    //使用者識別資訊
    //從環境變數讀取配置的AccessKey ID和AccessKey Secret，運行程式碼範例前必須先配置環境變數
    String accesskey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
    String secret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
    //查看檔案和預設編碼格式
    System.out.println(
      String.format("file.encoding: %s", System.getProperty("file.encoding"))
    );
    System.out.println(
      String.format("defaultCharset: %s", Charset.defaultCharset().name())
    );
    //建立並構造OpenSearch對象
    OpenSearch openSearch = new OpenSearch(accesskey, secret, host);
    //建立OpenSearchClient對象，並以OpenSearch對象作為構造參數
    OpenSearchClient serviceClient = new OpenSearchClient(openSearch);
    //建立SearcherClient對象，並以OpenSearchClient對象作為構造參數
    SearcherClient searcherClient = new SearcherClient(serviceClient);
    //定義Config對象，用於設定config子句參數，分頁或資料返回格式，指定應用程式名稱等等
    Config config = new Config(Lists.newArrayList(appName));
    config.setStart(0);
    config.setHits(5);
    //設定返回格式為FULLJSON，目前支援返回 XML，JSON，FULLJSON 等格式
    config.setSearchFormat(SearchFormat.FULLJSON);
    // 設定搜尋結果返回應用中哪些欄位
    config.setFetchFields(
      Lists.newArrayList(
        "id",
        "name",
        "phone",
        "int_arr",
        "literal_arr",
        "float_arr",
        "cate_id"
      )
    );
    // 注意：config子句中的rerank_size參數，在Rank類對象中設定
    //設定Kvpairs子句參數,此處為distinct子句添加uniq外掛程式，用於reserverd=false時，total及viewtotal不準確問題
    //config.setKvpairs("duniqfield:cate_id");
    // 建立參數對象
    SearchParams searchParams = new SearchParams(config);
    // 設定查詢子句，若需多個索引組合查詢，需要setQuery處合并（如下樣本，可以用OR拼接），否則若設定多個setQuery後面的會替換前面查詢
    searchParams.setQuery("name:'opensearch' OR title:'opensearch'");
    // 設定彙總打散子句
    Distinct dist = new Distinct();
    dist.setKey("cate_id"); //設定dist_key
    dist.setDistCount(1); //設定dist_count
    dist.setDistTimes(1); //設定dist_times
    dist.setReserved(false); //設定reserved
    dist.setUpdateTotalHit(false); //設定update_total_hit
    dist.setDistFilter("cate_id<=3"); //設定過濾條件
    dist.setGrade("1.2"); //設定grade
    //此處duniqfield參數通過在config子句中指定kvpairs子句形式添加
    //添加Distinct對象參數
    searchParams.addToDistincts(dist);
    //設定統計子句
    Aggregate agg = new Aggregate();
    agg.setGroupKey("cate_id"); //設定group_key
    agg.setAggFun("count()"); //設定agg_fun
    agg.setAggFilter("cate_id=1"); //設定agg_filter
    agg.setRange("0~10"); //設定分段統計
    agg.setAggSamplerThresHold("5"); //設定採樣閾值
    agg.setAggSamplerStep("5"); //設定採樣步長
    agg.setMaxGroup("5"); //設定最大返回組數
    //添加Aggregate對象參數
    //searchParams.addToAggregates(agg);
    //設定多個統計欄位樣本
    Set<Aggregate> Aggregates = new HashSet();
    Aggregate aggregate1 = new Aggregate();
    aggregate1.setGroupKey("cate_id");
    aggregate1.setAggFun("count()");
    Aggregates.add(aggregate1);

    Aggregate aggregate2 = new Aggregate();
    aggregate2.setGroupKey("cate_id_1");
    aggregate2.setAggFun("count()");
    Aggregates.add(aggregate2);

    searchParams.setAggregates(Aggregates);
    // 設定biz參數
    Map hashMap = new HashMap();
    hashMap.put("biz", "type:web");
    searchParams.setCustomParam(hashMap);
    // 設定查詢過濾條件
    // searchParams.setFilter("id > \"0\""); //此處也可改用後面的ParamsBuilder實現添加過濾條件
    // 設定sort條件
    Sort sorter = new Sort();
    sorter.addToSortFields(new SortField("id", Order.DECREASE)); //設定id欄位降序
    sorter.addToSortFields(new SortField("RANK", Order.INCREASE)); //若id相同則以RANK升序
    // sort中使用tag_match的用法樣本：(config子句需要設定Kvpairs)
    //sorter.addToSortFields(new SortField("tag_match(\"kk1\",int_array,10,\"max\",\"false\",\"false\")", Order.INCREASE));
    //config.setKvpairs("kk1:10");

    //添加Sort對象參數
    searchParams.setSort(sorter);
    // 設定粗精排運算式，此處設定為預設
    Rank rank = new Rank();
    rank.setFirstRankName("default");
    rank.setSecondRankName("default");
    rank.setReRankSize(5); //設定參與精排文檔個數
    //添加Aggregate對象參數
    searchParams.setRank(rank);
    //設定 re_search 重查參數
    //strategy:threshold,params:total_hits#10 => 這裡面 strategy:threshold 表示策略，目前只支援一種策略。
    //threshold 的參數是total_hits，表示第一次請求的total_hits小於這個值時觸發重查。
    Map<String, String> reSearchParams = new HashMap<String, String>();
    reSearchParams.put("re_search", "strategy:threshold,params:total_hits#10");
    //設定下拉提示關聯搜尋請求的from_request_id
    reSearchParams.put("from_request_id", "159851481919726888064081");
    //searchParams.setCustomParam(reSearchParams);
    // 設定搜尋結果摘要資訊，此處採用下面的SearchParamsBuilder對象添加搜尋結果摘要，比較簡便
    Summary summ = new Summary("name");
    summ.setSummary_field("name"); //指定的生效的欄位。此欄位必需為可分詞的text類型的欄位。
    summ.setSummary_len("50"); //片段長度
    summ.setSummary_element("em"); //飄紅標籤
    summ.setSummary_ellipsis("..."); //片段連結符
    summ.setSummary_snippet("1"); //片段數量
    //添加Summary對象參數
    //searchParams.addToSummaries(summ);

    //添加raw_query參數(參數值需要和query查詢詞保持一致)
    searchParams.setRawQuery("opensearch");
    // SearchParams的工具類，提供了更為便捷的操作
    SearchParamsBuilder paramsBuilder = SearchParamsBuilder.create(
      searchParams
    );
    // 使用SearchParamsBuilder對象添加搜尋結果摘要
    paramsBuilder.addSummary("name", 50, "em", "...", 1);
    // 設定查詢過濾條件
    paramsBuilder.addFilter("id>=0", "AND");

    // 設定disable參數，關閉重查功能：
    //searchParams.putToCustomParam("disable", "re_search");
    try {
      // 執行返回查詢結果。使用者需按code和message，進行異常情況判斷。code對應的錯誤資訊查看——錯誤碼文檔。
      SearchResult searchResult = searcherClient.execute(paramsBuilder);
      String result = searchResult.getResult();
      JSONObject obj = new JSONObject(result);
      // 輸出查詢結果
      System.out.println(obj.toString());
      //個別使用者可能需要debug請求地址資訊
      SearchResultDebug searchdebugrst = searcherClient.executeDebug(
        searchParams
      );
      //輸出上次查詢請求串資訊
      System.out.println(searchdebugrst.getRequestUrl());
    } catch (OpenSearchException e) {
      e.printStackTrace();
    } catch (OpenSearchClientException e) {
      e.printStackTrace();
    }
  }
}