Java 初始化 Tablestore Client - Tablestore

Tablestore Client是Tablestore的用戶端，它提供了一系列的方法，可以用來操作Tablestore的表和資料。本文介紹如何在Java中進行Tablestore Client的初始化。

重要

本文以阿里雲帳號的AccessKey為例為您介紹如何初始化Tablestore Client，如果您想使用RAM使用者的存取金鑰或STS臨時訪問憑證進行初始化，請參見使用RAM使用者存取金鑰訪問Table Store和使用STS臨時訪問憑證訪問Table Store。

準備工作

初始化Tablestore Client前，您需要擷取執行個體的相關資訊、安裝Tablestore SDK並配置訪問憑證。

擷取執行個體資訊

地區ID：執行個體所在的地區ID，例如華東1（杭州）的地區ID為cn-hangzhou，更多地區資訊請參見地區。
執行個體名稱和服務地址Endpoint：每個Tablestore執行個體對應一個服務地址（Endpoint），應用程式進行表和資料操作時需要指定服務地址，擷取方式如下。
1. 登入Table Store控制台。
2. 在頁面上方，選擇資源群組和地區。
3. 在概覽頁面，單擊執行個體別名或在操作列單擊執行個體管理。
4. 在執行個體詳情頁簽，查看執行個體的名稱和服務地址。

安裝Tablestore SDK

如果您使用的是Maven專案，請在專案的pom.xml檔案中添加如下依賴：

<dependency>
    <groupId>com.aliyun.openservices</groupId>
    <artifactId>tablestore</artifactId>
    <version>5.17.4</version>
</dependency>

更多關於安裝Tablestore SDK的資訊，請參見安裝Tablestore SDK。

配置訪問憑證

使用Tablestore SDK發起請求訪問Tablestore，您需要配置訪問憑證，阿里雲服務會通過訪問憑證驗證您的身份資訊和存取權限。

本文以阿里雲帳號的AccessKey為例為您介紹如何配置訪問憑證。AccessKey的擷取方式，請參見如何擷取AccessKey。

直接在代碼中儲存訪問憑證容易導致資訊泄露，建議您將訪問憑證儲存在系統內容變數中。

Windows

以管理員身份運行命令提示字元，執行以下命令。

# 配置 AccessKey ID
setx TABLESTORE_ACCESS_KEY_ID your_access_key_id /m
# 配置 AccessKey Secret
setx TABLESTORE_ACCESS_KEY_SECRET your_access_key_secret /m

macOS/Linux/Unix

# 配置 AccessKey ID
export TABLESTORE_ACCESS_KEY_ID=your_access_key_id
# 配置 AccessKey Secret
export TABLESTORE_ACCESS_KEY_SECRET=your_access_key_secret

更多關於配置訪問憑證的資訊，請參見配置訪問憑證。

初始化Client

您需要先初始化一個Client，然後調用該Client的方法來訪問Tablestore服務。Tablestore提供了SyncClient和AsyncClient兩種寬表模型用戶端，以及TimeseriesClient和AsyncTimeseriesClient兩種時序模型用戶端，分別對應同步和非同步方式調用。

說明

不管是同步還是非同步，都是安全執行緒的，且內部會自動管理線程和串連資源，您不需要為每個線程建立一個Client，也不需要為每個請求建立一個Client。建議您在使用多線程時，共用一個Tablestore Client對象。

寬表模型

V4簽名（推薦）

以下範例程式碼使用V4簽名初始化Tablestore Client，擷取執行個體下的資料表列表並列印到控制台。

import com.alicloud.openservices.tablestore.ClientConfiguration;
import com.alicloud.openservices.tablestore.SyncClient;
import com.alicloud.openservices.tablestore.core.ResourceManager;
import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentialProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
import com.alicloud.openservices.tablestore.core.auth.V4Credentials;
import com.alicloud.openservices.tablestore.model.AlwaysRetryStrategy;
import com.alicloud.openservices.tablestore.model.ListTableResponse;

