快速使用新版SDK初始化用戶端進行OpenAPI請求（Java SDK） - Alibaba Cloud SDK

整合阿里雲SDK主要有三步：引入阿里雲SDK、設定訪問憑據、編寫調用代碼。本文將以Java語言調用Short Message Service (SMS)的傳送簡訊介面為例，講解完整的整合步驟。

環境要求

Java版本 >= 1.8。

1. 引入SDK

登入SDK Center，選擇將要使用產品，例如您將要調用Short Message Service (SMS)的API。
在安裝頁面，所有語言選擇Java或者Java（非同步）。然後在快速入門頁簽中，您可以擷取Short Message Service (SMS)的SDK安裝方式。

2. 設定訪問憑據

調用阿里雲OpenAPI通常需要設定訪問憑據，常見憑據類型為AccessKey（簡稱：AK）和臨時安全性權杖STS Token，詳情請參見憑據。為防止憑據泄露，常用的方案是將其儲存到環境變數中，更多安全方案請參見憑據的安全使用方式情節。本文以設定環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET為例：

Linux和macOS系統配置方法

通過export命令配置環境變數

重要

使用export命令配置的臨時環境變數僅當前會話有效，當會話退出之後所設定的環境變數將會丟失。若需長期保留環境變數，可將export命令配置到對應作業系統的啟動設定檔中。

配置AccessKey ID並按斷行符號。

# 將<ACCESS_KEY_ID>替換為您自己的AccessKey ID。
export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>

配置AccessKey Secret並斷行符號。

# 將<ACCESS_KEY_SECRET>替換為您自己的AccessKey Secret。
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

驗證是否配置成功。
執行echo $ALIBABA_CLOUD_ACCESS_KEY_ID命令，如果返回正確的AccessKey ID，則說明配置成功。

Windows系統配置方法

通過圖形化使用者介面GUI

操作步驟

以下為Windows 10中通過圖形化使用者介面設定環境變數的步驟。

在案頭按右鍵此電腦，選擇屬性>進階系統設定>環境變數>系統變數/使用者變數>建立，完成以下配置：

變數	樣本值
AccessKey ID	變數名：ALIBABA_CLOUD_ACCESS_KEY_ID 變數值：LTAI4GDty8ab9W4Y1D****
AccessKey Secret	變數名：ALIBABA_CLOUD_ACCESS_KEY_SECRET 變數值：IrVTNZNy5yQelTETg0cZML3TQn****

測試設定是否成功
單擊開始（或快速鍵：Win+R）> 運行（輸入 cmd）> 確定（或按 Enter 鍵），開啟命令提示字元，執行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正確的AccessKey，則說明配置成功。

通過命令列提示符CMD

操作步驟
以管理員身份開啟命令提示字元，並使用以下命令在系統中新增環境變數。
```
setx ALIBABA_CLOUD_ACCESS_KEY_ID LTAI4GDty8ab9W4Y1D**** /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET IrVTNZNy5yQelTETg0cZML3TQn**** /M
```
其中/M表示系統級環境變數，設定使用者級環境變數時可以不攜帶該參數。
測試設定是否成功
單擊開始（或快速鍵：Win+R）> 運行（輸入 cmd）> 確定（或按 Enter 鍵），開啟命令提示字元，執行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正確的AccessKey，則說明配置成功。

通過Windows PowerShell

在PowerShell中，設定新的環境變數（對所有新會話都有效）：

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::User)

為所有使用者佈建環境變數（需要管理員權限）：

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::Machine)

設定臨時的環境變數（僅當前會話有效）：

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "LTAI4GDty8ab9W4Y1D****"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "IrVTNZNy5yQelTETg0cZML3TQn****"

在PowerShell中，執行Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID、Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正確的AccessKey，則說明配置成功。

3. 調用OpenAPI

3.1 初始化請求用戶端

初始化請求用戶端有多種方式，這裡以使用AK初始化為例，更多初始化方式，請參見管理訪問憑據。

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.dysmsapi20170525.Client;

public class Sample {
    public static void createClient() throws Exception {
        Config config = new Config()
                // 必填，您的 AccessKey ID
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，您的 AccessKey Secret
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 請參考 https://api.aliyun.com/product/Dysmsapi
        config.endpoint = "dysmsapi.aliyuncs.com";
        // 請求用戶端
        Client dysmsapiClient = new Client(config);
    }
}

3.2 建立請求對象&運行時配置

通常您需要根據業務的實際需要傳入參數，您也可自訂運行時配置。

import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.teautil.models.RuntimeOptions;

public class Sample {
    public static void createClient() throws Exception {
        // 初始化請求用戶端的代碼已在此處省略，詳情請參考上文
        // 建立請求對象並設定入參
        com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
                .setSignName("<YOUR_VALUE>")
                .setTemplateCode("<YOUR_VALUE>")
                .setPhoneNumbers("<YOUR_VALUE>");
        // 建立運行時設定物件
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
    }
}

