全部產品
Search
文件中心

OpenSearch:查詢分析Demo

更新時間:Jul 13, 2024

配置環境變數

配置環境變數ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

重要
  • 阿里雲帳號AccessKey擁有所有API的存取權限,建議您使用RAM使用者進行API訪問或日常營運,具體操作,請參見建立RAM使用者

  • 建立AccessKey ID和AccessKey Secret,請參考建立AccessKey

  • 如果您使用的是RAM使用者的AccessKey,請確保主帳號已授權AliyunServiceRoleForOpenSearch服務關聯角色,請參考OpenSearch-行業演算法版服務關聯角色,相關文檔參考訪問鑒權規則

  • 請不要將AccessKey ID和AccessKey Secret儲存到工程代碼裡,否則可能導致AccessKey泄露,威脅您帳號下所有資源的安全。

  • LinuxmacOS系統配置方法:

    執行以下命令,其中, <access_key_id>需替換為您RAM使用者的AccessKey ID,<access_key_secret>替換為您RAM使用者的AccessKey Secret。

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> 
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
  • Windows系統配置方法

    1. 建立環境變數檔案,添加環境變數ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,並寫入已準備好的AccessKey ID和AccessKey Secret。

    2. 重啟Windows系統生效。

V3.1.3 SDK 查詢分析搜尋範例代碼

package com.aliyun.opensearch;

import com.alibaba.fastjson.JSONArray;
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.Config;
import com.aliyun.opensearch.sdk.generated.search.SearchFormat;
import com.aliyun.opensearch.sdk.generated.search.SearchParams;
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;
import java.util.ArrayList;
import java.util.List;

public class testQueryProcessor {

    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);
        //設定返回格式為json,3.1.2 sdk只支援返回xml和json格式,暫不支援返回fulljson類型,3.1.3版本支援fulljson
        config.setSearchFormat(SearchFormat.FULLJSON);

        // 建立參數對象
        SearchParams searchParams = new SearchParams(config);

        // 設定查詢子句,若需多個索引組合查詢,需要setQuery處合并,否則若設定多個setQuery後面的會替換前面查詢
        searchParams.setQuery("name:'kfc'");//通過kfc會搜尋出“肯德基”的文檔

        List<String> qpname = new ArrayList<String>();
        qpname.add("qptest");  //設定查詢分析名稱
        searchParams.setQueryProcessorNames(qpname);

        // SearchParams的工具類,提供了更為便捷的操作
        SearchParamsBuilder paramsBuilder = SearchParamsBuilder.create(searchParams);

        // 執行返回查詢結果
        SearchResult searchResult;
        try {
            searchResult = searcherClient.execute(paramsBuilder);
            String result = searchResult.getResult();

            JSONObject obj = new JSONObject(result);

            //判斷執行返回是否成功,如果報錯執行下面代碼,否則輸出正確查詢內容
            if(obj.get("errors").toString().length()>2){
                JSONArray jsonarr = JSONArray.parseArray(obj.get("errors").toString());
                System.out.println("error code:"+jsonarr.getJSONObject(0).get("code"));
                System.out.println("error message:"+jsonarr.getJSONObject(0).get("message"));
            }else{
                // 輸出查詢結果
                System.out.println("output:"+obj.toString());
                //個別使用者可能需要debug請求地址資訊
                SearchResultDebug srd = searcherClient.executeDebug(searchParams);
                System.out.println(srd.getRequestUrl().toString());
            }

        } catch (OpenSearchException e) {
            e.printStackTrace();
        } catch (OpenSearchClientException e) {
            e.printStackTrace();
        }

    }
}