全部產品
Search
文件中心

Alibaba Cloud SDK:整合SDK

更新時間:Jul 01, 2024

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

環境要求

重要

執行 composer 安裝 SDK 的 PHP 版本要小於或等於實際運行時的 PHP 版本。 例如,在 PHP7.2 環境下安裝 SDK 後產生 vendor 目錄,只能在 PHP7.2 以上版本使用,如果拷貝到 PHP5.6 環境下使用,會出現依賴版本不相容問題。一些使用者可能由於網路問題無法安裝,可以通過以下命令使用阿里雲 Composer 全量鏡像。

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

調用阿里雲OpenAPI通常需要設定存取金鑰(AccessKey),詳情參見憑據。為了避免憑據泄露,常見的方案是將其寫入到環境變數中,更多安全方案請參見憑據的安全使用方式情節。以設定環境變數ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET為例:

  • Linux和macOS系統配置方法

    1. 建立.bash_profile檔案

      說明

      如果是第一次設定環境變數,可以使用touch ~/.bash_profile建立一個設定檔,如果已經存在設定檔,則使用vim ~/.bash_profile命令直接編輯檔案。

      touch ~/.bash_profile
      vim ~/.bash_profile
    2. 配置.bash_profile檔案

      # 將以下命令中的<ACCESS_KEY_ID>和<ACCESS_KEY_SECRET>替換為您自己的AccessKey ID和AccessKey Secret。
      # 變數名稱可以根據實際情況進行替換,例如OSS_ACCESS_KEY_ID、OSS_ACCESS_KEY_SECRET。
      export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
      export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

      編輯完成後儲存退出。

    3. 使用.bash_profile檔案

      # 使設定檔生效
      source ~/.bash_profile
      # 顯示配置是否生效
      echo $ALIBABA_CLOUD_ACCESS_KEY_ID

      若返回正確的AccessKey ID,則說明配置成功。

  • Windows系統配置方法

    以設定環境變數ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET為例:

    通過圖形化使用者介面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_IDGet-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正確的AccessKey,則說明配置成功。

第二步:引入SDK

阿里雲SDK支援泛化調用與特化調用兩種方式調用OpenAPI,詳情參見泛化調用與特化調用,不同的調用方式需要引入的SDK也不同。

特化調用

您可以訪問OpenAPI門戶網站,搜尋您需要的產品,查看產品支援的SDK語言及安裝方法,然後在您的專案中引入SDK。本案例的SDK擷取步驟如下:

  1. 訪問簡訊服務SDK

  2. 所有語言欄目中選擇您需要的SDK語言。

  3. 選擇您需要的安裝方式,將代碼複製到您的專案中。

  4. 在您的專案中載入該依賴包。

其PHP語言安裝產品如下:

composer require alibabacloud/dysmsapi-20170525 2.0.23

泛化調用

泛化調用方式不依賴任何一個產品的SDK,只依賴如下核心包Darabonba\OpenApi。其PHP語言安裝設定檔如下,最新版本請參見alibabacloud/darabonba-openapi。:

composer require alibabacloud/darabonba-openapi

第三步:調用OpenAPI

您可以根據快速開始文檔下載範例程式碼。接下來我們以特化調用代碼為例,講解調用過程。如果您選擇泛化調用方案,請開啟Common模式產生樣本的開關,更多資訊請參見泛化調用與特化調用

初始化請求用戶端

方法一:使用AK初始化

<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

public static function createClient(){
	$config = new Config([
		// 必填,您的 AccessKey ID
		"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		// 必填,您的 AccessKey Secret
		"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
	]);
	// Endpoint 請參考 https://api.aliyun.com/product/Dysmsapi
	$config->endpoint = "dysmsapi.aliyuncs.com";
	// 特化請求用戶端
	$dysmsApiClient = new DysmsAPI($config);
}

方法二:使用STS Token初始化

<?php
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

public static function createClient(){
	$config = new Config([
		// 必填,您的 AccessKey ID
		"accessKeyId" => getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
		// 必填,您的 AccessKey Secret
		"accessKeySecret" => getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
		// 必填,您的STS Token
		"securityToken" => getenv('ALIBABA_CLOUD_SECURITY_TOKEN')
	]);
	// Endpoint 請參考 https://api.aliyun.com/product/Dysmsapi
	$config->endpoint = "dysmsapi.aliyuncs.com";
	// 特化請求用戶端
	$dysmsApiClient = new DysmsAPI($config);
}

方法三:使用Credentials工具初始化

<?php

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Credentials\Credential;
use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi as DysmsAPI;