3.3 發起請求

在V2.0 SDK中，每個產品的用戶端包含了該產品所提供的所有OpenAPI。此外，對於每一個OpenAPI，SDK提供了三種介面定義方式。這樣的設計旨在提升開發靈活性與效率，確保開發人員能夠以最符合自身專案需求的方式調用API。

說明

介面名稱為OpenAPI名稱首字母小寫。

<介面名稱>：使用預設的運行時配置發起介面調用，可以不用傳入運行參數的要求方法。

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化帳號Client</p>
     * @return Client
     *
     * @throws Exception
     */
    public static com.aliyun.dysmsapi20170525.Client createClient() throws Exception {
        // 工程代碼泄露可能會導致 AccessKey 泄露，並威脅帳號下所有資源的安全性。以下程式碼範例僅供參考。
        // 建議使用更安全的 STS 方式，更多鑒權訪問方式請參見：https://help.aliyun.com/document_detail/378657.html。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，您的 AccessKey Secret
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 請參考 https://api.aliyun.com/product/Dysmsapi
        config.endpoint = "dysmsapi.aliyuncs.com";
        return new com.aliyun.dysmsapi20170525.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dysmsapi20170525.Client client = Sample.createClient();
        //建立請求對象並設定入參
        com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
                .setSignName("<YOUR_VALUE>")
                .setTemplateCode("<YOUR_VALUE>")
                .setPhoneNumbers("<YOUR_VALUE>");
        //建立運行時設定物件
        try {
            //發起請求
            com.aliyun.dysmsapi20170525.models.SendSmsResponse resp = client.sendSms(sendSmsRequest);
            com.aliyun.teaconsole.Client.log(com.aliyun.teautil.Common.toJSONString(resp));
        } catch (TeaException error) {
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
    }
}

<介面名稱>WithOptions：可配置自訂運行時參數發起介面調用，更多運行時參數配置請參見進階配置。

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化帳號Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dysmsapi20170525.Client createClient() throws Exception {
        // 工程代碼泄露可能會導致 AccessKey 泄露，並威脅帳號下所有資源的安全性。以下程式碼範例僅供參考。
        // 建議使用更安全的 STS 方式，更多鑒權訪問方式請參見：https://help.aliyun.com/document_detail/378657.html。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，您的 AccessKey Secret
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 請參考 https://api.aliyun.com/product/Dysmsapi
        config.endpoint = "dysmsapi.aliyuncs.com";
        return new com.aliyun.dysmsapi20170525.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dysmsapi20170525.Client client = Sample.createClient();
        //建立請求對象並設定入參
        com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
                .setSignName("<YOUR_VALUE>")
                .setTemplateCode("<YOUR_VALUE>")
                .setPhoneNumbers("<YOUR_VALUE>");
        //建立運行時設定物件
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            //發起請求
            com.aliyun.dysmsapi20170525.models.SendSmsResponse resp = client.sendSmsWithOptions(sendSmsRequest, runtime);
            com.aliyun.teaconsole.Client.log(com.aliyun.teautil.Common.toJSONString(resp));
        } catch (TeaException error) {
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

<介面名稱>Advance：專門用於應對直接上傳Object 的情境，該方法預設需要傳入運行時參數。下述樣本以視覺智能開放平台人體人臉產品為例介紹SDK如何使用本地檔案上傳調用 API。

<!--    視覺智能開放平台人體人臉產品依賴-->
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>facebody20191230</artifactId>
  <version>5.1.2</version>
</dependency>

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化帳號Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.facebody20191230.Client createClient() throws Exception {
        // 工程代碼泄露可能會導致 AccessKey 泄露，並威脅帳號下所有資源的安全性。以下程式碼範例僅供參考。
        // 建議使用更安全的 STS 方式，更多鑒權訪問方式請參見：https://help.aliyun.com/document_detail/378657.html。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，您的 AccessKey Secret
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 請參考 https://api.aliyun.com/product/facebody
        config.endpoint = "facebody.cn-shanghai.aliyuncs.com";
        return new com.aliyun.facebody20191230.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.facebody20191230.Client client = Sample.createClient();
        com.aliyun.facebody20191230.models.DetectBodyCountRequest detectBodyCountRequest = new com.aliyun.facebody20191230.models.DetectBodyCountRequest()
                .setImageURL("<YOUR-FILE-PATH>");
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            com.aliyun.facebody20191230.models.DetectBodyCountResponse resp = client.detectBodyCountWithOptions(detectBodyCountRequest, runtime);
            com.aliyun.teaconsole.Client.log(com.aliyun.teautil.Common.toJSONString(resp));
        } catch (TeaException error) {
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
            // 錯誤 message
            System.out.println(error.getMessage());
            // 診斷地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}