public class InitClientV4 {
    public static void main(String[] args) {
        // yourRegion 填寫您的執行個體所在地區，如 cn-hangzhou
        final String region = "yourRegion";
        // yourInstanceName 填寫您的執行個體名稱
        final String instanceName = "yourInstanceName";
        // yourEndpoint 填寫您的執行個體訪問地址
        final String endpoint = "yourEndpoint";
        // 擷取系統變數裡的 AccessKey ID 和 AccessKey Secret
        final String accessKeyId = System.getenv("TABLESTORE_ACCESS_KEY_ID");
        final String accessKeySecret = System.getenv("TABLESTORE_ACCESS_KEY_SECRET");

        // 構造 V4 簽名
        DefaultCredentials credentials = new DefaultCredentials(accessKeyId, accessKeySecret);
        V4Credentials credentialsV4 = V4Credentials.createByServiceCredentials(credentials, region);
        CredentialsProvider provider = new DefaultCredentialProvider(credentialsV4);

        // 初始化 Tablestore Client
        SyncClient client = new SyncClient(endpoint, provider, instanceName, null, new ResourceManager(null, null));

        /*
        // 您可以通過指定 ClientConfiguration 修改預設配置項，以下樣本為部分自訂配置項。
        ClientConfiguration clientConfiguration = new ClientConfiguration();
        clientConfiguration.setConnectionTimeoutInMillisecond(5000); // 設定建立串連的逾時時間，單位為毫秒。
        clientConfiguration.setSocketTimeoutInMillisecond(5000); // 設定 socket 逾時時間，單位為毫秒。
        clientConfiguration.setRetryStrategy(new AlwaysRetryStrategy()); // 設定重試策略，如果不設定，則採用預設的重試策略。
        SyncClient client = new SyncClient(endpoint, provider, instanceName, clientConfiguration, new ResourceManager(null, null));
         */

        // 列出執行個體下的資料表列表並列印到控制台
        ListTableResponse listTableResponse = client.listTable();
        listTableResponse.getTableNames().forEach(System.out::println);

        // 關閉 Tablestore Client
        client.shutdown();
    }
}

V2簽名

以下範例程式碼使用V2簽名初始化Tablestore Client，擷取執行個體下的資料表列表並列印到控制台。

import com.alicloud.openservices.tablestore.ClientConfiguration;
import com.alicloud.openservices.tablestore.SyncClient;
import com.alicloud.openservices.tablestore.core.ResourceManager;
import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentialProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
import com.alicloud.openservices.tablestore.model.AlwaysRetryStrategy;
import com.alicloud.openservices.tablestore.model.ListTableResponse;

public class InitClientV2 {
    public static void main(String[] args) {
        // yourInstanceName 填寫您的執行個體名稱
        final String instanceName = "yourInstanceName";
        // yourEndpoint 填寫您的執行個體訪問地址
        final String endpoint = "yourEndpoint";
        // 擷取系統變數裡的 AccessKey ID 和 AccessKey Secret
        final String accessKeyId = System.getenv("TABLESTORE_ACCESS_KEY_ID");
        final String accessKeySecret = System.getenv("TABLESTORE_ACCESS_KEY_SECRET");

        // 構造 V2 簽名
        DefaultCredentials credentials = new DefaultCredentials(accessKeyId, accessKeySecret);
        CredentialsProvider provider = new DefaultCredentialProvider(credentials);

        // 初始化 Tablestore Client
        SyncClient client = new SyncClient(endpoint, provider, instanceName, null, new ResourceManager(null, null));

        /*
        // 您可以通過指定 ClientConfiguration 修改預設配置項，以下樣本為部分自訂配置項。
        ClientConfiguration clientConfiguration = new ClientConfiguration();
        clientConfiguration.setConnectionTimeoutInMillisecond(5000); // 設定建立串連的逾時時間，單位為毫秒。
        clientConfiguration.setSocketTimeoutInMillisecond(5000); // 設定 socket 逾時時間，單位為毫秒。
        clientConfiguration.setRetryStrategy(new AlwaysRetryStrategy()); // 設定重試策略，如果不設定，則採用預設的重試策略。
        SyncClient client = new SyncClient(endpoint, provider, instanceName, clientConfiguration, new ResourceManager(null, null));
         */

        // 列出執行個體下的資料表列表並列印到控制台
        ListTableResponse listTableResponse = client.listTable();
        listTableResponse.getTableNames().forEach(System.out::println);

        // 關閉 Tablestore Client
        client.shutdown();
    }
}

時序模型

V4簽名（推薦）

以下範例程式碼使用V4簽名初始化Tablestore TimeseriesClient，擷取執行個體下的時序表列表並列印到控制台。

import com.alicloud.openservices.tablestore.ClientConfiguration;
import com.alicloud.openservices.tablestore.TimeseriesClient;
import com.alicloud.openservices.tablestore.core.ResourceManager;
import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentialProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
import com.alicloud.openservices.tablestore.core.auth.V4Credentials;
import com.alicloud.openservices.tablestore.model.AlwaysRetryStrategy;
import com.alicloud.openservices.tablestore.model.timeseries.ListTimeseriesTableResponse;

