集成SDK
集成阿里云SDK主要有三步:引入阿里云SDK、設置訪問憑據、編寫調用代碼。本文將以Java
語言調用短信服務 SMS(Short Message Service)的發送短信接口為例,講解完整的集成步驟。
環境要求
Java版本 >= 1.8。
1. 引入SDK
登錄SDK中心,選擇將要使用產品,例如您將要調用短信服務 SMS(Short Message Service)的API。
在安裝頁面,SDK 代系選擇V2.0,所有語言選擇Java或者Java(異步)。然后在快速入門頁簽中,您可以獲取短信服務 SMS(Short Message Service)的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"));
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&SK初始化賬號Client</p> * @return Client * * @throws Exception */ public static com.aliyun.dysmsapi20170525.Client createClient() throws Exception { // 工程代碼泄露可能會導致 AccessKey 泄露,并威脅賬號下所有資源的安全性。以下代碼示例僅供參考。 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")); 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&SK初始化賬號Client</p> * @return Client * * @throws Exception */ public static com.aliyun.dysmsapi20170525.Client createClient() throws Exception { // 工程代碼泄露可能會導致 AccessKey 泄露,并威脅賬號下所有資源的安全性。以下代碼示例僅供參考。 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")); 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&SK初始化賬號Client</p> * @return Client * * @throws Exception */ public static com.aliyun.facebody20191230.Client createClient() throws Exception { // 工程代碼泄露可能會導致 AccessKey 泄露,并威脅賬號下所有資源的安全性。以下代碼示例僅供參考。 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")); 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); } } }