// 使用預設憑證初始化Credentials Client。
$credential = new Credential([]);
$config = new Config([
	// 使用 credential 配置憑證
	'credential'        => $credential,
]);
// 若接入dysmsapi即簡訊服務,則初始化dysmsapi產品包的Client類
$config->endpoint = 'dysmsapi.aliyuncs.com';
// 初始化dysmsapi產品包的Client類
$dysmsApiClient = new DysmsAPI($config);

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

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

// 建立請求對象並設定入參
$sendSmsRequest = new SendSmsRequest([
"phoneNumbers" => "<YOUR_VALUE>",
"signName" => "<YOUR_VALUE>"
]);
// 建立運行時設定物件
$runtime = new RuntimeOptions([]);

發起請求

升級版 SDK 中每個產品的 Client 包含了所有的 OpenAPI,所以可以指定 OpenAPI 要求方法來請求,其方法名對應 OpenAPI 首字母小寫,一般有三個:

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

    <?php
    
    use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
    use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
    use Darabonba\OpenApi\Models\Config;
    use AlibabaCloud\Credentials\Credential;
    
    // composer 自動載入機制,require_once(vendor目錄下autoload.php檔案)
    require_once('../vendor/autoload.php');
    
    // 使用預設憑證初始化Credentials Client。
    $credentialClient = new Credential([]);
    $smsConfig = new Config([
        // 使用 credential 配置憑證
        'credential' => $credentialClient,
        // 產品服務網域名稱
        'endpoint' => 'ecs.aliyuncs.com'
    ]);
    $smsClient = new Dysmsapi($smsConfig);
    // 構造請求對象
    $sendSmsRequest = new SendSmsRequest([]);
    // 擷取響應對象
    $response = $smsClient->sendSms($sendSmsRequest);
    var_dump($response);
  • <介面名稱>WithOptions:可配置自訂運行時參數發起介面調用,更多運行時參數配置請參見進階配置

    <?php
    
    use AlibabaCloud\SDK\Dysmsapi\V20170525\Dysmsapi;
    use AlibabaCloud\SDK\Dysmsapi\V20170525\Models\SendSmsRequest;
    use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
    use Darabonba\OpenApi\Models\Config;
    use AlibabaCloud\Credentials\Credential;
    
    // composer 自動載入機制,require_once(vendor目錄下autoload.php檔案)
    require_once('../vendor/autoload.php');
    
    // 使用預設憑證初始化Credentials Client。
    $credentialClient = new Credential([]);
    $smsConfig = new Config([
        // 使用 credential 配置憑證
        'credential' => $credentialClient,
        // 產品服務網域名稱
        'endpoint' => 'ecs.aliyuncs.com'
    ]);
    $smsClient = new Dysmsapi($smsConfig);
    // 構造請求對象
    $sendSmsRequest = new SendSmsRequest([]);
    $runtime = new RuntimeOptions();
    // 是否自動重試
    $runtime->autoretry = true;
    // 連線逾時
    $runtime->connectTimeout = 10000;
    // 讀取逾時
    $runtime->readTimeout    = 10000;
    // 擷取響應對象
    $response = $smsClient->sendSmsWithOptions($sendSmsRequest,$runtime);
    var_dump($response);
  • <介面名稱>Advance:專門用於應對直接上傳Object 的情境,該方法預設需要傳入運行時參數。下述樣本以視覺智能開放平台人體人臉產品為例介紹SDK如何使用本地檔案上傳調用 API。

    <?php
    
    use Darabonba\OpenApi\Models\Config;
    use GuzzleHttp\Psr7\Stream;
    use AlibabaCloud\Credentials\Credential;
    use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
    use AlibabaCloud\Tea\Exception\TeaError;
    use AlibabaCloud\SDK\Facebody\V20191230\Facebody;
    use AlibabaCloud\SDK\Facebody\V20191230\Models\DetectBodyCountAdvanceRequest;
    
    // composer 自動載入機制,require_once(vendor目錄下autoload.php檔案)
    require_once('../vendor/autoload.php');
    
    $credentialClient = new Credential([]);
    $facebodyConfig = new Config([
        // 使用 credential 配置憑證
        'credential' => $credentialClient,
        // 產品服務網域名稱
        'endpoint' => 'facebody.cn-shanghai.aliyuncs.com'
    ]);
    
    $request = new DetectBodyCountAdvanceRequest();
    // 讀取檔案並將檔案流配置給SDK請求對象
    $request->imageURLObject = new Stream(fopen("<filepath>", "rb"));
    
    $runtime = new RuntimeOptions();
    $facebodyClient = new Facebody($facebodyConfig);
    
    try {
        // 調用本地檔案上傳方法,將檔案上傳
        $response = $facebodyClient->detectBodyCountAdvance($request, $runtime);
        var_dump($response);
    } catch (TeaError $e) {
        var_dump($e->getMessage());
        var_dump($e->getErrorInfo());
        var_dump($e->getLastException());
        var_dump($e->getLastRequest());
    }