public class InitTimeseriesClientV4 {
    public static void main(String[] args) {
        // yourRegion 填寫您的執行個體所在地區，如 cn-hangzhou
        final String region = "yourRegion";
        // yourInstanceName 填寫您的執行個體名稱
        final String instanceName = "yourInstanceName";
        // yourEndpoint 填寫您的執行個體訪問地址
        final String endpoint = "yourEndpoint";
        // 擷取系統變數裡的 AccessKey ID 和 AccessKey Secret
        final String accessKeyId = System.getenv("TABLESTORE_ACCESS_KEY_ID");
        final String accessKeySecret = System.getenv("TABLESTORE_ACCESS_KEY_SECRET");

        // 構造 V4 簽名
        DefaultCredentials credentials = new DefaultCredentials(accessKeyId, accessKeySecret);
        V4Credentials credentialsV4 = V4Credentials.createByServiceCredentials(credentials, region);
        CredentialsProvider provider = new DefaultCredentialProvider(credentialsV4);

        // 初始化 Tablestore TimeSeries Client
        TimeseriesClient client = new TimeseriesClient(endpoint, provider, instanceName, null, new ResourceManager(null, null));

        /*
        // 您可以通過指定 ClientConfiguration 修改預設配置項，以下樣本為部分自訂配置項。
        ClientConfiguration clientConfiguration = new ClientConfiguration();
        clientConfiguration.setConnectionTimeoutInMillisecond(5000); // 設定建立串連的逾時時間，單位為毫秒。
        clientConfiguration.setSocketTimeoutInMillisecond(5000); // 設定 socket 逾時時間，單位為毫秒。
        clientConfiguration.setRetryStrategy(new AlwaysRetryStrategy()); // 設定重試策略，如果不設定，則採用預設的重試策略。
        TimeseriesClient client = new TimeseriesClient(endpoint, provider, instanceName, clientConfiguration, new ResourceManager(null, null));
         */

        // 列出執行個體下的時序表列表並列印到控制台
        ListTimeseriesTableResponse listTimeseriesTableResponse = client.listTimeseriesTable();
        listTimeseriesTableResponse.getTimeseriesTableNames().forEach(System.out::println);

        // 關閉 Tablestore Client
        client.shutdown();
    }
}

V2簽名

以下範例程式碼使用V2簽名初始化Tablestore TimeseriesClient，擷取執行個體下的時序表列表並列印到控制台。

import com.alicloud.openservices.tablestore.ClientConfiguration;
import com.alicloud.openservices.tablestore.TimeseriesClient;
import com.alicloud.openservices.tablestore.core.ResourceManager;
import com.alicloud.openservices.tablestore.core.auth.CredentialsProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentialProvider;
import com.alicloud.openservices.tablestore.core.auth.DefaultCredentials;
import com.alicloud.openservices.tablestore.model.AlwaysRetryStrategy;
import com.alicloud.openservices.tablestore.model.timeseries.ListTimeseriesTableResponse;

public class InitTimeseriesClientV2 {
    public static void main(String[] args) {
        // yourInstanceName 填寫您的執行個體名稱
        final String instanceName = "yourInstanceName";
        // yourEndpoint 填寫您的執行個體訪問地址
        final String endpoint = "yourEndpoint";
        // 擷取系統變數裡的 AccessKey ID 和 AccessKey Secret
        final String accessKeyId = System.getenv("TABLESTORE_ACCESS_KEY_ID");
        final String accessKeySecret = System.getenv("TABLESTORE_ACCESS_KEY_SECRET");

        // 構造 V2 簽名
        DefaultCredentials credentials = new DefaultCredentials(accessKeyId, accessKeySecret);
        CredentialsProvider provider = new DefaultCredentialProvider(credentials);

        // 初始化 Tablestore TimeSeries Client
        TimeseriesClient client = new TimeseriesClient(endpoint, provider, instanceName, null, new ResourceManager(null, null));

        /*
        // 您可以通過指定 ClientConfiguration 修改預設配置項，以下樣本為部分自訂配置項。
        ClientConfiguration clientConfiguration = new ClientConfiguration();
        clientConfiguration.setConnectionTimeoutInMillisecond(5000); // 設定建立串連的逾時時間，單位為毫秒。
        clientConfiguration.setSocketTimeoutInMillisecond(5000); // 設定 socket 逾時時間，單位為毫秒。
        clientConfiguration.setRetryStrategy(new AlwaysRetryStrategy()); // 設定重試策略，如果不設定，則採用預設的重試策略。
        TimeseriesClient client = new TimeseriesClient(endpoint, provider, instanceName, clientConfiguration, new ResourceManager(null, null));
         */

        // 列出執行個體下的時序表列表並列印到控制台
        ListTimeseriesTableResponse listTimeseriesTableResponse = client.listTimeseriesTable();
        listTimeseriesTableResponse.getTimeseriesTableNames().forEach(System.out::println);

        // 關閉 Tablestore Client
        client.shutdown();
    }
}

Tablestore：初始化Tablestore Client

準備工作

擷取執行個體資訊

安裝Tablestore SDK

配置訪問憑證

Windows

macOS/Linux/Unix

初始化Client

寬表模型

V4簽名（推薦）

V2簽名

時序模型

V4簽名（推薦）

V2簽名

常見問題

相關文檔